org.jboss.ws.core

Class CommonClient

java.lang.Object

org.jboss.ws.core.CommonClient

All Implemented Interfaces:

EndpointMetadataProvider, HeaderSource, StubExt

Direct Known Subclasses:

CallImpl

public abstract class CommonClient
extends Object
implements StubExt, HeaderSource

Provides support for the dynamic invocation of a service endpoint.

Since:

10-Oct-2004

Author:

Thomas.Diesler@jboss.org

Field Summary

Fields

Modifier and Type	Field and Description
protected CommonBindingProvider	bindingProvider
protected EndpointMetaData	epMetaData
protected QName	operationName
static String	SESSION_COOKIES

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommonClient(EndpointMetaData epMetaData) Create a call for a known WSDL endpoint.
protected	CommonClient(ServiceMetaData serviceMetaData) Create a call that needs to be configured manually
protected	CommonClient(ServiceMetaData serviceMetaData, QName portName, QName opName) Create a call for a known WSDL endpoint.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttachmentPart(AttachmentPart part) Adds the given AttachmentPart object to the outgoing SOAPMessage.
protected void	addAttachmentParts(SOAPMessage reqMessage)
protected void	addSessionInfo(SOAPMessage reqMessage, Map<String,Object> callProperties)
protected abstract boolean	callFaultHandlerChain(QName portName, org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type, Exception ex)
protected abstract boolean	callRequestHandlerChain(QName portName, org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type)
protected abstract boolean	callResponseHandlerChain(QName portName, org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type)
void	clearAttachmentParts() Clears the list of attachment parts.
protected abstract void	closeHandlerChain(QName portName, org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedHandlerMetaData.HandlerType type)
AttachmentPart	createAttachmentPart() Creates a new empty AttachmentPart object.
protected EndpointInvocation	createEndpointInvocation(OperationMetaData opMetaData)
protected abstract CommonBindingProvider	getCommonBindingProvider()
EndpointMetaData	getEndpointMetaData() Get the endpoint meta data for this stub/dispatch
OperationMetaData	getOperationMetaData() Get the OperationMetaData for the given operation name If it does not exist, it will be created
OperationMetaData	getOperationMetaData(QName opName)
QName	getOperationName() Gets the name of the operation to be invoked using this Call instance.
protected abstract Map<String,Object>	getRequestContext()
abstract String	getTargetEndpointAddress() Gets the address of a target service endpoint.
protected Object	invoke(QName opName, Object[] inputParams, boolean forceOneway) Call invokation goes as follows: 1) synchronize the operation name with the operation meta data 2) synchronize the input parameters with the operation meta data 3) generate the payload using a BindingProvider 4) get the Invoker from Remoting, based on the target endpoint address 5) do the invocation through the Remoting framework 6) unwrap the result using the BindingProvider 7) return the result
protected abstract CommonMessageContext	processPivot(CommonMessageContext requestContext)
protected abstract void	setInboundContextProperties()
void	setOperationName(QName operationName) Sets the name of the operation to be invoked using this Call instance.
protected abstract void	setOutboundContextProperties()
abstract void	setTargetEndpointAddress(String address) Sets the address of the target service endpoint.
protected abstract boolean	shouldMaintainSession()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.ws.core.HeaderSource

getHeaders

Field Detail

SESSION_COOKIES

public static final String SESSION_COOKIES

See Also:

Constant Field Values

epMetaData

protected EndpointMetaData epMetaData

operationName

protected QName operationName

bindingProvider

protected CommonBindingProvider bindingProvider

Constructor Detail

CommonClient

protected CommonClient(ServiceMetaData serviceMetaData)

Create a call that needs to be configured manually

CommonClient

protected CommonClient(EndpointMetaData epMetaData)

Create a call for a known WSDL endpoint.

CommonClient

protected CommonClient(ServiceMetaData serviceMetaData,
            QName portName,
            QName opName)

Create a call for a known WSDL endpoint.

Method Detail

getTargetEndpointAddress

public abstract String getTargetEndpointAddress()

Gets the address of a target service endpoint.

setTargetEndpointAddress

public abstract void setTargetEndpointAddress(String address)

Sets the address of the target service endpoint.

getOperationName

public QName getOperationName()

Gets the name of the operation to be invoked using this Call instance.

setOperationName

public void setOperationName(QName operationName)

Sets the name of the operation to be invoked using this Call instance.

getOperationMetaData

public OperationMetaData getOperationMetaData()

Get the OperationMetaData for the given operation name If it does not exist, it will be created

getOperationMetaData

public OperationMetaData getOperationMetaData(QName opName)

getEndpointMetaData

public EndpointMetaData getEndpointMetaData()

Description copied from interface: EndpointMetadataProvider

Get the endpoint meta data for this stub/dispatch

Specified by:

getEndpointMetaData in interface EndpointMetadataProvider

callRequestHandlerChain

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

callResponseHandlerChain

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

callFaultHandlerChain

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

closeHandlerChain

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

setInboundContextProperties

protected abstract void setInboundContextProperties()

setOutboundContextProperties

protected abstract void setOutboundContextProperties()

shouldMaintainSession

protected abstract boolean shouldMaintainSession()

createEndpointInvocation

protected EndpointInvocation createEndpointInvocation(OperationMetaData opMetaData)

invoke

protected Object invoke(QName opName,
            Object[] inputParams,
            boolean forceOneway)
                 throws Exception

Call invokation goes as follows: 1) synchronize the operation name with the operation meta data 2) synchronize the input parameters with the operation meta data 3) generate the payload using a BindingProvider 4) get the Invoker from Remoting, based on the target endpoint address 5) do the invocation through the Remoting framework 6) unwrap the result using the BindingProvider 7) return the result

Throws:

Exception

addSessionInfo

protected void addSessionInfo(SOAPMessage reqMessage,
                  Map<String,Object> callProperties)

addAttachmentParts

protected void addAttachmentParts(SOAPMessage reqMessage)

processPivot

protected abstract CommonMessageContext processPivot(CommonMessageContext requestContext)

getCommonBindingProvider

protected abstract CommonBindingProvider getCommonBindingProvider()

getRequestContext

protected abstract Map<String,Object> getRequestContext()

addAttachmentPart

public void addAttachmentPart(AttachmentPart part)

Adds the given AttachmentPart object to the outgoing SOAPMessage. An AttachmentPart object must be created before it can be added to a message.

Specified by:

addAttachmentPart in interface StubExt

clearAttachmentParts

public void clearAttachmentParts()

Clears the list of attachment parts.

Specified by:

clearAttachmentParts in interface StubExt

createAttachmentPart

public AttachmentPart createAttachmentPart()

Creates a new empty AttachmentPart object.

Specified by:

createAttachmentPart in interface StubExt