org.apache.axis.message.addressing
Class AddressingHeaders

java.lang.Object
  org.apache.axis.message.addressing.AddressingHeaders

public class AddressingHeaders

extends java.lang.Object

Represents a set of message addressing headers as defined by the WS-Addressing spec.

Author:

Davanum Srinivas (dims@yahoo.com)

Constructor Summary

AddressingHeaders()
Constructor AddressingHeaders

AddressingHeaders(EndpointReference epr)

AddressingHeaders(javax.xml.soap.SOAPEnvelope env)
Constructor AddressingHeaders

AddressingHeaders(javax.xml.soap.SOAPEnvelope env, boolean process, boolean remove)
Constructor AddressingHeaders

AddressingHeaders(javax.xml.soap.SOAPEnvelope env, java.lang.String actorURI, boolean process, boolean remove)
Constructor AddressingHeaders

AddressingHeaders(javax.xml.soap.SOAPEnvelope env, java.lang.String actorURI, boolean process, boolean remove, boolean setMustUnderstand, java.util.List refPropsQNames)
Constructor AddressingHeaders.

Method Summary

void	addReferenceProperty(org.w3c.dom.Element refProp) Method addReferenceProperty : Adds an XML element to the referencePropeties collection
void	addReferenceProperty(org.apache.axis.message.MessageElement refProp)
void	addRelatesTo(java.lang.String uri, javax.xml.namespace.QName type) Method addRelatesTo
Action	getAction() Method getAction
EndpointReference	getFaultTo() Method getFaultTo
EndpointReference	getFrom() Method getFrom
MessageID	getMessageID() Method getMessageID
java.lang.String	getNamespaceURI() Returns the WSA namespace URI used in this set of headers.
ReferencePropertiesType	getReferenceProperties() Method getReferenceProperties
java.util.List	getRelatesTo() Method getRelatesTo
EndpointReference	getReplyTo() Method getReplyTo
To	getTo() Method getTo
boolean	isSetMustUnderstand()
void	setAction(Action action) Method setAction
void	setAction(java.lang.String uri)
void	setFaultTo(EndpointReference epr) Method setFaultTo
void	setFrom(EndpointReference ref) Method setFrom
void	setMessageID(MessageID messageID) Method setMessageID
void	setReferenceProperties(ReferencePropertiesType refProps) Method setReferenceProperties
void	setRelatesTo(java.util.List v) Set the collection of RelatesToProperties.
void	setReplyTo(EndpointReference ref) Method setReplyTo
void	setSetMustUnderstand(boolean setMustUnderstand)
void	setTo(AttributedURI uri) Method setTo
void	setTo(To to) Method setTo
void	toEnvelope(javax.xml.soap.SOAPEnvelope env) Adds these addressing headers to the specified SOAP envelope.
void	toEnvelope(javax.xml.soap.SOAPEnvelope env, java.lang.String actorURI) Adds these addressing headers to the specified SOAP envelope.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddressingHeaders

public AddressingHeaders()

Constructor AddressingHeaders

AddressingHeaders

public AddressingHeaders(EndpointReference epr)

AddressingHeaders

public AddressingHeaders(javax.xml.soap.SOAPEnvelope env)
                  throws java.lang.Exception

Constructor AddressingHeaders

Parameters:

env -

Throws:

java.lang.Exception

AddressingHeaders

public AddressingHeaders(javax.xml.soap.SOAPEnvelope env,
                         boolean process,
                         boolean remove)
                  throws java.lang.Exception

Constructor AddressingHeaders

Parameters:

env -

process -

remove -

Throws:

java.lang.Exception

AddressingHeaders

public AddressingHeaders(javax.xml.soap.SOAPEnvelope env,
                         java.lang.String actorURI,
                         boolean process,
                         boolean remove)
                  throws java.lang.Exception

Constructor AddressingHeaders

Parameters:

env -

actorURI -

process -

Throws:

java.lang.Exception

AddressingHeaders

public AddressingHeaders(javax.xml.soap.SOAPEnvelope env,
                         java.lang.String actorURI,
                         boolean process,
                         boolean remove,
                         boolean setMustUnderstand,
                         java.util.List refPropsQNames)
                  throws java.lang.Exception

Constructor AddressingHeaders.

Parameters:

env - The SOAP Envelope

actorURI - The SOAP Actor URI

process - Should the headers be marked as processed

remove - Should the headers be removed after processing

setMustUnderstand - whether or not to set mustUnderstand="true" on the headers

refPropsQNames - A list of QNames for reference properties. If null all non-WSA headers will be added as reference properties. If an empty list is passed than no headers will be added reference properties (default). If non empty list of qnames is passed then only headers matching the qname in the list will be added as reference properties.

Throws:

java.lang.Exception

Method Detail

getNamespaceURI

public java.lang.String getNamespaceURI()

Returns the WSA namespace URI used in this set of headers.

Returns:

the WSA namespace URI used in this set of headers

getAction

public Action getAction()

Method getAction

Returns:

setAction

public void setAction(Action action)

Method setAction

Parameters:

action -

setAction

public void setAction(java.lang.String uri)
               throws java.lang.Exception

Throws:

java.lang.Exception

getTo

public To getTo()

Method getTo

Returns:

setTo

public void setTo(To to)

Method setTo

Parameters:

to -

setMessageID

public void setMessageID(MessageID messageID)

Method setMessageID

Parameters:

messageID -

setReferenceProperties

public void setReferenceProperties(ReferencePropertiesType refProps)

Method setReferenceProperties

Parameters:

refProps -

getReferenceProperties

public ReferencePropertiesType getReferenceProperties()

Method getReferenceProperties

Returns:

referenceProperties

addReferenceProperty

public void addReferenceProperty(org.w3c.dom.Element refProp)

Method addReferenceProperty : Adds an XML element to the referencePropeties collection

Parameters:

refProp -

addReferenceProperty

public void addReferenceProperty(org.apache.axis.message.MessageElement refProp)

toEnvelope

public void toEnvelope(javax.xml.soap.SOAPEnvelope env)
                throws java.lang.Exception

Adds these addressing headers to the specified SOAP envelope.

Parameters:

env -

Throws:

java.lang.Exception

toEnvelope

public void toEnvelope(javax.xml.soap.SOAPEnvelope env,
                       java.lang.String actorURI)
                throws java.lang.Exception

Adds these addressing headers to the specified SOAP envelope.

Parameters:

env -

Throws:

javax.xml.soap.SOAPException

javax.xml.parsers.ParserConfigurationException

java.lang.Exception

getMessageID

public MessageID getMessageID()

Method getMessageID

Returns:

getRelatesTo

public java.util.List getRelatesTo()

Method getRelatesTo

Returns:

setRelatesTo

public void setRelatesTo(java.util.List v)

Set the collection of RelatesToProperties. Not additive, this replaces the current collection.

Parameters:

v - Vector of RelatesToProperties

addRelatesTo

public void addRelatesTo(java.lang.String uri,
                         javax.xml.namespace.QName type)
                  throws org.apache.axis.types.URI.MalformedURIException

Method addRelatesTo

Parameters:

uri -

type -

Throws:

URI.MalformedURIException

setTo

public void setTo(AttributedURI uri)

Method setTo

Parameters:

uri -

getFrom

public EndpointReference getFrom()

Method getFrom

Returns:

setFrom

public void setFrom(EndpointReference ref)

Method setFrom

Parameters:

ref -

getReplyTo

public EndpointReference getReplyTo()

Method getReplyTo

Returns:

setReplyTo

public void setReplyTo(EndpointReference ref)

Method setReplyTo

Parameters:

ref -

getFaultTo

public EndpointReference getFaultTo()

Method getFaultTo

Returns:

setFaultTo

public void setFaultTo(EndpointReference epr)

Method setFaultTo

Parameters:

epr -

isSetMustUnderstand

public boolean isSetMustUnderstand()

setSetMustUnderstand

public void setSetMustUnderstand(boolean setMustUnderstand)