com.soa.soap.message

Class SOAPExchange

java.lang.Object

com.soa.message.AbstractExchange

com.soa.soap.message.SOAPExchange

All Implemented Interfaces:

Exchange

public class SOAPExchange
extends AbstractExchange

Implementation of AbstractExchange for SOAP message exchanges.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DOCUMENT_STYLE Document SOAP style - "document"
static java.lang.String	ENCODED_USE Encoded SOAP use - "encoded"
static java.lang.String	LITERAL_USE Literal SOAP use - "literal"
static java.lang.String	RPC_STYLE RPC SOAP style - "rpc"
static java.lang.String	UNKNOWN_STYLE Unknown style
static java.lang.String	UNKNOWN_USE Unknown SOAP use

Fields inherited from interface com.soa.message.Exchange

ACTIVE, DONE, ERROR, IN_ONLY, IN_OPTIONAL_OUT, IN_OUT, OUT_ONLY

Constructor Summary

Constructors

Constructor and Description
SOAPExchange(SOAPMessageFactory factory) Creates the SOAPExchange.
SOAPExchange(SOAPMessageFactory factory, SOAPVersion version) Creates the SOAPExchange of the specified SOAP version.

Method Summary

Modifier and Type	Method and Description
SOAPMessage	createFault(FaultInformation faultInfo, javax.xml.transform.Source detail) Creates a SOAP fault from the given content.
protected Message	createMessage() Creates a message using the version of the exchange.
java.lang.String	getStyle() Returns the style of the exchange which is dictated by the SOAP binding.
java.lang.String	getUse() Returns the use of the exchange which is dictated by the SOAP binding.
SOAPVersion	getVersion() Returns the SOAP version of the exchange.
void	setFactory(SOAPMessageFactory factory) Configures the SOAPMessageFactory used to create SOAP messages.
void	setMessage(SOAPMessage msg, ParameterType pType) Adds a SOAP message to the exchange.
void	setStyle(java.lang.String style) Configures the style of the exchange which is dictated by the SOAP binding.
void	setUse(java.lang.String use) Configures the use of the exchange which is dictated by the SOAP binding.
void	setVersion(SOAPVersion version) Configures the SOAP version of the exchange.

Methods inherited from class com.soa.message.AbstractExchange

addPart, arePartsEmpty, clearMessage, createMessage, getAuditLogger, getBinding, getEndpoint, getEndpointName, getError, getExchangeID, getFaultEndpoint, getFaultMessage, getInMessage, getInterfaceName, getOperationName, getOutMessage, getPart, getPartNames, getParts, getPattern, getProperties, getProperty, getPropertyNames, getResponseEndpoint, getServiceName, getStatus, isAsync, setAsync, setAuditLogger, setBinding, setEndpoint, setEndpointName, setError, setExchangeID, setFaultEndpoint, setFaultMessage, setInMessage, setInterfaceName, setMessage, setMessageImpl, setOperationName, setOutMessage, setPattern, setProperties, setProperty, setResponseEndpoint, setServiceName, setStatus

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENT_STYLE

public static final java.lang.String DOCUMENT_STYLE

Document SOAP style - "document"

See Also:

Constant Field Values

RPC_STYLE

public static final java.lang.String RPC_STYLE

RPC SOAP style - "rpc"

See Also:

Constant Field Values

UNKNOWN_STYLE

public static final java.lang.String UNKNOWN_STYLE

Unknown style

See Also:

Constant Field Values

LITERAL_USE

public static final java.lang.String LITERAL_USE

Literal SOAP use - "literal"

See Also:

Constant Field Values

ENCODED_USE

public static final java.lang.String ENCODED_USE

Encoded SOAP use - "encoded"

See Also:

Constant Field Values

UNKNOWN_USE

public static final java.lang.String UNKNOWN_USE

Unknown SOAP use

See Also:

Constant Field Values

Constructor Detail

SOAPExchange

public SOAPExchange(SOAPMessageFactory factory,
                    SOAPVersion version)

Creates the SOAPExchange of the specified SOAP version. Specifying the SOAP version of the exchange is optimal because it precludes the need to parse messages with pre-existing content to determine their version.

Parameters:

factory - SOAPMessageFactory used to create messages in the exchange.

version - SOAPVersion of the exchange.

SOAPExchange

public SOAPExchange(SOAPMessageFactory factory)

Creates the SOAPExchange. Since there is no specified version, the version of the exchange will be determined by the INPUT message.

Parameters:

factory - SOAPMessageFactory used to create messages in the exchange.

Method Detail

setFactory

public void setFactory(SOAPMessageFactory factory)

Configures the SOAPMessageFactory used to create SOAP messages.

Parameters:

factory - SOAPMessageFactory used to create SOAP messages.

getVersion

public SOAPVersion getVersion()
                       throws GException

Returns the SOAP version of the exchange.

Returns:

SOAPVersion of the exchange. If the exchange was not created with a version and there is no INPUT message with a known version, the version will be null.

Throws:

GException - TODO

getStyle

public java.lang.String getStyle()

Returns the style of the exchange which is dictated by the SOAP binding.

Returns:

Style of the exchange, see DOCUMENT_STYLE and RPC_STYLE.

setStyle

public void setStyle(java.lang.String style)

Configures the style of the exchange which is dictated by the SOAP binding.

Parameters:

style - Style of the exchange, see DOCUMENT_STYLE and RPC_STYLE.

getUse

public java.lang.String getUse()

Returns the use of the exchange which is dictated by the SOAP binding.

Returns:

Use of the exchange, see LITERAL_USE and ENCODED_USE.

setUse

public void setUse(java.lang.String use)

Configures the use of the exchange which is dictated by the SOAP binding.

Parameters:

use - Use of the exchange, see LITERAL_USE and ENCODED_USE.

setVersion

public void setVersion(SOAPVersion version)

Configures the SOAP version of the exchange. Specifying the SOAP version of the exchange is optimal because it precludes the need to parse messages with pre-existing content to determine their version.

Parameters:

version - SOAPVersion of the exchange.

createFault

public SOAPMessage createFault(FaultInformation faultInfo,
                               javax.xml.transform.Source detail)
                        throws GException

Creates a SOAP fault from the given content. Since no version is specified in this signature, the default version (1.1) is used.

Parameters:

faultInfo - FaultInformation holding core fault parameters. Required.

detail - Source holding application fault information. Optional.

Returns:

SOAPMessage with the fault.

Throws:

GException - Thrown if unable to create the fault. Most likely caused by the absence of a fault code or an invalid detail.

setMessage

public void setMessage(SOAPMessage msg,
                       ParameterType pType)
                throws GException

Adds a SOAP message to the exchange.

Parameters:

msg - SOAPMessage to add to the exchange.

pType - ParameterType of the message being added to the exchange.

Throws:

GException - Thrown if unable to add the message to the exchange.

createMessage

protected Message createMessage()
                         throws GException

Creates a message using the version of the exchange.

Specified by:

createMessage in class AbstractExchange

Returns:

Created Message.

Throws:

GException - Thrown if unable to create the message.