|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An operation client is the way an advanced user interacts with Axis2. Actual operation clients understand a specific MEP and hence their behavior is defined by their MEP. To interact with an operation client, you first get one from a specific AxisOperation. Then you set the messages into it one by one (whatever is available). Then, when you call execute() the client will execute what it can at that point. If executing the operation client results in a new message being created, then if a message receiver is registered with the client then the message will be delivered to that client.
Method Summary | |
void |
addMessageContext(MessageContext mc)
Add a message context to the client for processing. |
void |
complete(MessageContext msgCtxt)
To close the tranport if necessary , can call this method. |
void |
execute(boolean block)
Execute the MEP. |
MessageContext |
getMessageContext(String messageLabel)
Return a message from the client - will return null if the requested message is not available. |
Options |
getOptions()
Return the options used by this client. |
void |
reset()
Reset the operation client to a clean status after the MEP has completed. |
void |
setCallback(Callback callback)
Set the callback to be executed when a message comes into the MEP and the operation client is executed. |
void |
setOptions(Options options)
Sets the options that should be used for this particular client. |
Method Detail |
public void setOptions(Options options)
options
- the optionspublic Options getOptions()
public void addMessageContext(MessageContext mc) throws AxisFault
mc
- the message context
AxisFault
- if this is called inappropriately.public MessageContext getMessageContext(String messageLabel) throws AxisFault
messageLabel
- the message label of the desired message context
AxisFault
- if the message label is invalidpublic void setCallback(Callback callback)
callback
- the callback to be used when the client decides its time to
use itpublic void execute(boolean block) throws AxisFault
block
- Indicates whether execution should block or return ASAP. What
block means is of course a function of the specific operation
client.
AxisFault
- if something goes wrong during the execution of the operation
client.public void reset() throws AxisFault
AxisFault
- if reset is called before the MEP client has completed an
interaction.public void complete(MessageContext msgCtxt) throws AxisFault
msgCtxt
- : MessageContext# which have all the trnport information
AxisFault
- : throws AxisFault if something goes worng
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |