com.ibm.wsspi.webservices.rpc.handler
Interface RPCContext
public interface RPCContext
Context information about the remote
procedure call described by the current message.
Method Summary |
java.lang.String |
getFaultWSAAction()
The wsdl:operation's fault element may have a wsa:Action
attribute. |
java.lang.String |
getInputWSAAction()
The wsdl:operation's input element may have a wsa:Action
attribute. |
java.lang.String |
getOutputWSAAction()
The wsdl:operation's output element may have a wsa:Action
attribute. |
java.lang.String |
getPortPath()
Only valid on service. |
java.lang.String |
getServiceRefName()
Only valid on client. |
java.lang.String |
getSOAPActionURI()
Valid on both client and server. |
java.lang.String |
getTargetEndpointAddress()
Only valid on client. |
java.lang.String |
getTransportName()
Get the transport name. |
java.lang.String |
getWSDLFaultName()
A wsdl:operation contains an fault element that has a name attribute. |
javax.xml.namespace.QName |
getWSDLInputMessageName()
A wsdl:operation contains an input element that has a message attribute. |
java.lang.String |
getWSDLInputName()
A wsdl:operation contains an input element that has a name attribute. |
java.lang.String |
getWSDLLocation()
Only valid on server. |
java.lang.String |
getWSDLOperation()
A wsdl:operation defines this message. |
javax.xml.namespace.QName |
getWSDLOutputMessageName()
A wsdl:operation contains an output element that has a message attribute. |
java.lang.String |
getWSDLOutputName()
A wsdl:operation contains an output element that has a name attribute. |
javax.xml.namespace.QName[] |
getWSDLParameters()
Get the wsdl parameter qnames |
javax.xml.namespace.QName |
getWSDLPort()
A wsdl:port defines this message. |
javax.xml.namespace.QName |
getWSDLPortType()
The wsdl:operation for this message is defined within a wsdl:portType. |
javax.xml.namespace.QName |
getWSDLService()
A wsdl:service defines this message. |
java.lang.String |
getWSDLTargetNamespace()
The wsdl:defintion has a targetNamespace attribute which defines the target namespace. |
java.lang.Boolean |
getWSDLUnavailable()
Retrieve the WSDLUnavailable marker if present,
and return Boolean to indicate whether or not the other values available from RPCContext
were retreived directly from the WSDL or via other means. |
java.lang.Boolean |
usingAddressing()
Retrieve the UsingAddressing ExtensibilityElement if one exists,
and return Boolean of wsdl:required attribute. |
getTransportName
java.lang.String getTransportName()
- Get the transport name.
- Returns:
- transport name.
getWSDLParameters
javax.xml.namespace.QName[] getWSDLParameters()
- Get the wsdl parameter qnames
- Returns:
- wsdl parameter qnames or null if the message does not match an wsdl operation
getWSDLPort
javax.xml.namespace.QName getWSDLPort()
- A wsdl:port defines this message.
This method returns the port qname define by the wsdl.
Valid on both client and server.
- Returns:
- port qname
getWSDLService
javax.xml.namespace.QName getWSDLService()
- A wsdl:service defines this message.
This method returns the service qname define by the wsdl.
Valid on both client and server.
- Returns:
- service qname
getWSDLOperation
java.lang.String getWSDLOperation()
- A wsdl:operation defines this message.
This method returns the operation name define by the wsdl.
Valid on both client and server.
- Returns:
- operation name or null if the message does not match an wsdl operation
getWSDLPortType
javax.xml.namespace.QName getWSDLPortType()
- The wsdl:operation for this message is defined within a wsdl:portType.
This method returns the portType's qname.
Valid on both client and server.
- Returns:
- portType qname or null if the message does not match an wsdl operation
getWSDLTargetNamespace
java.lang.String getWSDLTargetNamespace()
- The wsdl:defintion has a targetNamespace attribute which defines the target namespace.
This method returns the targetNamespace.
Valid on both client and server.
- Returns:
- targetNamespace or null if the message does not match an wsdl operation
getWSDLInputName
java.lang.String getWSDLInputName()
- A wsdl:operation contains an input element that has a name attribute.
This method returns this input name.
Valid on both client and server
- Returns:
- input name String or null if the message does not match an wsdl operation
getWSDLOutputName
java.lang.String getWSDLOutputName()
- A wsdl:operation contains an output element that has a name attribute.
This method returns this output name.
Valid on both client and server
- Returns:
- output name String or null if the message does not match an wsdl operation
getWSDLFaultName
java.lang.String getWSDLFaultName()
- A wsdl:operation contains an fault element that has a name attribute.
This method returns this fault name. This method is only valid on the fault path and only
for faults defined in the WSDL.
Valid on both client and server
- Returns:
- fault name String or null if the message does not match an wsdl operation
getWSDLInputMessageName
javax.xml.namespace.QName getWSDLInputMessageName()
- A wsdl:operation contains an input element that has a message attribute.
The message attribute locates the wsdl:message that defines the input.
This method returns the qname of the wsd:message as defined by the wsdl.
Valid on both client and server
- Returns:
- input message qname or null if the message does not match an wsdl operation
getWSDLOutputMessageName
javax.xml.namespace.QName getWSDLOutputMessageName()
- A wsdl:operation contains an output element that has a message attribute.
The message attribute locates the wsdl:message that defines the output.
This method returns the qname of the wsd:message as defined by the wsdl.
Valid on both client and server
- Returns:
- output message qname or null if the message does not match an wsdl operation
getWSDLLocation
java.lang.String getWSDLLocation()
- Only valid on server.
- Returns:
- the WSDL location
getSOAPActionURI
java.lang.String getSOAPActionURI()
- Valid on both client and server.
- Returns:
- the SOAPAction specified in the wsdl
getPortPath
java.lang.String getPortPath()
- Only valid on service.
The port path uniquely identifies a port within a deployed application.
It maybe that multiple services within a single Web Services
application expose the same WSDL port. In such a case, the
port name is not sufficient to uniquely determine the port.
THE APPARENT SOURCE OF THIS VALUE AND/OR FORM OF THE
INFORMATION RETURNED MAY CHANGE AT ANY TIME.
DO NOT INTRODUCE DEPENDENCIES ON VALUE OR FORMAT.
THE ONLY REQUIREMENT THAT WILL BE SUPPORTED REGARDING THE VALUE
RETURNED BY THIS METHOD WILL BE THAT IT WILL UNIQUELY IDENTIFY
THE CURRENT PORT WITHIN THE CONTEXT OF THE DEPLOYED APPLICATION.
For Your Reference/Information, the current values returned are:
HTTP: the ServletPath [ + PathInfo ]. PathInfo will be appended if it is non-null.
JMS: the "targetService" property from the JMS Message
Again, please note that the values are dependent on current implementation,
and may change in the future.
- Returns:
- unique identifier for the current port
getTargetEndpointAddress
java.lang.String getTargetEndpointAddress()
- Only valid on client.
- Returns:
- target endpoint address
getServiceRefName
java.lang.String getServiceRefName()
- Only valid on client.
- Returns:
- the service ref name
getInputWSAAction
java.lang.String getInputWSAAction()
- The wsdl:operation's input element may have a wsa:Action
attribute.
- Returns:
- the wsa:Action attribute value defined by the wsdl or null if not specified
or null if the message does not match an wsdl operation.
getOutputWSAAction
java.lang.String getOutputWSAAction()
- The wsdl:operation's output element may have a wsa:Action
attribute.
- Returns:
- the wsa:Action attribute value defined by the wsdl or null if not specified
or null if the message does not match an wsdl operation.
getFaultWSAAction
java.lang.String getFaultWSAAction()
- The wsdl:operation's fault element may have a wsa:Action
attribute. This method is only valid on the fault path and only for faults defined in the WSDL.
- Returns:
- the wsa:Action attribute value defined by the wsdl or null if not specified
or null if the message does not match an wsdl operation.
usingAddressing
java.lang.Boolean usingAddressing()
- Retrieve the UsingAddressing ExtensibilityElement if one exists,
and return Boolean of wsdl:required attribute.
- Returns:
- Boolean or null if not present.
getWSDLUnavailable
java.lang.Boolean getWSDLUnavailable()
- Retrieve the WSDLUnavailable marker if present,
and return Boolean to indicate whether or not the other values available from RPCContext
were retreived directly from the WSDL or via other means.
- Returns:
- Boolean set to true if WSDL was not available to obtain the values available from
RPCContext; false otherwise.