org.jboss.ws.core.jaxrpc.client

Class CallImpl

java.lang.Object

org.jboss.ws.core.CommonClient

org.jboss.ws.core.jaxrpc.client.CallImpl

All Implemented Interfaces:

javax.xml.rpc.Call, EndpointMetadataProvider, HeaderSource, RoleSource, StubExt

public class CallImpl
extends CommonClient
implements javax.xml.rpc.Call, RoleSource

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.

Since:

10-Oct-2004

Author:

Thomas.Diesler@jboss.org

Field Summary

Fields inherited from class org.jboss.ws.core.CommonClient

bindingProvider, epMetaData, operationName, SESSION_COOKIES

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

Fields inherited from interface org.jboss.ws.core.StubExt

PROPERTY_AUTH_TYPE, PROPERTY_AUTH_TYPE_BASIC, PROPERTY_CHUNKED_ENCODING_SIZE, PROPERTY_CLIENT_TIMEOUT, PROPERTY_CONNECTION_TIMEOUT, PROPERTY_KEY_ALIAS, PROPERTY_KEY_STORE, PROPERTY_KEY_STORE_ALGORITHM, PROPERTY_KEY_STORE_PASSWORD, PROPERTY_KEY_STORE_TYPE, PROPERTY_RECEIVE_TIMEOUT, PROPERTY_SOCKET_FACTORY, PROPERTY_SSL_PROTOCOL, PROPERTY_SSL_PROVIDER_NAME, PROPERTY_TRUST_STORE, PROPERTY_TRUST_STORE_ALGORITHM, PROPERTY_TRUST_STORE_PASSWORD, PROPERTY_TRUST_STORE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(QName xmlName, QName xmlType, Class javaType, javax.xml.rpc.ParameterMode mode, boolean inHeader) Add a parameter to the current operation description.
void	addParameter(String paramName, QName xmlType, Class javaType, javax.xml.rpc.ParameterMode mode) Adds a parameter type and mode for a specific operation.
void	addParameter(String paramName, QName xmlType, javax.xml.rpc.ParameterMode parameterMode) Adds a parameter type and mode for a specific operation.
protected boolean	callFaultHandlerChain(QName portName, org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type, Exception ex)
protected boolean	callRequestHandlerChain(QName portName, org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type)
protected boolean	callResponseHandlerChain(QName portName, org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type)
protected void	closeHandlerChain(QName portName, org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type)
protected EndpointInvocation	createEndpointInvocation(OperationMetaData opMetaData)
protected CommonBindingProvider	getCommonBindingProvider()
Set<QName>	getHeaders() Get the set of known headers for this source.
Map	getOutputParams() Returns a Map of {name, value} for the output parameters of the last invoked operation.
List	getOutputValues() Returns a List values for the output parameters of the last invoked operation.
QName	getParameterTypeByName(String paramName) Gets the XML type of a parameter by name.
QName	getPortTypeName() Gets the qualified name of the port type.
Object	getProperty(String name) Gets the value of a named property.
Iterator	getPropertyNames() Gets the names of configurable properties supported by this Call object.
protected Map<String,Object>	getRequestContext()
QName	getReturnType() Gets the return type for a specific operation
Set<String>	getRoles() Get the set of roles associate with this source.
ServiceImpl	getServiceImpl()
String	getTargetEndpointAddress() Gets the address of a target service endpoint.
Object	invoke(Object[] inputParams) Invokes a specific operation using a synchronous request-response interaction mode.
Object	invoke(QName operationName, Object[] inputParams) Invokes a specific operation using a synchronous request-response interaction mode.
void	invokeOneWay(Object[] inputParams) Invokes a remote method using the one-way interaction mode.
boolean	isParameterAndReturnSpecRequired(QName opName) Indicates whether addParameter and setReturnType methods are to be invoked to specify the parameter and return type specification for a specific operation.
protected CommonMessageContext	processPivot(CommonMessageContext requestContext)
void	removeAllParameters() Removes all specified parameters from this Call instance.
void	removeProperty(String name) Removes a named property.
protected void	setInboundContextProperties()
protected void	setOutboundContextProperties()
void	setPortTypeName(QName portType) Sets the qualified name of the interface.
void	setProperty(String name, 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, Class javaType) Sets the return type for a specific operation.
void	setTargetEndpointAddress(String address) Sets the address of the target service endpoint.
protected boolean	shouldMaintainSession()

Methods inherited from class org.jboss.ws.core.CommonClient

addAttachmentPart, addAttachmentParts, addSessionInfo, clearAttachmentParts, createAttachmentPart, getEndpointMetaData, getOperationMetaData, getOperationMetaData, getOperationName, invoke, setOperationName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.xml.rpc.Call

getOperationName, setOperationName

Method Detail

getServiceImpl

public ServiceImpl getServiceImpl()

getRequestContext

protected Map<String,Object> getRequestContext()

Specified by:

getRequestContext in class CommonClient

createEndpointInvocation

protected EndpointInvocation createEndpointInvocation(OperationMetaData opMetaData)

Overrides:

createEndpointInvocation in class CommonClient

getTargetEndpointAddress

public String getTargetEndpointAddress()

Gets the address of a target service endpoint.

Specified by:

getTargetEndpointAddress in interface javax.xml.rpc.Call

Specified by:

getTargetEndpointAddress in class CommonClient

setTargetEndpointAddress

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.

Specified by:

setTargetEndpointAddress in interface javax.xml.rpc.Call

Specified by:

setTargetEndpointAddress in class CommonClient

Parameters:

address - Address of the target service endpoint; specified as an URI

addParameter

public void addParameter(String paramName,
                QName xmlType,
                javax.xml.rpc.ParameterMode parameterMode)

Adds a parameter type and mode for a specific operation.

Specified by:

addParameter in interface javax.xml.rpc.Call

addParameter

public void addParameter(String paramName,
                QName xmlType,
                Class javaType,
                javax.xml.rpc.ParameterMode mode)

Adds a parameter type and mode for a specific operation.

Specified by:

addParameter in interface javax.xml.rpc.Call

addParameter

public void addParameter(QName xmlName,
                QName xmlType,
                Class javaType,
                javax.xml.rpc.ParameterMode mode,
                boolean inHeader)

Add a parameter to the current operation description. This is a propriatary extension that gives full control over the parameter configuration.

removeAllParameters

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.

Specified by:

removeAllParameters in interface javax.xml.rpc.Call

Throws:

javax.xml.rpc.JAXRPCException - This exception may be thrown If this method is called when the method isParameterAndReturnSpecRequired returns false for this Call's operation.

setReturnType

public void setReturnType(QName xmlType)

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

Specified by:

setReturnType in interface javax.xml.rpc.Call

setReturnType

public void setReturnType(QName xmlType,
                 Class javaType)

Sets the return type for a specific operation.

Specified by:

setReturnType in interface javax.xml.rpc.Call

invokeOneWay

public void invokeOneWay(Object[] inputParams)

Invokes a remote method using the one-way interaction mode.

Specified by:

invokeOneWay in interface javax.xml.rpc.Call

invoke

public Object invoke(Object[] inputParams)
              throws RemoteException

Invokes a specific operation using a synchronous request-response interaction mode.

Specified by:

invoke in interface javax.xml.rpc.Call

Throws:

RemoteException

invoke

public Object invoke(QName operationName,
            Object[] inputParams)
              throws RemoteException

Invokes a specific operation using a synchronous request-response interaction mode.

Specified by:

invoke in interface javax.xml.rpc.Call

Throws:

RemoteException

processPivot

protected CommonMessageContext processPivot(CommonMessageContext requestContext)

Specified by:

processPivot in class CommonClient

getOutputValues

public List getOutputValues()

Returns a List values for the output parameters of the last invoked operation.

Specified by:

getOutputValues in interface javax.xml.rpc.Call

Returns:

java.util.List Values for the output parameters. An empty List is returned if there are no output values.

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.

getOutputParams

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.

Specified by:

getOutputParams in interface javax.xml.rpc.Call

Returns:

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.

getPortTypeName

public QName getPortTypeName()

Gets the qualified name of the port type.

Specified by:

getPortTypeName in interface javax.xml.rpc.Call

Returns:

Qualified name of the port type

getReturnType

public QName getReturnType()

Gets the return type for a specific operation

Specified by:

getReturnType in interface javax.xml.rpc.Call

Returns:

Returns the XML type for the return value

setPortTypeName

public void setPortTypeName(QName portType)

Sets the qualified name of the interface.

Specified by:

setPortTypeName in interface javax.xml.rpc.Call

Parameters:

portType - - Qualified name of the port type

isParameterAndReturnSpecRequired

public boolean isParameterAndReturnSpecRequired(QName opName)

Indicates whether addParameter and setReturnType methods are to be invoked to specify the parameter and return type specification for a specific operation.

Specified by:

isParameterAndReturnSpecRequired in interface javax.xml.rpc.Call

Parameters:

opName - Qualified name of the operation

Returns:

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.

Throws:

IllegalArgumentException - If invalid operation name is specified

getPropertyNames

public Iterator getPropertyNames()

Gets the names of configurable properties supported by this Call object.

Specified by:

getPropertyNames in interface javax.xml.rpc.Call

Returns:

Iterator for the property names

getProperty

public Object getProperty(String name)

Gets the value of a named property.

Specified by:

getProperty in interface javax.xml.rpc.Call

setProperty

public void setProperty(String name,
               Object value)

Sets the value for a named property.

Specified by:

setProperty in interface javax.xml.rpc.Call

removeProperty

public void removeProperty(String name)

Removes a named property.

Specified by:

removeProperty in interface javax.xml.rpc.Call

getParameterTypeByName

public QName getParameterTypeByName(String paramName)

Gets the XML type of a parameter by name.

Specified by:

getParameterTypeByName in interface javax.xml.rpc.Call

getCommonBindingProvider

protected CommonBindingProvider getCommonBindingProvider()

Specified by:

getCommonBindingProvider in class CommonClient

setInboundContextProperties

protected void setInboundContextProperties()

Specified by:

setInboundContextProperties in class CommonClient

setOutboundContextProperties

protected void setOutboundContextProperties()

Specified by:

setOutboundContextProperties in class CommonClient

callRequestHandlerChain

protected boolean callRequestHandlerChain(QName portName,
                              org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type)

Specified by:

callRequestHandlerChain in class CommonClient

callResponseHandlerChain

protected boolean callResponseHandlerChain(QName portName,
                               org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type)

Specified by:

callResponseHandlerChain in class CommonClient

callFaultHandlerChain

protected boolean callFaultHandlerChain(QName portName,
                            org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type,
                            Exception ex)

Specified by:

callFaultHandlerChain in class CommonClient

closeHandlerChain

protected void closeHandlerChain(QName portName,
                     org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type)

Specified by:

closeHandlerChain in class CommonClient

getHeaders

public Set<QName> getHeaders()

Description copied from interface: HeaderSource

Get the set of known headers for this source.

Specified by:

getHeaders in interface HeaderSource

Returns:

set of known herars

getRoles

public Set<String> getRoles()

Description copied from interface: RoleSource

Get the set of roles associate with this source.

Specified by:

getRoles in interface RoleSource

Returns:

the set of roles

shouldMaintainSession

protected boolean shouldMaintainSession()

Specified by:

shouldMaintainSession in class CommonClient