public interface Call
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ENCODINGSTYLE_URI_PROPERTY
Standard property for encoding Style: Encoding style specified as a namespace URI.
|
static java.lang.String |
OPERATION_STYLE_PROPERTY
Standard property for operation style.
|
static java.lang.String |
PASSWORD_PROPERTY
Standard property: Password for authentication Type: java.lang.String
|
static java.lang.String |
SESSION_MAINTAIN_PROPERTY
Standard property: This boolean property is used by a service client to indicate whether or not it wants to participate in a session with a service endpoint.
|
static java.lang.String |
SOAPACTION_URI_PROPERTY
Standard property for SOAPAction.
|
static java.lang.String |
SOAPACTION_USE_PROPERTY
Standard property for SOAPAction.
|
static java.lang.String |
USERNAME_PROPERTY
Standard property: User name for authentication Type: java.lang.String
|
Modifier and Type | Method and Description |
---|---|
void |
addParameter(java.lang.String paramName,
javax.xml.namespace.QName xmlType,
java.lang.Class javaType,
ParameterMode parameterMode)
Adds a parameter type and mode for a specific operation.
|
void |
addParameter(java.lang.String paramName,
javax.xml.namespace.QName xmlType,
ParameterMode parameterMode)
Adds a parameter type and mode for a specific operation.
|
javax.xml.namespace.QName |
getOperationName()
Gets the name of the operation to be invoked using this Call instance.
|
java.util.Map |
getOutputParams()
Returns a Map of {name, value} for the output parameters of the last invoked operation.
|
java.util.List |
getOutputValues()
Returns a List values for the output parameters of the last invoked operation.
|
javax.xml.namespace.QName |
getParameterTypeByName(java.lang.String paramName)
Gets the XML type of a parameter by name.
|
javax.xml.namespace.QName |
getPortTypeName()
Gets the qualified name of the port type.
|
java.lang.Object |
getProperty(java.lang.String name)
Gets the value of a named property.
|
java.util.Iterator |
getPropertyNames()
Gets the names of configurable properties supported by this Call object.
|
javax.xml.namespace.QName |
getReturnType()
Gets the return type for a specific operation
|
java.lang.String |
getTargetEndpointAddress()
Gets the address of a target service endpoint.
|
java.lang.Object |
invoke(java.lang.Object[] inputParams)
Invokes a specific operation using a synchronous request-response interaction mode.
|
java.lang.Object |
invoke(javax.xml.namespace.QName operationName,
java.lang.Object[] inputParams)
Invokes a specific operation using a synchronous request-response interaction mode.
|
void |
invokeOneWay(java.lang.Object[] inputParams)
Invokes a remote method using the one-way interaction mode.
|
boolean |
isParameterAndReturnSpecRequired(javax.xml.namespace.QName operationName)
Indicates whether addParameter and setReturnType methods are to be invoked to specify the parameter and return
type specification for a specific operation.
|
void |
removeAllParameters()
Removes all specified parameters from this Call instance.
|
void |
removeProperty(java.lang.String name)
Removes a named property.
|
void |
setOperationName(javax.xml.namespace.QName operationName)
Sets the name of the operation to be invoked using this Call instance.
|
void |
setPortTypeName(javax.xml.namespace.QName portType)
Sets the qualified name of the port type.
|
void |
setProperty(java.lang.String name,
java.lang.Object value)
Sets the value for a named property.
|
void |
setReturnType(javax.xml.namespace.QName xmlType)
Sets the return type for a specific operation.
|
void |
setReturnType(javax.xml.namespace.QName xmlType,
java.lang.Class javaType)
Sets the return type for a specific operation.
|
void |
setTargetEndpointAddress(java.lang.String address)
Sets the address of the target service endpoint.
|
static final java.lang.String USERNAME_PROPERTY
static final java.lang.String PASSWORD_PROPERTY
static final java.lang.String OPERATION_STYLE_PROPERTY
static final java.lang.String SOAPACTION_USE_PROPERTY
static final java.lang.String SOAPACTION_URI_PROPERTY
static final java.lang.String ENCODINGSTYLE_URI_PROPERTY
static final java.lang.String SESSION_MAINTAIN_PROPERTY
boolean isParameterAndReturnSpecRequired(javax.xml.namespace.QName operationName)
operationName
- Qualified name of the operationjava.lang.IllegalArgumentException
- If invalid operation name is specifiedvoid addParameter(java.lang.String paramName, javax.xml.namespace.QName xmlType, ParameterMode parameterMode)
paramName
- Name of the parameterxmlType
- XML type of the parameterparameterMode
- Mode of the parameter-whether ParameterMode.IN, ParameterMode.OUT, or ParameterMode.INOUTJAXRPCException
- This exception may be thrown if the method isParameterAndReturnSpecRequired returns false for this operation.java.lang.IllegalArgumentException
- If any illegal parameter name or XML type is specifiedvoid addParameter(java.lang.String paramName, javax.xml.namespace.QName xmlType, java.lang.Class javaType, ParameterMode parameterMode)
paramName
- Name of the parameterxmlType
- XML type of the parameterjavaType
- Java class of the parameterparameterMode
- Mode of the parameter-whether ParameterMode.IN, ParameterMode.OUT, or ParameterMode.INOUTJAXRPCException
- java.lang.IllegalArgumentException
- If any illegal parameter name or XML type is specifiedjava.lang.UnsupportedOperationException
- If this method is not supportedjavax.xml.namespace.QName getParameterTypeByName(java.lang.String paramName)
paramName
- - Name of the parametervoid setReturnType(javax.xml.namespace.QName xmlType)
xmlType
- XML data type of the return valueJAXRPCException
- This exception may be thrown when the method isParameterAndReturnSpecRequired returns false.java.lang.IllegalArgumentException
- If an illegal XML type is specifiedvoid setReturnType(javax.xml.namespace.QName xmlType, java.lang.Class javaType)
xmlType
- XML data type of the return valuejavaType
- Java Class of the return valueJAXRPCException
- java.lang.UnsupportedOperationException
- If this method is not supportedjava.lang.IllegalArgumentException
- If an illegal XML type is specifiedjavax.xml.namespace.QName getReturnType()
void removeAllParameters()
JAXRPCException
- This exception may be thrown If this method is called when the method isParameterAndReturnSpecRequired returns false for this Call's operation.javax.xml.namespace.QName getOperationName()
void setOperationName(javax.xml.namespace.QName operationName)
operationName
- QName of the operation to be invoked using the Call instancejavax.xml.namespace.QName getPortTypeName()
void setPortTypeName(javax.xml.namespace.QName portType)
portType
- - Qualified name of the port typevoid setTargetEndpointAddress(java.lang.String address)
address
- Address of the target service endpoint; specified as an URIjava.lang.String getTargetEndpointAddress()
void setProperty(java.lang.String name, java.lang.Object value)
name
- Name of the propertyvalue
- Value of the propertyJAXRPCException
- java.lang.Object getProperty(java.lang.String name)
name
- Name of the propertyJAXRPCException
- if an invalid or unsupported property name is passed.void removeProperty(java.lang.String name)
name
- Name of the propertyJAXRPCException
- if an invalid or unsupported property name is passed.java.util.Iterator getPropertyNames()
java.lang.Object invoke(java.lang.Object[] inputParams) throws java.rmi.RemoteException
inputParams
- Object[]--Parameters for this invocation. This includes only the input paramsjava.rmi.RemoteException
- if there is any error in the remote method invocationSOAPFaultException
- Indicates a SOAP faultJAXRPCException
- java.lang.Object invoke(javax.xml.namespace.QName operationName, java.lang.Object[] inputParams) throws java.rmi.RemoteException
operationName
- QName of the operationinputParams
- Object[]--Parameters for this invocation. This includes only the input params.java.rmi.RemoteException
- if there is any error in the remote method invocation.SOAPFaultException
- - Indicates a SOAP faultJAXRPCException
- void invokeOneWay(java.lang.Object[] inputParams)
inputParams
- Object[]--Parameters for this invocation. This includes only the input params.JAXRPCException
- if there is an error in the configuration of the Call object
(example: a non-void return type has been incorrectly specified for the one-way call) or
if there is any error during the invocation of the one-way remote calljava.util.Map getOutputParams()
JAXRPCException
- If this method is invoked for a one-way operation or is invoked before any invoke method has been called.java.util.List getOutputValues()
JAXRPCException
- If this method is invoked for a one-way operation or is invoked before any invoke method has been called.