|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.wsif.providers.ModelWSIFOperation
ModelWSIFOperation Models are provided for all the classes required to be implemented when writing a WSIF provider: WSIFProvider, WSIFPort, and WSIFOperation. The models are intended to simplify the work in the implementing subclasses, and insure that all providers work in standard way. Things like hunting around in the WSDL for ExtensabilityElements and verifying the types of request and response objects against the WSDL should be done in the model code. Subclasses should only need to provide code directly related to accessing the particular service type they implement. For a subclass to use ModelWSIFOperation, as a minimum it would implement the doInvokeRequestResponse method. If special processing is required for input only operations then subclasses would also implement doInvokeInputOnly. If the binding being implemented uses a binding operation extensibility element then subclasses should override the getOperationExtensibilityClass, and validateOperationExtensibilityElement methods. Other methods may be overriden to customise the behaviour, see the method javadoc for details.
Constructor Summary | |
ModelWSIFOperation(ModelWSIFPort wsifPort,
javax.wsdl.BindingOperation bindingOperation)
Construct a ModelWSIFOperation |
Method Summary | |
WSIFMessage |
createFaultMessage()
Create a fault message that may be received into via this port. |
WSIFMessage |
createFaultMessage(java.lang.String name)
Create a fault message that may be received into via this port. |
WSIFMessage |
createInputMessage()
Create an input message that will be sent via this port. |
WSIFMessage |
createInputMessage(java.lang.String name)
Create an input message that will be sent via this port. |
WSIFMessage |
createOutputMessage()
Create an output message that will be received into via this port. |
WSIFMessage |
createOutputMessage(java.lang.String name)
Create an output message that will be received into via this port. |
java.lang.String |
deep()
String representation of this WSIFOperation for WSIF Trc. |
void |
executeInputOnlyOperation(WSIFMessage inMsg)
Execute an input-only operation. |
WSIFCorrelationId |
executeRequestResponseAsync(WSIFMessage inMsg)
Execute an asynchronous request |
WSIFCorrelationId |
executeRequestResponseAsync(WSIFMessage inMsg,
WSIFResponseHandler handler)
Execute an asynchronous request |
boolean |
executeRequestResponseOperation(WSIFMessage inMsg,
WSIFMessage outMsg,
WSIFMessage faultMsg)
Execute a request-response operation. |
void |
fireAsyncResponse(java.lang.Object response)
fireAsyncResponse is called when a response has been received for a previous executeRequestResponseAsync call. |
WSIFMessage |
getContext()
Gets the context information for this binding. |
javax.wsdl.Operation |
getPortTypeOperation()
Get the WSDL portType operation this WSIFOperation implements. |
boolean |
processAsyncResponse(java.lang.Object response,
WSIFMessage outMsg,
WSIFMessage faultMsg)
Processes the response to an asynchronous request. |
void |
setContext(WSIFMessage context)
Allows the application programmer or stub to pass context information to the binding. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ModelWSIFOperation(ModelWSIFPort wsifPort, javax.wsdl.BindingOperation bindingOperation) throws WSIFException
Method Detail |
public void executeInputOnlyOperation(WSIFMessage inMsg) throws WSIFException
WSIFOperation
executeInputOnlyOperation
in interface WSIFOperation
inMsg
- input message to send to the operation
WSIFException
- if something goes wrong.WSIFOperation.executeInputOnlyOperation(WSIFMessage)
public boolean executeRequestResponseOperation(WSIFMessage inMsg, WSIFMessage outMsg, WSIFMessage faultMsg) throws WSIFException
WSIFOperation
executeRequestResponseOperation
in interface WSIFOperation
inMsg
- input message to send to the operationoutMsg
- an empty message which will be filled in if
the operation invocation succeeds. If it does not
succeed, the contents of this message are undefined.
(This is a return value of this method.)faultMsg
- an empty message which will be filled in if
the operation invocation fails. If it succeeds, the
contents of this message are undefined. (This is a
return value of this method.)
WSIFException
- if something goes wrong.WSIFOperation#executeInputOnlyOperation(WSIFMessage,WSIFMessage,WSIFMessage)
public WSIFCorrelationId executeRequestResponseAsync(WSIFMessage inMsg) throws WSIFException
WSIFOperation
executeRequestResponseAsync
in interface WSIFOperation
inMsg
- input message to send to the operation
WSIFException
- if something goes wrong.WSIFOperation.executeRequestResponseAsync(WSIFMessage)
public WSIFCorrelationId executeRequestResponseAsync(WSIFMessage inMsg, WSIFResponseHandler handler) throws WSIFException
WSIFOperation
executeRequestResponseAsync
in interface WSIFOperation
inMsg
- input message to send to the operationhandler
- the response handler that will be notified
when the asynchronous response becomes available.
WSIFException
- if something goes wrong.WSIFOperation.executeRequestResponseAsync(WSIFMessage, WSIFResponseHandler)
public void fireAsyncResponse(java.lang.Object response) throws WSIFException
WSIFOperation
fireAsyncResponse
in interface WSIFOperation
response
- an Object representing the response
WSIFException
- if something goes wrongWSIFOperation.fireAsyncResponse(Object)
public boolean processAsyncResponse(java.lang.Object response, WSIFMessage outMsg, WSIFMessage faultMsg) throws WSIFException
WSIFOperation
processAsyncResponse
in interface WSIFOperation
response
- an Object representing the response.outMsg
- an empty message which will be filled in if
the operation invocation succeeds. If it does not
succeed, the contents of this message are undefined.
(This is a return value of this method.)faultMsg
- an empty message which will be filled in if
the operation invocation fails. If it succeeds, the
contents of this message are undefined. (This is a
return value of this method.)
WSIFException
- if something goes wrongWSIFOperation.processAsyncResponse(Object,WSIFMessage,WSIFMessage)
public javax.wsdl.Operation getPortTypeOperation()
WSIFDefaultOperation#getOperation()
public WSIFMessage createInputMessage()
WSIFOperation
createInputMessage
in interface WSIFOperation
WSIFOperation.createInputMessage()
public WSIFMessage createInputMessage(java.lang.String name)
WSIFOperation
createInputMessage
in interface WSIFOperation
name
- for the new message
WSIFOperation.createInputMessage(String)
public WSIFMessage createOutputMessage()
WSIFOperation
createOutputMessage
in interface WSIFOperation
WSIFOperation.createOutputMessage()
public WSIFMessage createOutputMessage(java.lang.String name)
WSIFOperation
createOutputMessage
in interface WSIFOperation
name
- for the new message
WSIFOperation.createOutputMessage(String)
public WSIFMessage createFaultMessage()
WSIFOperation
createFaultMessage
in interface WSIFOperation
WSIFOperation.createFaultMessage()
public WSIFMessage createFaultMessage(java.lang.String name)
WSIFOperation
createFaultMessage
in interface WSIFOperation
name
- for the new message
WSIFOperation.createFaultMessage(String)
public WSIFMessage getContext() throws WSIFException
getContext
in interface WSIFOperation
WSIFException
public void setContext(WSIFMessage context)
setContext
in interface WSIFOperation
context
- context informationpublic java.lang.String deep()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |