|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WSIFMessage
A WSIFMessage is a an interface representing a WSDL Message.
In WSDL, a Message describes the abstract type of the input or output to an operation. This is the corresponding WSIF class which represents in memory the actual input or output of an operation.
A WSIFMessage is a container for a set of named parts. The WSIFMessage interface separates the actual representation of the data from the abstract type defined by WSDL.
WSIFMessage implementations are free to represent the actual part data in any way that is convenient to them. This could be a simple HashMap as in the WSIFDefaultMessage implementation, or it could be something more complex, such as a stream or tree representation.
In addition to the containing parts, a WSIFMessage also has a message name. This can be used to distinguish between messages.
WSIFMessages are cloneable and serializable. If the parts set are not cloneable, the implementation should try to clone them using serialization. If the parts are not serializable either, then a CloneNotSupportedException will be thrown if cloning is attempted.
A WSIFMessage should be not created by directly instantiating
a WSIFMessage, but should be created by calling one of the
WSIFOperation.createInputMessage()
, WSIFOperation.createOutputMessage()
,
or WSIFOperation.createFaultMessage()
methods.
An instance of a WSIFMessage should only be used for the purpose
it was created for, for example, a WSIFMessage created by the
WSIFOperation.createInputMessage(String)
should not be used as an
output message. A WSIFMessage should only be used once, it should
not be reused in any subsequent WSIFOperation requests.
Method Summary | |
---|---|
java.lang.Object |
clone()
|
boolean |
getBooleanPart(java.lang.String name)
|
byte |
getBytePart(java.lang.String name)
|
char |
getCharPart(java.lang.String name)
|
double |
getDoublePart(java.lang.String name)
|
float |
getFloatPart(java.lang.String name)
|
int |
getIntPart(java.lang.String name)
|
long |
getLongPart(java.lang.String name)
|
javax.wsdl.Message |
getMessageDefinition()
Get the underlying WSDL model for this message. |
java.lang.String |
getName()
Get the name of this message. |
java.lang.Object |
getObjectPart(java.lang.String name)
|
java.lang.Object |
getObjectPart(java.lang.String name,
java.lang.Class sourceClass)
|
java.util.Iterator |
getPartNames()
Return list of part names. |
java.util.Iterator |
getParts()
Create an iterator of the parts in this message. |
java.lang.String |
getRepresentationStyle()
|
short |
getShortPart(java.lang.String name)
|
void |
setBooleanPart(java.lang.String name,
boolean booleanPart)
|
void |
setBytePart(java.lang.String name,
byte bytePart)
|
void |
setCharPart(java.lang.String name,
char charPart)
|
void |
setDoublePart(java.lang.String name,
double doublePart)
|
void |
setFloatPart(java.lang.String name,
float floatPart)
|
void |
setIntPart(java.lang.String name,
int intPart)
|
void |
setLongPart(java.lang.String name,
long longPart)
|
void |
setMessageDefinition(javax.wsdl.Message msgDef)
Set the underlying WSDL model for this message. |
void |
setName(java.lang.String name)
Set the name of this message. |
void |
setObjectPart(java.lang.String name,
java.lang.Object part)
|
void |
setParts(java.util.Map sourceParts)
This message parts will be replaced by sourceParts. |
void |
setRepresentationStyle(java.lang.String rStyle)
|
void |
setShortPart(java.lang.String name,
short shortPart)
|
Method Detail |
---|
java.lang.String getName()
void setName(java.lang.String name)
java.util.Iterator getPartNames()
NOTE: part names are unordered.
java.util.Iterator getParts()
void setParts(java.util.Map sourceParts)
javax.wsdl.Message getMessageDefinition()
void setMessageDefinition(javax.wsdl.Message msgDef)
msgDefinition
- java.lang.String getRepresentationStyle()
void setRepresentationStyle(java.lang.String rStyle)
java.lang.Object getObjectPart(java.lang.String name) throws WSIFException
WSIFException
java.lang.Object getObjectPart(java.lang.String name, java.lang.Class sourceClass) throws WSIFException
WSIFException
void setObjectPart(java.lang.String name, java.lang.Object part) throws WSIFException
WSIFException
char getCharPart(java.lang.String name) throws WSIFException
WSIFException
byte getBytePart(java.lang.String name) throws WSIFException
WSIFException
short getShortPart(java.lang.String name) throws WSIFException
WSIFException
int getIntPart(java.lang.String name) throws WSIFException
WSIFException
long getLongPart(java.lang.String name) throws WSIFException
WSIFException
float getFloatPart(java.lang.String name) throws WSIFException
WSIFException
double getDoublePart(java.lang.String name) throws WSIFException
WSIFException
boolean getBooleanPart(java.lang.String name) throws WSIFException
WSIFException
void setCharPart(java.lang.String name, char charPart)
void setBytePart(java.lang.String name, byte bytePart)
void setShortPart(java.lang.String name, short shortPart)
void setIntPart(java.lang.String name, int intPart)
void setLongPart(java.lang.String name, long longPart)
void setFloatPart(java.lang.String name, float floatPart)
void setDoublePart(java.lang.String name, double doublePart)
void setBooleanPart(java.lang.String name, boolean booleanPart)
java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |