org.ws4d.java.message
Class SOAPHeader

java.lang.Object
  extended by org.ws4d.java.types.UnknownDataContainer
      extended by org.ws4d.java.message.SOAPHeader

public class SOAPHeader
extends UnknownDataContainer


Constructor Summary
SOAPHeader(java.lang.String communicatonManagerID)
           
 
Method Summary
static SOAPHeader createHeader(java.lang.String action, java.lang.String communicatonManagerID)
          Returns a new SOAP header having only set its action property to an AttributedURI constructed from the specified String action.
static SOAPHeader createRequestHeader(java.lang.String action, java.lang.String communicatonManagerID)
          Returns a new SOAP header having set its action property to an AttributedURI constructed from the specified String action.
 boolean equals(java.lang.Object obj)
           
 AttributedURI getAction()
           
 AppSequence getAppSequence()
           
 java.lang.String getCommunicationManagerID()
           
 int getDPWSMessageType()
           
 AttributedURI getMessageId()
           
 ProtocolInfo getProtocolInfo()
           
 ReferenceParametersMData getReferenceParameters()
           
 AttributedURI getRelatesTo()
           
 EndpointReference getReplyTo()
           
 byte[] getSignature()
           
 AttributedURI getTo()
           
 java.lang.String getWseIdentifier()
           
 int hashCode()
           
 boolean isValidated()
           
 void setAction(AttributedURI action)
           
 void setAppSequence(AppSequence appSequence)
           
 void setEndpointReference(EndpointReference ref)
          Sets the to header property to the value of the address property of the specified endpoint reference and copies any contained reference parameters into this SOAP header instance (see getReferenceParameters()).
 void setMessageId(AttributedURI messageId)
           
 void setProtocolInfo(ProtocolInfo info)
           
 void setReferenceParameters(ReferenceParametersMData data)
           
 void setRelatesTo(AttributedURI relatesTo)
           
 void setReplyTo(EndpointReference replyTo)
           
 void setResponseTo(SOAPHeader requestHeader)
          Sets the [relationship], [to] and [parameters] properties of this SOAP header to the values of the [message ID] and [reply to] properties of the passed in request SOAP header.
 void setSignature(byte[] sig)
           
 void setTo(AttributedURI to)
           
 void setValidated(boolean valid)
           
 void setWseIdentifier(java.lang.String wseIdentifier)
           
 java.lang.String toString()
           
 
Methods inherited from class org.ws4d.java.types.UnknownDataContainer
addUnknownAttribute, addUnknownElement, getUnknownAttribute, getUnknownAttributes, getUnknownElement, getUnknownElements, getUnknownElements, setUnknownAttributes, setUnknownElements
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SOAPHeader

public SOAPHeader(java.lang.String communicatonManagerID)
Method Detail

createHeader

public static SOAPHeader createHeader(java.lang.String action,
                                      java.lang.String communicatonManagerID)
Returns a new SOAP header having only set its action property to an AttributedURI constructed from the specified String action. Any other fields are empty.

Parameters:
action - the action to set
Returns:
the newly created SOAP header

createRequestHeader

public static SOAPHeader createRequestHeader(java.lang.String action,
                                             java.lang.String communicatonManagerID)
Returns a new SOAP header having set its action property to an AttributedURI constructed from the specified String action. Additionally, the header's message ID property is set to a new randomly and uniquely generated UUID URN. Any other fields are empty.

Parameters:
action - the action to set
Returns:
the newly created SOAP header including a message ID
See Also:
#createHeader(String)

toString

public java.lang.String toString()
Overrides:
toString in class UnknownDataContainer

setResponseTo

public void setResponseTo(SOAPHeader requestHeader)
Sets the [relationship], [to] and [parameters] properties of this SOAP header to the values of the [message ID] and [reply to] properties of the passed in request SOAP header.

Parameters:
requestHeader - the SOAP header to extract the source properties from

setSignature

public void setSignature(byte[] sig)

getSignature

public byte[] getSignature()

setValidated

public void setValidated(boolean valid)

isValidated

public boolean isValidated()

getAction

public AttributedURI getAction()

getAppSequence

public AppSequence getAppSequence()

getMessageId

public AttributedURI getMessageId()

getProtocolInfo

public ProtocolInfo getProtocolInfo()

getRelatesTo

public AttributedURI getRelatesTo()

getReplyTo

public EndpointReference getReplyTo()

getTo

public AttributedURI getTo()

getWseIdentifier

public java.lang.String getWseIdentifier()

getDPWSMessageType

public int getDPWSMessageType()

getReferenceParameters

public ReferenceParametersMData getReferenceParameters()

setEndpointReference

public void setEndpointReference(EndpointReference ref)
Sets the to header property to the value of the address property of the specified endpoint reference and copies any contained reference parameters into this SOAP header instance (see getReferenceParameters()).

Parameters:
ref - the endpoint reference to set

setAction

public void setAction(AttributedURI action)
Parameters:
action - the action to set

setMessageId

public void setMessageId(AttributedURI messageId)
Parameters:
messageId - the messageId to set

setRelatesTo

public void setRelatesTo(AttributedURI relatesTo)
Parameters:
relatesTo - the relatesTo to set

setReplyTo

public void setReplyTo(EndpointReference replyTo)
Parameters:
replyTo - the replyTo to set

setTo

public void setTo(AttributedURI to)
Parameters:
to - the to to set

setAppSequence

public void setAppSequence(AppSequence appSequence)
Parameters:
appSequence - the appSequence to set

setWseIdentifier

public void setWseIdentifier(java.lang.String wseIdentifier)
Parameters:
wseIdentifier - the wseIdentifier to set

setProtocolInfo

public void setProtocolInfo(ProtocolInfo info)

setReferenceParameters

public void setReferenceParameters(ReferenceParametersMData data)

getCommunicationManagerID

public java.lang.String getCommunicationManagerID()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object