com.ibm.websphere.webservices.rpc

Interface IBMCall

All Superinterfaces:

javax.xml.rpc.Call

public interface IBMCall
extends javax.xml.rpc.Call

This interface exposes IBM value-add methods.

See Also:

Call

Field Summary

Fields inherited from interface javax.xml.rpc.Call

ENCODINGSTYLE_URI_PROPERTY, OPERATION_STYLE_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, SOAPACTION_URI_PROPERTY, SOAPACTION_USE_PROPERTY, USERNAME_PROPERTY

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttachmentParameter(javax.xml.namespace.QName paramName, java.lang.String mimeType, java.lang.Class javaType, javax.xml.rpc.ParameterMode mode) Adds an description of a parameter as a MIME attachment.
void	addParameter(javax.xml.namespace.QName paramName, javax.xml.namespace.QName xmlType, java.lang.Class javaType, javax.xml.rpc.ParameterMode parameterMode) Adds a parameter type and mode for a specific operation.
void	addParameter(javax.xml.namespace.QName paramName, javax.xml.namespace.QName xmlType, javax.xml.rpc.ParameterMode parameterMode) Adds a parameter type and mode for a specific operation.
void	setAttachmentReturnType(java.lang.String mimeType, java.lang.Class javaType) Sets the return type for a specific operation as a MIME attachment type.

Methods inherited from interface javax.xml.rpc.Call

addParameter, addParameter, getOperationName, getOutputParams, getOutputValues, getParameterTypeByName, getPortTypeName, getProperty, getPropertyNames, getReturnType, getTargetEndpointAddress, invoke, invoke, invokeOneWay, isParameterAndReturnSpecRequired, removeAllParameters, removeProperty, setOperationName, setPortTypeName, setProperty, setReturnType, setReturnType, setTargetEndpointAddress

Method Detail

addAttachmentParameter

void addAttachmentParameter(javax.xml.namespace.QName paramName,
                          java.lang.String mimeType,
                          java.lang.Class javaType,
                          javax.xml.rpc.ParameterMode mode)

Adds an description of a parameter as a MIME attachment.

It is an addition to the standard JAX-RPC functionality. However, this functionality may be added to JAX-RPC in the future, in which case it will then become deprecated.

Parameters:

paramName - Name of the parameter

mimeType - MIME datatype of the parameter

mode - 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.

java.lang.IllegalArgumentException - If any illegal parameter name is specified

setAttachmentReturnType

void setAttachmentReturnType(java.lang.String mimeType,
                           java.lang.Class javaType)

Sets the return type for a specific operation as a MIME attachment type. Invoking setReturnType(null) removes the return type for this Call object.

It is an addition to the standard JAX-RPC functionality. However, this functionality may be added to JAX-RPC in the future, in which case it will then become deprecated.

Parameters:

mimeType - MIME data type of the return value

Throws:

JAXRPCException - This exception may be thrown when the method isParameterAndReturnSpecRequired returns false.

addParameter

void addParameter(javax.xml.namespace.QName paramName,
                javax.xml.namespace.QName xmlType,
                javax.xml.rpc.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.

NOTE: In the JAX-RPC version of this method, paramName is a String. In some cases that is insufficient.

It is an addition to the standard JAX-RPC functionality. However, this functionality may be added to JAX-RPC in the future, in which case it will then become deprecated.

Parameters:

paramName - QName of the parameter

xmlType - XML datatype of the parameter

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.

java.lang.IllegalArgumentException - If any illegal parameter name or XML type is specified

addParameter

void addParameter(javax.xml.namespace.QName paramName,
                javax.xml.namespace.QName xmlType,
                java.lang.Class javaType,
                javax.xml.rpc.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.

NOTE: In the JAX-RPC version of this method, paramName is a String. In some cases that is insufficient.

It is an addition to the standard JAX-RPC functionality. However, this functionality may be added to JAX-RPC in the future, in which case it will then become deprecated.

Parameters:

paramName - QName of the parameter

xmlType - XML datatype of the parameter

javaType - The Java class of the parameter

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.

java.lang.IllegalArgumentException - If any illegal parameter name or XML type is specified

java.lang.UnsupportedOperationException - If this method is not supported