javax.xml.ws.addressing
Interface AddressingProperties

All Superinterfaces:

AddressingType, java.util.Map<QName,AddressingType>

All Known Subinterfaces:

SOAPAddressingProperties

public interface AddressingProperties
extends AddressingType, java.util.Map<QName,AddressingType>

Abstraction of Message Addressing Properties.

Each instance is associated with a particular WS-Addressing schema whose namespace URI is returned by its getAddressingVersion method.

The namespace of each key in the underlying map must match this URI and the local names of all the keys must be exactly the names of the Message Addressing Properties defined in that version of the WS-Addressing specification.

Each value in the underlying type must be an instance of AddressingType whose WS-Addressing version (determined by its getAddressingVersion) method must match the WS-Addressing version associated with the AddressingProperties.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

AttributedURI	getAction() Accessor for the Action property.
EndpointReference	getFaultTo() Accessor for the FaultTo property.
EndpointReference	getFrom() Accessor for the From property.
AttributedURI	getMessageID() Accessor for the MessageID property.
ReferenceParameters	getReferenceParameters() Returns a reference to the value of the ReferenceParameters property of an EndpointReference used to initialize this AddressingProperties.
Relationship[]	getRelatesTo() Accessor for the RelatesTo property.
EndpointReference	getReplyTo() Accessor for the ReplyTo property.
AttributedURI	getTo() Accessor for the To property.
void	initializeAsDestination(EndpointReference ref) Initializes the properties as a destination using the given EndpointReference.
void	initializeAsReply(AddressingProperties props, boolean isFault) Initialize this AddressingProperties as a reply to the given message.
void	setAction(AttributedURI iri) Mutator for the Action property.
void	setFaultTo(EndpointReference ref) Mutator for the FaultTo property.
void	setFrom(EndpointReference ref) Mutator for the From property.
void	setMessageID(AttributedURI iri) Mutator for the MessageID property.
void	setRelatesTo(Relationship[] relationship) Mutator for the RelatatesTo property.
void	setReplyTo(EndpointReference ref) Mutator for the ReplyTo property.
void	setTo(AttributedURI iri) Mutator for the To property.

Methods inherited from interface javax.xml.ws.addressing.AddressingType

getNamespaceURI

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getTo

AttributedURI getTo()

Accessor for the To property.

Returns:

The value of the property.

setTo

void setTo(AttributedURI iri)

Mutator for the To property.

Parameters:

iri - The new value of the property.

getAction

AttributedURI getAction()

Accessor for the Action property.

Returns:

The value of the property.

setAction

void setAction(AttributedURI iri)

Mutator for the Action property.

Parameters:

iri - The new value of the property.

getMessageID

AttributedURI getMessageID()

Accessor for the MessageID property.

Returns:

The value of the property.

setMessageID

void setMessageID(AttributedURI iri)

Mutator for the MessageID property.

Parameters:

iri - The new value of the property.

getRelatesTo

Relationship[] getRelatesTo()

Accessor for the RelatesTo property.

Returns:

The value of the property.

setRelatesTo

void setRelatesTo(Relationship[] relationship)

Mutator for the RelatatesTo property.

Parameters:

relationship - The new value of the property.

getReplyTo

EndpointReference getReplyTo()

Accessor for the ReplyTo property.

Returns:

The value of the property.

setReplyTo

void setReplyTo(EndpointReference ref)

Mutator for the ReplyTo property.

Parameters:

ref - The new value of the property.

getFaultTo

EndpointReference getFaultTo()

Accessor for the FaultTo property.

Returns:

The value of the property.

setFaultTo

void setFaultTo(EndpointReference ref)

Mutator for the FaultTo property.

Parameters:

ref - The new value of the property.

getFrom

EndpointReference getFrom()

Accessor for the From property.

Returns:

The value of the property.

setFrom

void setFrom(EndpointReference ref)

Mutator for the From property.

Parameters:

ref - The new value of the property.

getReferenceParameters

ReferenceParameters getReferenceParameters()

Returns a reference to the value of the ReferenceParameters property of an EndpointReference used to initialize this AddressingProperties. There will be such an EndpointReference when the initializeAsDestination method or the initializeAsReply method is used.

Returns:

The ReferenceParameters property value.

initializeAsDestination

void initializeAsDestination(EndpointReference ref)

Initializes the properties as a destination using the given EndpointReference. The To property is initialized using the Address property of the EndpointReference and the ReferenceParameters property is initialized using the ReferenceParameters property of the EndpointReference.

Parameters:

ref - The EndpointReference representing the destination.

initializeAsReply

void initializeAsReply(AddressingProperties props,
                       boolean isFault)

Initialize this AddressingProperties as a reply to the given message. As described in the WS-Addressing Core specification. The ReplyTo property is using the Address property of the source AddressingProperties and the ReferenceParameters property is initialized using the ReferenceParameters property of the source message.

Parameters:

props - The source AddressingProperties isFault true if the reply is a Fault message. false if the reply is not a Fault message.

Throws:

AddressingException - if an error occurs.