org.jboss.ws.core

Class CommonSOAPBinding

java.lang.Object

org.jboss.ws.core.CommonSOAPBinding

All Implemented Interfaces:

CommonBinding

Direct Known Subclasses:

CommonSOAP11Binding, CommonSOAP12Binding

public abstract class CommonSOAPBinding
extends Object
implements CommonBinding

The SOAPBinding interface is an abstraction for the SOAP binding.

Since:

04-Jul-2006

Author:

Thomas.Diesler@jboss.com

Field Summary

Fields

Modifier and Type	Field and Description
protected HeaderSource	headerSource
protected Logger	log
static String	SOAP11HTTP_BINDING A constant representing the identity of the SOAP 1.1 over HTTP binding.
static String	SOAP12HTTP_BINDING A constant representing the identity of the SOAP 1.2 over HTTP binding.

Constructor Summary

Constructors

Constructor and Description
CommonSOAPBinding() The SOAP encoded Array name

Method Summary

Methods

Modifier and Type	Method and Description
SOAPMessage	bindFaultMessage(Exception ex) bind an exception to a fault message
SOAPMessage	bindRequestMessage(OperationMetaData opMetaData, EndpointInvocation epInv) On the client side, generate the payload from IN parameters.
SOAPMessage	bindResponseMessage(OperationMetaData opMetaData, EndpointInvocation epInv) On the server side, generate the payload from OUT parameters.
void	checkMustUnderstand(OperationMetaData opMetaData)
protected abstract SOAPMessage	createFaultMessageFromException(Exception ex)
protected abstract SOAPMessage	createMessage(OperationMetaData opMetaData) Create the message
MessageFactory	getMessageFactory()
SOAPFactory	getSOAPFactory()
void	setHeaderSource(HeaderSource source)
abstract void	setSOAPActionHeader(OperationMetaData opMetaData, SOAPMessage reqMessage) Override to set the SOAPAction header
protected abstract void	throwFaultException(SOAPFaultImpl fault)
EndpointInvocation	unbindRequestMessage(OperationMetaData opMetaData, SOAPMessage payload) On the server side, extract the IN parameters from the payload and populate an Invocation object
void	unbindResponseMessage(OperationMetaData opMetaData, SOAPMessage payload, EndpointInvocation epInv) On the client side, extract the OUT parameters from the payload and return them to the client.
protected abstract void	verifyUnderstoodHeader(SOAPHeaderElement element)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected Logger log

headerSource

protected HeaderSource headerSource

SOAP11HTTP_BINDING

public static final String SOAP11HTTP_BINDING

A constant representing the identity of the SOAP 1.1 over HTTP binding.

See Also:

Constant Field Values

SOAP12HTTP_BINDING

public static final String SOAP12HTTP_BINDING

A constant representing the identity of the SOAP 1.2 over HTTP binding.

See Also:

Constant Field Values

Constructor Detail

CommonSOAPBinding

public CommonSOAPBinding()

The SOAP encoded Array name

Method Detail

getMessageFactory

public MessageFactory getMessageFactory()

getSOAPFactory

public SOAPFactory getSOAPFactory()

createMessage

protected abstract SOAPMessage createMessage(OperationMetaData opMetaData)
                                      throws SOAPException

Create the message

Throws:

SOAPException

bindRequestMessage

public SOAPMessage bindRequestMessage(OperationMetaData opMetaData,
                             EndpointInvocation epInv)
                               throws BindingException

On the client side, generate the payload from IN parameters.

Specified by:

bindRequestMessage in interface CommonBinding

Throws:

BindingException

setSOAPActionHeader

public abstract void setSOAPActionHeader(OperationMetaData opMetaData,
                       SOAPMessage reqMessage)

Override to set the SOAPAction header

unbindRequestMessage

public EndpointInvocation unbindRequestMessage(OperationMetaData opMetaData,
                                      SOAPMessage payload)
                                        throws BindingException

On the server side, extract the IN parameters from the payload and populate an Invocation object

Specified by:

unbindRequestMessage in interface CommonBinding

Throws:

BindingException

bindResponseMessage

public SOAPMessage bindResponseMessage(OperationMetaData opMetaData,
                              EndpointInvocation epInv)
                                throws BindingException

On the server side, generate the payload from OUT parameters.

Specified by:

bindResponseMessage in interface CommonBinding

Throws:

BindingException

unbindResponseMessage

public void unbindResponseMessage(OperationMetaData opMetaData,
                         SOAPMessage payload,
                         EndpointInvocation epInv)
                           throws BindingException

On the client side, extract the OUT parameters from the payload and return them to the client.

Specified by:

unbindResponseMessage in interface CommonBinding

Throws:

BindingException

bindFaultMessage

public SOAPMessage bindFaultMessage(Exception ex)

Description copied from interface: CommonBinding

bind an exception to a fault message

Specified by:

bindFaultMessage in interface CommonBinding

createFaultMessageFromException

protected abstract SOAPMessage createFaultMessageFromException(Exception ex)

throwFaultException

protected abstract void throwFaultException(SOAPFaultImpl fault)
                                     throws Exception

Throws:

Exception

verifyUnderstoodHeader

protected abstract void verifyUnderstoodHeader(SOAPHeaderElement element)
                                        throws Exception

Throws:

Exception

checkMustUnderstand

public void checkMustUnderstand(OperationMetaData opMetaData)
                         throws Exception

Throws:

Exception

setHeaderSource

public void setHeaderSource(HeaderSource source)

Specified by:

setHeaderSource in interface CommonBinding