org.springframework.ws.soap.addressing.version
Interface AddressingVersion

All Known Implementing Classes:

AbstractAddressingVersion, Addressing10, Addressing200408

public interface AddressingVersion

Defines the contract for a specific version of the WS-Addressing specification.

Since:

1.5.0

Author:

Arjen Poutsma

Method Summary

void	addAddressingHeaders(SoapMessage message, MessageAddressingProperties map) Adds addressing SOAP headers to the given message, using the given MessageAddressingProperties.
SoapFault	addInvalidAddressingHeaderFault(SoapMessage message) Adds a Invalid Addressing Header fault to the given message.
SoapFault	addMessageAddressingHeaderRequiredFault(SoapMessage message) Adds a Message Addressing Header Required fault to the given message.
MessageAddressingProperties	getMessageAddressingProperties(SoapMessage message) Returns the MessageAddressingProperties for the given message.
boolean	hasAnonymousAddress(EndpointReference epr) Indicates whether the given endpoint reference has a Anonymous address.
boolean	hasNoneAddress(EndpointReference epr) Indicates whether the given endpoint reference has a None address.
boolean	hasRequiredProperties(MessageAddressingProperties map) Indicates whether the given MessageAddressingProperties has all required properties.
boolean	understands(SoapHeaderElement headerElement) Given a SoapHeaderElement, return whether or not this version understands it.

Method Detail

getMessageAddressingProperties

MessageAddressingProperties getMessageAddressingProperties(SoapMessage message)

Returns the MessageAddressingProperties for the given message.

Parameters:

message - the message to find the map for

Returns:

the message addressing properties

See Also:

Message Addressing Properties

addAddressingHeaders

void addAddressingHeaders(SoapMessage message,
                          MessageAddressingProperties map)

Adds addressing SOAP headers to the given message, using the given MessageAddressingProperties.

Parameters:

message - the message to add the headers to

map - the message addressing properties

understands

boolean understands(SoapHeaderElement headerElement)

Given a SoapHeaderElement, return whether or not this version understands it.

Parameters:

headerElement - the header

Returns:

true if understood, false otherwise

hasRequiredProperties

boolean hasRequiredProperties(MessageAddressingProperties map)

Indicates whether the given MessageAddressingProperties has all required properties.

Returns:

true if the to and action properties have been set, and - if a reply or fault endpoint has been set - also checks for the message id

hasAnonymousAddress

boolean hasAnonymousAddress(EndpointReference epr)

Indicates whether the given endpoint reference has a Anonymous address. This address is used to indicate that a message should be sent in-band.

See Also:

Formulating a Reply Message

hasNoneAddress

boolean hasNoneAddress(EndpointReference epr)

Indicates whether the given endpoint reference has a None address. Messages to be sent to this address will not be sent.

See Also:

Sending a Message to an EPR

addInvalidAddressingHeaderFault

SoapFault addInvalidAddressingHeaderFault(SoapMessage message)

Adds a Invalid Addressing Header fault to the given message.

See Also:

Invalid Addressing Header

addMessageAddressingHeaderRequiredFault

SoapFault addMessageAddressingHeaderRequiredFault(SoapMessage message)

Adds a Message Addressing Header Required fault to the given message.

See Also:

Message Addressing Header Required