javax.xml.ws.addressing
Interface AddressingProperties

All Superinterfaces:
AddressingType, java.util.Map<javax.xml.namespace.QName,AddressingType>
All Known Subinterfaces:
SOAPAddressingProperties

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

This class is an abstraction of the Message Addressing Properties defined in WS-Addressing specification.

Each instance is associated with a particular WS-Addressing schema whose namespace URI is returned by its getNamespaceURI 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 getNamespaceURI) method must match the WS-Addressing version associated with the AddressingProperties.

A new instance of AddressingProperties is created as:

 AddressingBuilder.newInstance().newAddressingProperties();

Version:
JAX-WSA 1.0
Author:
JAX-WSA Development Team

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Method Summary
 AttributedURI getAction()
          The accessor for the Action property.
 EndpointReference getFaultTo()
          The accessor for the FaultTo property.
 EndpointReference getFrom()
          The accessor for the From property.
 AttributedURI getMessageID()
          The 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()
          The accessor for the RelatesTo property.
 EndpointReference getReplyTo()
          The accessor for the ReplyTo property.
 AttributedURI getTo()
          The accessor for the To property.
 void initializeAsDestination(EndpointReference source)
          Initializes this AddressingProperties as a destination using the given EndpointReference as a source.
 void initializeAsFault(AddressingProperties source)
          Initialize this AddressingProperties as a fault reply to the given message as described in the WS-Addressing Core specification.
 void initializeAsReply(AddressingProperties source)
          Initialize this AddressingProperties as a normal reply to the given message as described in the WS-Addressing Core specification.
 void setAction(AttributedURI iri)
          The mutator for the Action property.
 void setAction(java.lang.String iri)
          The mutator for the Action property.
 void setFaultTo(EndpointReference ref)
          The mutator for the FaultTo property.
 void setFaultTo(java.lang.String ref)
          The mutator for the FaultTo property.
 void setFrom(EndpointReference ref)
          The mutator for the From property.
 void setFrom(java.lang.String ref)
          The mutator for the From property.
 void setMessageID(AttributedURI iri)
          The mutator for the MessageID property.
 void setMessageID(java.lang.String iri)
          The mutator for the MessageID property.
 void setRelatesTo(Relationship[] relationship)
          The mutator for the RelatatesTo property.
 void setReplyTo(EndpointReference ref)
          The mutator for the ReplyTo property.
 void setReplyTo(java.lang.String address)
          The mutator for the ReplyTo property.
 void setTo(AttributedURI iri)
          The mutator for the To property.
 void setTo(java.lang.String iri)
          The 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()
The accessor for the To property.

Returns:
The value of the property.

setTo

void setTo(AttributedURI iri)
The mutator for the To property.

Parameters:
iri - The new value of the property.

setTo

void setTo(java.lang.String iri)
The mutator for the To property.

Parameters:
iri - The new value of the property.

getAction

AttributedURI getAction()
The accessor for the Action property.

Returns:
The value of the property.

setAction

void setAction(AttributedURI iri)
The mutator for the Action property.

Parameters:
iri - The new value of the property.

setAction

void setAction(java.lang.String iri)
The mutator for the Action property.

Parameters:
iri - The new value of the property.

getMessageID

AttributedURI getMessageID()
The accessor for the MessageID property.

Returns:
The value of the property.

setMessageID

void setMessageID(AttributedURI iri)
The mutator for the MessageID property.

Parameters:
iri - The new value of the property.

setMessageID

void setMessageID(java.lang.String iri)
The mutator for the MessageID property.

Parameters:
iri - The new value of the property.

getRelatesTo

Relationship[] getRelatesTo()
The accessor for the RelatesTo property.

Returns:
The value of the property.

setRelatesTo

void setRelatesTo(Relationship[] relationship)
The mutator for the RelatatesTo property.

Parameters:
relationship - The new value of the property.

getReplyTo

EndpointReference getReplyTo()
The accessor for the ReplyTo property.

Returns:
The value of the property.

setReplyTo

void setReplyTo(EndpointReference ref)
The mutator for the ReplyTo property.

Parameters:
ref - The new value of the property.

setReplyTo

void setReplyTo(java.lang.String address)
The mutator for the ReplyTo property.

Parameters:
address - The address of the EndpointReference.

getFaultTo

EndpointReference getFaultTo()
The accessor for the FaultTo property.

Returns:
The value of the property.

setFaultTo

void setFaultTo(EndpointReference ref)
The mutator for the FaultTo property.

Parameters:
ref - The new value of the property.

setFaultTo

void setFaultTo(java.lang.String ref)
The mutator for the FaultTo property.

Parameters:
ref - The address of the EndpointReference.

getFrom

EndpointReference getFrom()
The accessor for the From property.

Returns:
The value of the property.

setFrom

void setFrom(EndpointReference ref)
The mutator for the From property.

Parameters:
ref - The new value of the property.

setFrom

void setFrom(java.lang.String ref)
The mutator for the From property.

Parameters:
ref - The address of the EndpointReference.

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 source)
Initializes this AddressingProperties as a destination using the given EndpointReference as a source.

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:
source - the EndpointReference representing the source.

initializeAsReply

void initializeAsReply(AddressingProperties source)
Initialize this AddressingProperties as a normal reply to the given message as described in the WS-Addressing Core specification.

The ReplyTo, ReferenceParameters from ReplyTo, and MessageID property from the source are used to initialize the Address, ReferenceParameters and RelatesTo property respectively of the destination.

Parameters:
source - the source AddressingProperties
Throws:
MapRequiredException - if MessageID or ReplyTo property is missing.

initializeAsFault

void initializeAsFault(AddressingProperties source)
Initialize this AddressingProperties as a fault reply to the given message as described in the WS-Addressing Core specification.

The FaultTo, ReferenceParameters from FaultTo, and MessageID property from source are used to initialize the Address, ReferenceParameters and RelatesTo property respectively of the destination. ReplyTo property is used if FaultTo property is missing.

Parameters:
source - the source AddressingProperties
Throws:
MapRequiredException - if MessageID or ReplyTo, if applicable, property is missing.


Copyright © 2005 Sun Microsystems, Inc. All Rights Reserved.