javax.xml.rpc
public interface Call
javax.xml.rpc.Call
interface provides support
for the dynamic invocation of a service endpoint. The
javax.xml.rpc.Service
interface acts as a factory
for the creation of Call
instances.
Once a Call
instance is created, various setter
and getter methods may be used to configure this Call
instance.
Field Summary | |
---|---|
static String | ENCODINGSTYLE_URI_PROPERTY
Standard property for encoding Style: Encoding style specified
as a namespace URI. |
static String | OPERATION_STYLE_PROPERTY
Standard property for operation style. |
static String | PASSWORD_PROPERTY
Standard property: Password for authentication
Type: |
static 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 String | SOAPACTION_URI_PROPERTY
Standard property for SOAPAction. |
static String | SOAPACTION_USE_PROPERTY
Standard property for SOAPAction. |
static String | USERNAME_PROPERTY
Standard property: User name for authentication
Type: |
Method Summary | |
---|---|
void | addParameter(String paramName, QName xmlType, ParameterMode parameterMode)
Adds a parameter type and mode for a specific operation.
|
void | addParameter(String paramName, QName xmlType, Class javaType, ParameterMode parameterMode)
Adds a parameter type and mode for a specific operation.
|
QName | getOperationName()
Gets the name of the operation to be invoked using this Call instance.
|
Map | getOutputParams()
Returns a Map of {name, value} for the output parameters of
the last invoked operation. |
List | getOutputValues()
Returns a List values for the output parameters
of the last invoked operation.
|
QName | getParameterTypeByName(String paramName)
Gets the XML type of a parameter by name.
|
QName | getPortTypeName()
Gets the qualified name of the port type.
|
Object | getProperty(String name)
Gets the value of a named property.
|
Iterator | getPropertyNames()
Gets the names of configurable properties supported by
this Call object.
|
QName | getReturnType()
Gets the return type for a specific operation.
|
String | getTargetEndpointAddress()
Gets the address of a target service endpoint.
|
Object | invoke(Object[] inputParams)
Invokes a specific operation using a synchronous request-response
interaction mode.
|
Object | invoke(QName operationName, Object[] inputParams)
Invokes a specific operation using a synchronous request-response
interaction mode.
|
void | invokeOneWay(Object[] params)
Invokes a remote method using the one-way interaction mode. |
boolean | isParameterAndReturnSpecRequired(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(String name)
Removes a named property.
|
void | setOperationName(QName operationName)
Sets the name of the operation to be invoked using this
Call instance.
|
void | setPortTypeName(QName portType)
Sets the qualified name of the port type.
|
void | setProperty(String name, Object value)
Sets the value for a named property. |
void | setReturnType(QName xmlType)
Sets the return type for a specific operation. |
void | setReturnType(QName xmlType, Class javaType)
Sets the return type for a specific operation.
|
void | setTargetEndpointAddress(String address)
Sets the address of the target service endpoint.
|
http://schemas.xmlsoap.org/soap/encoding/
Type: java.lang.String
Type: java.lang.String
Type: java.lang.String
false
.
Type: java.lang.Boolean
javax.xml.rpc.soap.http.soapaction.use
property is set to true
.
Type: java.lang.String
Type: java.lang.Boolean
Type: java.lang.String
addParameter
and setReturnType
methods before calling the invoke
method. In
this case, the Call implementation class determines the
parameter types by using reflection on parameters, using
the WSDL description and configured type mapping registry.
Parameters: paramName Name of the parameter xmlType XML datatype of the parameter parameterMode Mode of the parameter-whether
ParameterMode.IN
,
ParameterMode.OUT
,
or ParameterMode.INOUT
Throws: JAXRPCException 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 specified
Parameters: paramName Name of the parameter xmlType XML datatype of the parameter javaType The Java class of the parameter parameterMode Mode of the parameter-whether ParameterMode.IN, OUT or INOUT
Throws: JAXRPCException
java.lang.IllegalArgumentException If any illegal
parameter name or XML type is specified java.lang.UnsupportedOperationException If this
method is not supported isParameterAndReturnSpecRequired
returns false
.
TypeMappingRegistry
has no serializers for this mapping.
Returns: Qualified name of the operation
Map
of {name, value} for the output parameters of
the last invoked operation. The parameter names in the
returned Map are of type java.lang.String
.
Returns: Map Output parameters for the last Call.invoke()
.
Empty Map
is returned if there are no output
parameters.
Throws: javax.xml.rpc.JAXRPCException If this method is invoked for a
one-way operation or is invoked before any
invoke
method has been called.
List
values for the output parameters
of the last invoked operation.
Returns: java.util.List Values for the output parameters. An
empty List
is returned if there are
no output values.
Throws: JAXRPCException If this method is invoked for a
one-way operation or is invoked before any
invoke
method has been called.
Parameters: paramName name of the parameter
Returns: Returns XML type for the specified parameter
Returns: Qualified name of the port type
Parameters: name Name of the property
Returns: Value of the named property
Throws: JAXRPCException if an invalid or unsupported property name is passed.
Call
object.
Returns: Iterator for the property names
Returns: the XML type for the return value
Returns: Endpoint address of the target service port as an URI
Parameters: inputParams Object[]--Parameters for this invocation. This includes only the input params
Returns: Returns the return value or null
Throws: java.rmi.RemoteException if there is any error in the remote
method invocation or if the Call
object is not configured properly. javax.xml.rpc.soap.SOAPFaultException Indicates a SOAP fault JAXRPCException
Call
object
inputParams
do not match the required parameter
set (as specified through the addParameter
invocations or in the corresponding WSDL)
Parameters: operationName QName of the operation inputParams Object[]--Parameters for this invocation. This includes only the input params.
Returns: Return value or null
Throws: java.rmi.RemoteException if there is any error in the
remote method invocation. javax.xml.rpc.soap.SOAPFaultException Indicates a SOAP fault JAXRPCException
Cal
l object
inputParam
s do not match the required parameter
set (as specified through the addParameter
invocations or in the corresponding WSDL)
JAXRPCException
during the processing of the one-way
remote call.
Parameters: params Object[]--Parameters for this invocation. This includes only the input params.
Throws: 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 call
addParameter
and
setReturnType
methods
are to be invoked to specify the parameter and return type
specification for a specific operation.
Parameters: operationName Qualified name of the operation
Returns: Returns true if the Call implementation class requires addParameter and setReturnType to be invoked in the client code for the specified operation. This method returns false otherwise.
Call
instance.
Note that this method removes only the parameters and not
the return type. The setReturnType(null)
is
used to remove the return type.
Throws: JAXRPCException This exception may be
thrown If this method is called when the method
isParameterAndReturnSpecRequired
returns false
for this Call's operation.
Parameters: name Name of the property
Throws: JAXRPCException if an invalid or unsupported property name is passed.
Call
instance.
Parameters: operationName QName of the operation to be invoked using the Call instance
Parameters: portType Qualified name of the port type
Call.setProperty
method.
Parameters: name Name of the property value Value of the property
Throws: JAXRPCException
Call
implementation
class does not support the configuration of
this property.
setReturnType(null)
removes the return
type for this Call object.
Parameters: xmlType XML data type of the return value
Throws: JAXRPCException This exception
may be thrown when the method
isParameterAndReturnSpecRequired
returns
false
. java.lang.IllegalArgumentException If an illegal
XML type is specified
Parameters: xmlType XML data type of the return value javaType Java class of the return value
Throws: JAXRPCException
java.lang.UnsupportedOperationException If this
method is not supported java.lang.IllegalArgumentException If an illegal
XML type is specified isParameterAndReturnSpecRequired
returns false
.
Call
instance.
Parameters: address Address of the target service endpoint; specified as an URI