|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The javax.xml.rpc.Call interface provides support for dynamic invocation of a service port. 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. The properties configured on a Call instance include the following:
Field Summary | |
static java.lang.String |
ENCODINGSTYLE_URI_PROPERTY
|
static java.lang.String |
ENDPOINT_ADDRESS_PROPERTY
|
static java.lang.String |
OPERATION_STYLE_PROPERTY
|
static java.lang.String |
PASSWORD_PROPERTY
|
static java.lang.String |
SESSION_MAINTAIN_PROPERTY
|
static java.lang.String |
SOAPACTION_URI_PROPERTY
|
static java.lang.String |
SOAPACTION_USE_PROPERTY
|
static java.lang.String |
USERNAME_PROPERTY
|
Method Summary | |
void |
addParameter(java.lang.String paramName,
QName xmlType,
java.lang.Class javaType,
ParameterMode parameterMode)
Adds a parameter type and mode for a specific operation. |
void |
addParameter(java.lang.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. |
java.util.Map |
getOutputParams()
This method returns a java.util.Map of {name, value} for the PARAM_MODE_OUT and PARAM_MODE_INOUT parameters for the last invoked operation. |
java.util.List |
getOutputValues()
Returns a List values for the output parameters of the last invoked operation. |
QName |
getParameterTypeByName(java.lang.String paramName)
Given a parameter name, return the QName of its type. |
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. |
QName |
getReturnType()
Get the QName of the return type. |
java.lang.String |
getTargetEndpointAddress()
Gets the endpoint address of a target service port. |
java.lang.Object |
invoke(java.lang.Object[] params)
Invokes a specific operation using a synchronous request-response interaction mode. |
java.lang.Object |
invoke(QName operationName,
java.lang.Object[] params)
Invokes a specific operation using a synchronous request-response interaction mode. |
void |
invokeOneWay(java.lang.Object[] params)
Invokes a remote method using the one-way interaction mode. |
boolean |
isParameterAndReturnSpecRequired()
Is the caller required to provide the parameter and return type specification? If true, then addParameter and setReturnType MUST be called to provide the meta data. |
void |
removeAllParameters()
Removes all specified parameters from this Call instance. |
void |
removeProperty(java.lang.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(java.lang.String name,
java.lang.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,
java.lang.Class javaType)
Sets the return type for a specific operation. |
void |
setTargetEndpointAddress(java.lang.String address)
Sets the endpoint address of the target service port. |
Field Detail |
public static final java.lang.String ENCODINGSTYLE_URI_PROPERTY
public static final java.lang.String ENDPOINT_ADDRESS_PROPERTY
public static final java.lang.String OPERATION_STYLE_PROPERTY
public static final java.lang.String PASSWORD_PROPERTY
public static final java.lang.String SESSION_MAINTAIN_PROPERTY
public static final java.lang.String SOAPACTION_URI_PROPERTY
public static final java.lang.String SOAPACTION_USE_PROPERTY
public static final java.lang.String USERNAME_PROPERTY
Method Detail |
public boolean isParameterAndReturnSpecRequired()
public void addParameter(java.lang.String paramName, QName xmlType, ParameterMode parameterMode)
paramName
- - Name of the parameterxmlType
- - XML datatype of the parameterparameterMode
- - Mode of the parameter-whether IN, OUT or INOUTJAXRPCException
- - if isParameterAndReturnSpecRequired returns
false, then addParameter will throw
JAXRPCException.public void addParameter(java.lang.String paramName, QName xmlType, java.lang.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 IN, OUT or INOUTJAXRPCException
- - if isParameterAndReturnSpecRequired returns
false, then addParameter will throw
JAXRPCException.public QName getParameterTypeByName(java.lang.String paramName)
paramName
- - Name of the parameter.public void setReturnType(QName xmlType)
xmlType
- - QName of the data type of the return valueJAXRPCException
- - if isParameterAndReturnSpecRequired returns
false, then setReturnType will throw JAXRPCException.public void setReturnType(QName xmlType, java.lang.Class javaType)
xmlType
- - QName of the data type of the return valuejavaType
- - Java class of the return valueJAXRPCException
- - if isParameterAndReturnSpecRequired returns
false, then setReturnType will throw JAXRPCException.public QName getReturnType()
public void removeAllParameters()
JAXRPCException
- - if isParameterAndReturnSpecRequired returns
false, then removeAllParameters will throw JAXRPCException.public QName getOperationName()
public void setOperationName(QName operationName)
operationName
- - QName of the operation to be invoked using the
Call instancepublic QName getPortTypeName()
public void setPortTypeName(QName portType)
portType
- - Qualified name of the port typepublic void setTargetEndpointAddress(java.lang.String address)
address
- - Endpoint address of the target service port; specified
as URIpublic java.lang.String getTargetEndpointAddress()
public void setProperty(java.lang.String name, java.lang.Object value)
name
- - Name of the propertyvalue
- - Value of the propertypublic java.lang.Object getProperty(java.lang.String name)
name
- - Name of the propertypublic void removeProperty(java.lang.String name)
name
- - Name of the propertypublic java.util.Iterator getPropertyNames()
public java.lang.Object invoke(QName operationName, java.lang.Object[] params) throws java.rmi.RemoteException
operationName
- - Name of the operation to invokeparams
- - Parameters for this invocationjava.rmi.RemoteException
- - if there is any error in the remote
method invocation or if the Call
object is not configured properly.public java.lang.Object invoke(java.lang.Object[] params) throws java.rmi.RemoteException
params
- - Parameters for this invocationjava.rmi.RemoteException
- - if there is any error in the remote
method invocation or if the Call
object is not configured properly.public void invokeOneWay(java.lang.Object[] params)
params
- - Parameters for this invocationJAXRPCException
- - 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 callpublic java.util.Map getOutputParams()
JAXRPCException
- - if this method is invoked on a
one-way operation or if it is
invoked before any invoke method
has been called.public 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |