org.apache.wsif.providers.soap.apacheaxis
Class WSIFOperation_ApacheAxis

java.lang.Object
  extended byorg.apache.wsif.base.WSIFDefaultOperation
      extended byorg.apache.wsif.providers.soap.apacheaxis.WSIFOperation_ApacheAxis
All Implemented Interfaces:
java.io.Serializable, WSIFOperation

public class WSIFOperation_ApacheAxis
extends WSIFDefaultOperation

The WSIFOperation class for invoking WSDL operations using Apache AXIS.

Author:
Mark Whitlock , Ant Elder
See Also:
Serialized Form

Constructor Summary
WSIFOperation_ApacheAxis(WSIFPort_ApacheAxis wsifPort, javax.wsdl.Operation portTypeOperation, WSIFDynamicTypeMap typeMap)
          Construct a new WSIFOperation
 
Method Summary
 WSIFOperation_ApacheAxis copy()
          Deprecated. why was this ever made public??? It should only ever be used by the WSIFPort!!!
 java.lang.String deep()
           
 void executeInputOnlyOperation(WSIFMessage inMsg)
          Execute an input-only operation.
 WSIFCorrelationId executeRequestResponseAsync(WSIFMessage inMsg)
          Performs a request response operation asynchronously.
 WSIFCorrelationId executeRequestResponseAsync(WSIFMessage inMsg, WSIFResponseHandler handler)
          Performs a request response operation asynchronously.
 boolean executeRequestResponseOperation(WSIFMessage inMsg, WSIFMessage outMsg, WSIFMessage faultMsg)
          Execute a request-response operation.
 void fireAsyncResponse(java.lang.Object response)
          fireAsyncResponse is called by an AsyncListener when a response has been received for a previous executeRequestResponseAsync call.
 WSIFCorrelationId getAsyncRequestID()
           
 javax.wsdl.Definition getDefinition()
          Returns the Definition object for the WSDL file
 WSIFPort_ApacheAxis getDynamicWSIFPort()
          Deprecated. use getWSIFPort
 java.lang.String getInputEncodingStyle()
           
 java.lang.String getInputNamespace()
           
 java.lang.String getInputUse()
          Returns the inputUse.
 java.lang.String getName()
          Gets the name of the portType wsdl:operation element being used by this WSIFOperation
 javax.wsdl.Operation getOperation()
          Deprecated. use getPortTypeOperation
 java.lang.String getOperationStyle()
          Returns the operation style.
 java.lang.String getOutputEncodingStyle()
           
 javax.wsdl.Operation getPortTypeOperation()
          Gets the portType wsdl:operation element used by this WSIFOperation
 java.lang.String getSoapActionURI()
           
 java.lang.String getStyle()
          Deprecated. use getOperationStyle
 java.lang.String getTargetNamespaceURI()
          Gets the target namespace URI of this WSIFOperation
 org.apache.axis.client.Transport getTransport()
           
 WSIFPort getWSIFPort()
           
 boolean isAsyncOperation()
          Tests if the currently executing request is an asynchronous request.
 boolean processAsyncResponse(java.lang.Object response, WSIFMessage output, WSIFMessage fault)
          Processes the response to an asynchronous request.
 void setDefinition(javax.wsdl.Definition definition1)
          Deprecated. should anyone be calling this?
 void setDynamicWSIFPort(WSIFPort_ApacheAxis wsifport_apacheaxis)
           
 void setInputEncodingStyle(java.lang.String s)
           
 void setInputNamespace(java.lang.String s)
           
 void setOperation(javax.wsdl.Operation operation1)
           
 void setOperationStyle(java.lang.String style)
          Deprecated. should anyone be doing this?
 void setOutputEncodingStyle(java.lang.String s)
           
 void setSoapActionURI(java.lang.String s)
           
 void setStyle(java.lang.String style)
          Deprecated. use setOperationStyle
 
Methods inherited from class org.apache.wsif.base.WSIFDefaultOperation
addInputJmsPropertyValues, createFaultMessage, createFaultMessage, createInputMessage, createInputMessage, createOutputMessage, createOutputMessage, getContext, getInputJmsProperties, getInputJmsPropertyValues, getOutputJmsProperties, setContext, setInputJmsProperties, setInputJmsProperties, setInputJmsPropertyValues, setOutputJmsProperties, setOutputJmsProperties
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSIFOperation_ApacheAxis

public WSIFOperation_ApacheAxis(WSIFPort_ApacheAxis wsifPort,
                                javax.wsdl.Operation portTypeOperation,
                                WSIFDynamicTypeMap typeMap)
                         throws WSIFException
Construct a new WSIFOperation

Method Detail

copy

public WSIFOperation_ApacheAxis copy()
                              throws WSIFException
Deprecated. why was this ever made public??? It should only ever be used by the WSIFPort!!!

Create a new copy of this object. This is not a clone, since it does not copy the referenced objects as well. The intention here is to copy anything that the prepare method has done so that WSIFOperation instances can be cached by the WSIFPort and safely reused with minimum overhead.

Throws:
WSIFException

getDefinition

public javax.wsdl.Definition getDefinition()
Returns the Definition object for the WSDL file

Returns:
Definition the WSDL4J Definition object

getDynamicWSIFPort

public WSIFPort_ApacheAxis getDynamicWSIFPort()
Deprecated. use getWSIFPort


getInputEncodingStyle

public java.lang.String getInputEncodingStyle()

getInputNamespace

public java.lang.String getInputNamespace()

getInputUse

public java.lang.String getInputUse()
Returns the inputUse.

Returns:
String

getName

public java.lang.String getName()
Gets the name of the portType wsdl:operation element being used by this WSIFOperation

Returns:
String the operation name

getOperation

public javax.wsdl.Operation getOperation()
Deprecated. use getPortTypeOperation


getPortTypeOperation

public javax.wsdl.Operation getPortTypeOperation()
Gets the portType wsdl:operation element used by this WSIFOperation

Returns:
Operation the WSDL4J portType Operation object

getOutputEncodingStyle

public java.lang.String getOutputEncodingStyle()

getSoapActionURI

public java.lang.String getSoapActionURI()

getTransport

public org.apache.axis.client.Transport getTransport()
                                              throws WSIFException
Throws:
WSIFException

getAsyncRequestID

public WSIFCorrelationId getAsyncRequestID()

getWSIFPort

public WSIFPort getWSIFPort()
Specified by:
getWSIFPort in class WSIFDefaultOperation

isAsyncOperation

public boolean isAsyncOperation()
Tests if the currently executing request is an asynchronous request.

Returns:
true if the current request is a asynchronous request, otherwise false

executeInputOnlyOperation

public void executeInputOnlyOperation(WSIFMessage inMsg)
                               throws WSIFException
Description copied from interface: WSIFOperation
Execute an input-only operation.

Specified by:
executeInputOnlyOperation in interface WSIFOperation
Specified by:
executeInputOnlyOperation in class WSIFDefaultOperation
Throws:
WSIFException
See Also:
WSIFOperation.executeInputOnlyOperation(WSIFMessage)

executeRequestResponseOperation

public boolean executeRequestResponseOperation(WSIFMessage inMsg,
                                               WSIFMessage outMsg,
                                               WSIFMessage faultMsg)
                                        throws WSIFException
Description copied from interface: WSIFOperation
Execute a request-response operation. The signature allows for input, output and fault messages. WSDL in fact allows one to describe the set of possible faults an operation may result in, however, only one fault can occur at any one time.

Specified by:
executeRequestResponseOperation in interface WSIFOperation
Specified by:
executeRequestResponseOperation in class WSIFDefaultOperation
Throws:
WSIFException
See Also:
WSIFOperation.executeRequestResponseOperation(WSIFMessage, WSIFMessage, WSIFMessage)

executeRequestResponseAsync

public WSIFCorrelationId executeRequestResponseAsync(WSIFMessage inMsg)
                                              throws WSIFException
Performs a request response operation asynchronously.

Specified by:
executeRequestResponseAsync in interface WSIFOperation
Overrides:
executeRequestResponseAsync in class WSIFDefaultOperation
Returns:
the correlation ID or the request. The correlation ID is used to associate the request with the WSIFOperation.
Throws:
WSIFException - if something goes wrong.
See Also:
WSIFOperation#executeRequestResponseAsync(WSIFMessage)

executeRequestResponseAsync

public WSIFCorrelationId executeRequestResponseAsync(WSIFMessage inMsg,
                                                     WSIFResponseHandler handler)
                                              throws WSIFException
Performs a request response operation asynchronously.

Specified by:
executeRequestResponseAsync in interface WSIFOperation
Overrides:
executeRequestResponseAsync in class WSIFDefaultOperation
Parameters:
handler - the response handler that will be notified when the asynchronous response becomes available.
Returns:
the correlation ID or the request. The correlation ID is used to associate the request with the WSIFOperation.
Throws:
WSIFException - if something goes wrong.
See Also:
WSIFOperation#executeRequestResponseAsync(WSIFMessage,WSIFResponseHandler)

fireAsyncResponse

public void fireAsyncResponse(java.lang.Object response)
                       throws WSIFException
fireAsyncResponse is called by an AsyncListener when a response has been received for a previous executeRequestResponseAsync call. It passes the response to the executeAsyncResponse method of the associated WSIFResponseHandler.

Specified by:
fireAsyncResponse in interface WSIFOperation
Overrides:
fireAsyncResponse in class WSIFDefaultOperation
Parameters:
response - an Object representing the response. The response should be a JMS TextMessage containging the XML response.
Throws:
WSIFException
See Also:
WSIFOperation#fireAsyncResponse(Object)

processAsyncResponse

public boolean processAsyncResponse(java.lang.Object response,
                                    WSIFMessage output,
                                    WSIFMessage fault)
                             throws WSIFException
Processes the response to an asynchronous request. This is called for when the asynchronous operation was initiated without a WSIFResponseHandler, that is, by calling the executeRequestResponseAsync(WSIFMessage input) method.

Specified by:
processAsyncResponse in interface WSIFOperation
Overrides:
processAsyncResponse in class WSIFDefaultOperation
Parameters:
response - an Object representing the response.
output - 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.)
fault - 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.)
Returns:
true or false indicating whether a fault message was generated or not. The truth value indicates whether the output or fault message has useful information.
Throws:
WSIFException
See Also:
WSIFOperation.processAsyncResponse(Object,WSIFMessage,WSIFMessage)

setDefinition

public void setDefinition(javax.wsdl.Definition definition1)
Deprecated. should anyone be calling this?


setDynamicWSIFPort

public void setDynamicWSIFPort(WSIFPort_ApacheAxis wsifport_apacheaxis)

setInputEncodingStyle

public void setInputEncodingStyle(java.lang.String s)

setInputNamespace

public void setInputNamespace(java.lang.String s)

setOperation

public void setOperation(javax.wsdl.Operation operation1)

setOutputEncodingStyle

public void setOutputEncodingStyle(java.lang.String s)

setSoapActionURI

public void setSoapActionURI(java.lang.String s)

getTargetNamespaceURI

public java.lang.String getTargetNamespaceURI()
Gets the target namespace URI of this WSIFOperation

Returns:
the target namespace URI

getStyle

public java.lang.String getStyle()
Deprecated. use getOperationStyle


getOperationStyle

public java.lang.String getOperationStyle()
Returns the operation style.

Returns:
String

setStyle

public void setStyle(java.lang.String style)
Deprecated. use setOperationStyle


setOperationStyle

public void setOperationStyle(java.lang.String style)
Deprecated. should anyone be doing this?


deep

public java.lang.String deep()


Copyright ? 2002, 2006 Apache XML Project. All Rights Reserved.