Save This Page
Home » openjdk-7 » javax » xml » rpc » [javadoc | source]
javax.xml.rpc
public interface: Call [javadoc | source] 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
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 

Method from javax.xml.rpc.Call Summary:
addParameter,   addParameter,   getOperationName,   getOutputParams,   getOutputValues,   getParameterTypeByName,   getPortTypeName,   getProperty,   getPropertyNames,   getReturnType,   getTargetEndpointAddress,   invoke,   invoke,   invokeOneWay,   isParameterAndReturnSpecRequired,   removeAllParameters,   removeProperty,   setOperationName,   setPortTypeName,   setProperty,   setReturnType,   setReturnType,   setTargetEndpointAddress
Method from javax.xml.rpc.Call Detail:
 public  void addParameter(String paramName,
    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.
 public  void addParameter(String paramName,
    QName xmlType,
    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.
 public QName getOperationName()
    Gets the name of the operation to be invoked using this Call instance.
 public 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.
 public List getOutputValues()
    Returns a List values for the output parameters of the last invoked operation.
 public QName getParameterTypeByName(String paramName)
    Gets the XML type of a parameter by name.
 public QName getPortTypeName()
    Gets the qualified name of the port type.
 public Object getProperty(String name)
    Gets the value of a named property.
 public Iterator getPropertyNames()
    Gets the names of configurable properties supported by this Call object.
 public QName getReturnType()
    Gets the return type for a specific operation.
 public String getTargetEndpointAddress()
    Gets the address of a target service endpoint.
 public Object invoke(Object[] inputParams) throws RemoteException
    Invokes a specific operation using a synchronous request-response interaction mode.
 public Object invoke(QName operationName,
    Object[] inputParams) throws RemoteException
    Invokes a specific operation using a synchronous request-response interaction mode.
 public  void invokeOneWay(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.
 public 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.
 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.
 public  void removeProperty(String name)
    Removes a named property.
 public  void setOperationName(QName operationName)
    Sets the name of the operation to be invoked using this Call instance.
 public  void setPortTypeName(QName portType)
    Sets the qualified name of the port type.
 public  void setProperty(String name,
    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.
 public  void setReturnType(QName xmlType)
    Sets the return type for a specific operation. Invoking setReturnType(null) removes the return type for this Call object.
 public  void setReturnType(QName xmlType,
    Class javaType)
    Sets the return type for a specific operation.
 public  void setTargetEndpointAddress(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.