|
||||||||||
PREV CLASS NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 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 |
Method Summary | |
void |
addParameter(java.lang.String paramName,
QName (src) xmlType,
java.lang.Class javaType,
ParameterMode (src) parameterMode)
Adds a parameter type and mode for a specific operation. |
void |
addParameter(java.lang.String paramName,
QName (src) xmlType,
ParameterMode (src) parameterMode)
Adds a parameter type and mode for a specific operation. |
QName (src) |
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. |
QName (src) |
getParameterTypeByName(java.lang.String paramName)
Gets the XML type of a parameter by name. |
QName (src) |
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 (src) |
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(QName (src) 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(QName (src) 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(QName (src) operationName)
Sets the name of the operation to be invoked using this Call instance. |
void |
setPortTypeName(QName (src) 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 (src) xmlType)
Sets the return type for a specific operation. |
void |
setReturnType(QName (src) 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. |
Field Detail |
public static final java.lang.String ENCODINGSTYLE_URI_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 void removeAllParameters()
JAXRPCException (src)
- This exception may be thrown If this method is called when the method isParameterAndReturnSpecRequired returns false for this Call's operation.public void invokeOneWay(java.lang.Object[] inputParams)
inputParams
- Object[]--Parameters for this invocation. This includes only the input params.
JAXRPCException (src)
- 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.lang.String getTargetEndpointAddress()
public void removeProperty(java.lang.String name)
name
- Name of the property
JAXRPCException (src)
- if an invalid or unsupported property name is passed.public void setTargetEndpointAddress(java.lang.String address)
address
- Address of the target service endpoint; specified as an URIpublic java.util.Iterator getPropertyNames()
public java.util.List getOutputValues()
JAXRPCException (src)
- If this method is invoked for a one-way operation or is invoked before any invoke method has been called.public java.util.Map getOutputParams()
JAXRPCException (src)
- If this method is invoked for a one-way operation or is invoked before any invoke method has been called.public QName (src) getOperationName()
public QName (src) getPortTypeName()
public QName (src) getReturnType()
public void setOperationName(QName (src) operationName)
operationName
- QName of the operation to be invoked using the Call instancepublic void setPortTypeName(QName (src) portType)
portType
- - Qualified name of the port typepublic boolean isParameterAndReturnSpecRequired(QName (src) operationName)
operationName
- Qualified name of the operation
java.lang.IllegalArgumentException
- If invalid operation name is specifiedpublic void setReturnType(QName (src) xmlType)
xmlType
- XML data type of the return value
JAXRPCException (src)
- This exception may be thrown when the method isParameterAndReturnSpecRequired returns false.
java.lang.IllegalArgumentException
- If an illegal XML type is specifiedpublic void setReturnType(QName (src) xmlType, java.lang.Class javaType)
xmlType
- XML data type of the return valuejavaType
- Java Class of the return value
JAXRPCException (src)
- java.lang.UnsupportedOperationException
- If this method is not supported
java.lang.IllegalArgumentException
- If an illegal XML type is specifiedpublic java.lang.Object invoke(java.lang.Object[] inputParams) throws java.rmi.RemoteException
inputParams
- 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 (src)
- Indicates a SOAP fault
JAXRPCException (src)
- public java.lang.Object getProperty(java.lang.String name)
name
- Name of the property
JAXRPCException (src)
- if an invalid or unsupported property name is passed.public void setProperty(java.lang.String name, java.lang.Object value)
name
- Name of the propertyvalue
- Value of the property
JAXRPCException (src)
- public QName (src) getParameterTypeByName(java.lang.String paramName)
paramName
- - Name of the parameter
public java.lang.Object invoke(QName (src) 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 (src)
- - Indicates a SOAP fault
JAXRPCException (src)
- public void addParameter(java.lang.String paramName, QName (src) xmlType, ParameterMode (src) parameterMode)
paramName
- Name of the parameterxmlType
- XML type of the parameterparameterMode
- Mode of the parameter-whether ParameterMode.IN, ParameterMode.OUT, or ParameterMode.INOUT
JAXRPCException (src)
- 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 specifiedpublic void addParameter(java.lang.String paramName, QName (src) xmlType, java.lang.Class javaType, ParameterMode (src) 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.INOUT
JAXRPCException (src)
- java.lang.IllegalArgumentException
- If any illegal parameter name or XML type is specified
java.lang.UnsupportedOperationException
- If this method is not supported
|
||||||||||
PREV CLASS NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |