|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Call
The 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: java.lang.String |
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: java.lang.String |
Method Summary | |
---|---|
void |
addParameter(String paramName,
QName xmlType,
Class javaType,
ParameterMode parameterMode)
Adds a parameter type and mode for a specific operation. |
void |
addParameter(String paramName,
QName xmlType,
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. |
Field Detail |
---|
static final String USERNAME_PROPERTY
Type:
java.lang.String
static final String PASSWORD_PROPERTY
Type: java.lang.String
static final String OPERATION_STYLE_PROPERTY
Type: java.lang.String
static final String SOAPACTION_USE_PROPERTY
Type: java.lang.Boolean
static final String SOAPACTION_URI_PROPERTY
javax.xml.rpc.soap.http.soapaction.use
property is set to true
.
Type: java.lang.String
static final String ENCODINGSTYLE_URI_PROPERTY
http://schemas.xmlsoap.org/soap/encoding/
Type: java.lang.String
static final String SESSION_MAINTAIN_PROPERTY
false
.
Type: java.lang.Boolean
Method Detail |
---|
boolean isParameterAndReturnSpecRequired(QName operationName)
addParameter
and
setReturnType
methods
are to be invoked to specify the parameter and return type
specification for a specific operation.
operationName
- Qualified name of the operation
void addParameter(String paramName, QName xmlType, ParameterMode parameterMode)
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.
paramName
- Name of the parameterxmlType
- XML datatype of the parameterparameterMode
- 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.
IllegalArgumentException
- If any illegal
parameter name or XML type is specified
void addParameter(String paramName, QName xmlType, Class javaType, ParameterMode parameterMode)
paramName
- Name of the parameterxmlType
- XML datatype of the parameterjavaType
- The Java class of the parameterparameterMode
- Mode of the parameter-whether
ParameterMode.IN, OUT or INOUT
JAXRPCException
- isParameterAndReturnSpecRequired
returns false
.
TypeMappingRegistry
has no serializers for this mapping.
IllegalArgumentException
- If any illegal
parameter name or XML type is specified
UnsupportedOperationException
- If this
method is not supportedQName getParameterTypeByName(String paramName)
paramName
- name of the parameter
void setReturnType(QName xmlType)
setReturnType(null)
removes the return
type for this Call object.
xmlType
- XML data type of the return value
JAXRPCException
- This exception
may be thrown when the method
isParameterAndReturnSpecRequired
returns
false
.
IllegalArgumentException
- If an illegal
XML type is specifiedvoid setReturnType(QName xmlType, Class javaType)
xmlType
- XML data type of the return valuejavaType
- Java class of the return value
JAXRPCException
- isParameterAndReturnSpecRequired
returns false
.
UnsupportedOperationException
- If this
method is not supported
IllegalArgumentException
- If an illegal
XML type is specifiedQName getReturnType()
void removeAllParameters()
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.
JAXRPCException
- This exception may be
thrown If this method is called when the method
isParameterAndReturnSpecRequired
returns false
for this Call's operation.QName getOperationName()
void setOperationName(QName operationName)
Call
instance.
operationName
- QName of the operation to be
invoked using the Call instanceQName getPortTypeName()
void setPortTypeName(QName portType)
portType
- Qualified name of the port typevoid setTargetEndpointAddress(String address)
Call
instance.
address
- Address of the target service endpoint;
specified as an URIString getTargetEndpointAddress()
void setProperty(String name, Object value)
Call.setProperty
method.
name
- Name of the propertyvalue
- Value of the property
JAXRPCException
- Call
implementation
class does not support the configuration of
this property.
Object getProperty(String name)
name
- Name of the property
JAXRPCException
- if an invalid or
unsupported property name is passed.void removeProperty(String name)
name
- Name of the property
JAXRPCException
- if an invalid or
unsupported property name is passed.Iterator getPropertyNames()
Call
object.
Object invoke(Object[] inputParams) throws RemoteException
inputParams
- Object[]--Parameters for this invocation. This
includes only the input params
null
RemoteException
- if there is any error in the remote
method invocation or if the Call
object is not configured properly.
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)
Object invoke(QName operationName, Object[] inputParams) throws RemoteException
operationName
- QName of the operationinputParams
- Object[]--Parameters for this invocation. This
includes only the input params.
RemoteException
- if there is any error in the
remote method invocation.
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)
void invokeOneWay(Object[] params)
JAXRPCException
during the processing of the one-way
remote call.
params
- 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 callMap getOutputParams()
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
.
Call.invoke()
.
Empty Map
is returned if there are no output
parameters.
JAXRPCException
- If this method is invoked for a
one-way operation or is invoked before any
invoke
method has been called.List getOutputValues()
List
values for the output parameters
of the last invoked operation.
List
is returned if there are
no output values.
JAXRPCException
- If this method is invoked for a
one-way operation or is invoked before any
invoke
method has been called.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |