com.wingfoot.soap
Class HeaderEntry

java.lang.Object
  |
  +--com.wingfoot.soap.SOAPElement
        |
        +--com.wingfoot.soap.HeaderEntry

public class HeaderEntry
extends SOAPElement

Encapsulates an element below the element in a SOAP message. The presence of element is optional.

Since:
0.90

Constructor Summary
HeaderEntry(java.lang.String headerName, java.lang.String headerValue)
          Constructor for HeaderEntry.
 
Method Summary
 java.lang.String getActor()
          Convenience method to return the value of the actor attribute.
 java.lang.String getHeaderName()
          Convenience method to return the header name.
 boolean getMustUnderstand()
          Convenience method for returning the mustUnderstand attribute
 java.lang.String getNamespace()
          Convenience method to return the namespace associated with the header entry.
 java.lang.String getValue()
          Returns the header value
protected  void serialize(com.wingfoot.soap.XMLWriter xmlwriter)
          Converts SOAP Headers to XML.
 void setActor(java.lang.String target)
          Convenience method for setting the actor attribute.
 void setMustUnderstand(boolean mustUnderstand)
          Convenience method for setting the mustUnderstand attribute
 void setNamespace(java.lang.String namespaceURI)
          Convenience method for setting the namespace.
 
Methods inherited from class com.wingfoot.soap.SOAPElement
addAttribute, deserialize, getAttribute, getAttributes, removeAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HeaderEntry

public HeaderEntry(java.lang.String headerName,
                   java.lang.String headerValue)
Constructor for HeaderEntry.
Parameters:
headerName - the name of the element below the element.
headerValue - the text value for the headerName.
Since:
0.90
Method Detail

getActor

public java.lang.String getActor()
Convenience method to return the value of the actor attribute.
Returns:
the value of the actor attribute; null if no actor is set.
Since:
0.90

getHeaderName

public java.lang.String getHeaderName()
Convenience method to return the header name.
Returns:
the name of the Header; null if no name is set.
Since:
0.90

getNamespace

public java.lang.String getNamespace()
Convenience method to return the namespace associated with the header entry.
Returns:
the namespace associated with the header entry; Constants.DEFAULT_NAMESPACE if no namespace is specified.
Since:
0.90

getMustUnderstand

public boolean getMustUnderstand()
Convenience method for returning the mustUnderstand attribute
Returns:
true if mustUnderstand is set to true, false if set to false or not specified at all.
Since:
0.90

getValue

public java.lang.String getValue()
Returns the header value
Returns:
the header value
Since:
0.90

setActor

public void setActor(java.lang.String target)
Convenience method for setting the actor attribute.
Parameters:
target - Target endpoint.
A target with value http://schemas.xmlsoap.org/soap/actor/next indicates that the entry is targetted to the first endpoint that finds it. A missing actor attribute indicates that the entry is targetted towards the final endpoint.
Since:
0.90

setNamespace

public void setNamespace(java.lang.String namespaceURI)
Convenience method for setting the namespace. This sets the namespace as xmlns:namespacePrefix="namespaceURI"
Parameters:
namespacePrefix - Namespace Prefix
namespaceURI - Namespace URI
Since:
0.90

setMustUnderstand

public void setMustUnderstand(boolean mustUnderstand)
Convenience method for setting the mustUnderstand attribute
Parameters:
mustUnderstand - mustUnderstand flag
Since:
0.90

serialize

protected void serialize(com.wingfoot.soap.XMLWriter xmlwriter)
Converts SOAP Headers to XML. This method is only called by Envelope when it is serializing itself.
Overrides:
serialize in class SOAPElement
Parameters:
xmlwriter - instance of XMLWriter to aid in writing the XML.
Since:
0.90


Copyright(c) Wingfoot Software (www.wingfoot.com). All Rights Reserved.

KXML is a XML parser by Lutris Technologies