File	Doc	Category	Size	Date	Package
Call.java	API Doc	Apache Axis 1.4	16285	Sat Apr 22 18:57:26 BST 2006	javax.xml.rpc

Call

Fields Summary
public static final String	USERNAME_PROPERTY Standard property: User name for authentication Type: java.lang.String
public static final String	PASSWORD_PROPERTY Standard property: Password for authentication Type: java.lang.String
public static final String	OPERATION_STYLE_PROPERTY Standard property for operation style. This property is set to "rpc" if the operation style is rpc; "document" if the operation style is document. Type: java.lang.String
public static final String	SOAPACTION_USE_PROPERTY Standard property for SOAPAction. This boolean property indicates whether or not SOAPAction is to be used. The default value of this property is false indicating that the SOAPAction is not used. Type: java.lang.Boolean
public static final String	SOAPACTION_URI_PROPERTY Standard property for SOAPAction. Indicates the SOAPAction URI if the javax.xml.rpc.soap.http.soapaction.use property is set to true. Type: java.lang.String
public static final String	ENCODINGSTYLE_URI_PROPERTY Standard property for encoding Style: Encoding style specified as a namespace URI. The default value is the SOAP 1.1 encoding http://schemas.xmlsoap.org/soap/encoding/ Type: java.lang.String
public static final 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. If this property is set to true, the service client indicates that it wants the session to be maintained. If set to false, the session is not maintained. The default value for this property is false. Type: java.lang.Boolean

Constructors Summary

Methods Summary
public void	addParameter(java.lang.String paramName, javax.xml.namespace.QName xmlType, ParameterMode parameterMode) Adds a parameter type and mode for a specific operation. Note that the client code may not call any 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. param paramName Name of the parameter param xmlType XML datatype of the parameter param 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. throws java.lang.IllegalArgumentException If any illegal parameter name or XML type is specified
public 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. This method is used to specify the Java type for either OUT or INOUT parameters. param paramName Name of the parameter param xmlType XML datatype of the parameter param javaType The Java class of the parameter param parameterMode Mode of the parameter-whether ParameterMode.IN, OUT or INOUT throws JAXRPCException This exception may be thrown if this method is invoked when the method isParameterAndReturnSpecRequired returns false. If specified XML type and Java type mapping is not valid. For example, TypeMappingRegistry has no serializers for this mapping. throws java.lang.IllegalArgumentException If any illegal parameter name or XML type is specified throws java.lang.UnsupportedOperationException If this method is not supported
public javax.xml.namespace.QName	getOperationName() Gets the name of the operation to be invoked using this Call instance. return Qualified name of the operation
public java.util.Map	getOutputParams() Returns a 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. return 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.
public java.util.List	getOutputValues() Returns a List values for the output parameters of the last invoked operation. return 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.
public javax.xml.namespace.QName	getParameterTypeByName(java.lang.String paramName) Gets the XML type of a parameter by name. param paramName name of the parameter return Returns XML type for the specified parameter
public javax.xml.namespace.QName	getPortTypeName() Gets the qualified name of the port type. return Qualified name of the port type
public java.lang.Object	getProperty(java.lang.String name) Gets the value of a named property. param name Name of the property return Value of the named property throws JAXRPCException if an invalid or unsupported property name is passed.
public java.util.Iterator	getPropertyNames() Gets the names of configurable properties supported by this Call object. return Iterator for the property names
public javax.xml.namespace.QName	getReturnType() Gets the return type for a specific operation. return the XML type for the return value
public java.lang.String	getTargetEndpointAddress() Gets the address of a target service endpoint. return Endpoint address of the target service port as an URI
public java.lang.Object	invoke(java.lang.Object[] inputParams) Invokes a specific operation using a synchronous request-response interaction mode. param inputParams Object[]--Parameters for this invocation. This includes only the input params return 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. throws javax.xml.rpc.soap.SOAPFaultException Indicates a SOAP fault throws JAXRPCException If there is an error in the configuration of the Call object If inputParams do not match the required parameter set (as specified through the addParameter invocations or in the corresponding WSDL) If parameters and return type are incorrectly specified
public java.lang.Object	invoke(javax.xml.namespace.QName operationName, java.lang.Object[] inputParams) Invokes a specific operation using a synchronous request-response interaction mode. param operationName QName of the operation param inputParams Object[]--Parameters for this invocation. This includes only the input params. return Return value or null throws java.rmi.RemoteException if there is any error in the remote method invocation. throws javax.xml.rpc.soap.SOAPFaultException Indicates a SOAP fault throws JAXRPCException If there is an error in the configuration of the Call object If inputParams do not match the required parameter set (as specified through the addParameter invocations or in the corresponding WSDL) If parameters and return type are incorrectly specified
public void	invokeOneWay(java.lang.Object[] params) Invokes a remote method using the one-way interaction mode. The client thread does not block waiting for the completion of the server processing for this remote method invocation. This method must not throw any remote exceptions. This method may throw a JAXRPCException during the processing of the one-way remote call. param 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
public 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. param operationName Qualified name of the operation return 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.
public void	removeAllParameters() Removes all specified parameters from this 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.
public void	removeProperty(java.lang.String name) Removes a named property. param name Name of the property throws JAXRPCException if an invalid or unsupported property name is passed.
public void	setOperationName(javax.xml.namespace.QName operationName) Sets the name of the operation to be invoked using this Call instance. param operationName QName of the operation to be invoked using the Call instance
public void	setPortTypeName(javax.xml.namespace.QName portType) Sets the qualified name of the port type. param portType Qualified name of the port type
public void	setProperty(java.lang.String name, java.lang.Object value) Sets the value for a named property. JAX-RPC specification specifies a standard set of properties that may be passed to the Call.setProperty method. param name Name of the property param value Value of the property throws JAXRPCException If an optional standard property name is specified, however this Call implementation class does not support the configuration of this property. If an invalid (or unsupported) property name is specified or if a value of mismatched property type is passed. If there is any error in the configuration of a valid property.
public void	setReturnType(javax.xml.namespace.QName xmlType) Sets the return type for a specific operation. Invoking setReturnType(null) removes the return type for this Call object. param xmlType XML data type of the return value throws JAXRPCException This exception may be thrown when the method isParameterAndReturnSpecRequired returns false. throws java.lang.IllegalArgumentException If an illegal XML type is specified
public void	setReturnType(javax.xml.namespace.QName xmlType, java.lang.Class javaType) Sets the return type for a specific operation. param xmlType XML data type of the return value param javaType Java class of the return value throws JAXRPCException This exception may be thrown if this method is invoked when the method isParameterAndReturnSpecRequired returns false. If XML type and Java type cannot be mapped using the standard type mapping or TypeMapping registry throws java.lang.UnsupportedOperationException If this method is not supported throws java.lang.IllegalArgumentException If an illegal XML type is specified
public void	setTargetEndpointAddress(java.lang.String address) Sets the address of the target service endpoint. This address must correspond to the transport specified in the binding for this Call instance. param address Address of the target service endpoint; specified as an URI