com.pushtotest.tool.protocolhandler
Class SOAPHeader

java.lang.Object
  com.pushtotest.tool.protocolhandler.HeaderWrapper
      com.pushtotest.tool.protocolhandler.SOAPHeader

All Implemented Interfaces:

Header

public class SOAPHeader
extends HeaderWrapper

This is an interface that should be implemented to allow Protocol specific setting of the headers of a request.

Field Summary

protected java.util.Map

headerNameSpaces

Fields inherited from class com.pushtotest.tool.protocolhandler.HeaderWrapper

headers

Constructor Summary

SOAPHeader()

Method Summary

org.jdom.Document	getDocument() Returns an XML document, if one was previously set otherwise returns null.
java.util.Map	getHeaderNameSpaces()
org.jdom.Document	getJDOMDocument() Returns an XML document in org.jdom.Document object form if one was previously set otherwise returns null.
java.lang.String	getNameSpace(java.lang.String name) Returns the namespace of a single header variable as a String.
java.lang.String	getXMLDocument() Returns an XML document in a String, if one was previously set otherwise returns null.
java.lang.String	id() Returns an id for this protocol.
void	set(java.lang.String name, java.lang.String value, java.lang.String nameSpace) Set the name space for this header
void	setDocument(org.jdom.Document thedoc) Takes an entire XML request document stored in a JDOM Document object for this SOAP call.
void	setDocument(java.lang.String thedoc) Takes an entire XML request document stored in a string for this SOAP call.
void	setHeaderNameSpaces(java.util.Map headerNameSpaces)
void	setNameSpace(java.lang.String name, java.lang.String nameSpace)
java.lang.String	toString() Returns the content of the header to be used by the Protocol.

Methods inherited from class com.pushtotest.tool.protocolhandler.HeaderWrapper

get, getHeaders, set, set

Methods inherited from class java.lang.Object

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

Field Detail

headerNameSpaces

protected java.util.Map headerNameSpaces

Constructor Detail

SOAPHeader

public SOAPHeader()

Method Detail

setDocument

public void setDocument(org.jdom.Document thedoc)

Takes an entire XML request document stored in a JDOM Document object for this SOAP call. When this method is used then Tool uses a document-style SOAP request. See http://www.jdom.org for details on JDOM.

Parameters:

org.jdom.Document - document

setDocument

public void setDocument(java.lang.String thedoc)

Takes an entire XML request document stored in a string for this SOAP call. When this method is used then Tool uses a document-style SOAP request.

getDocument

public org.jdom.Document getDocument()

Returns an XML document, if one was previously set otherwise returns null.

Returns:

org.jdom.Document document

getJDOMDocument

public org.jdom.Document getJDOMDocument()

Returns an XML document in org.jdom.Document object form if one was previously set otherwise returns null.

Returns:

org.jdom.Document document

getXMLDocument

public java.lang.String getXMLDocument()

Returns an XML document in a String, if one was previously set otherwise returns null.

Returns:

String document

id

public java.lang.String id()

Returns an id for this protocol. The id is a string that will be used to uniquily identify the protocol. For example :// would be appropriate (without the "://").

Specified by:

id in interface Header

Specified by:

id in class HeaderWrapper

Returns:

The id for this Protocol.

toString

public java.lang.String toString()

Returns the content of the header to be used by the Protocol.

Specified by:

toString in interface Header

Specified by:

toString in class HeaderWrapper

Returns:

All of the content that should be sent as the Protocol header.

set

public void set(java.lang.String name,
                java.lang.String value,
                java.lang.String nameSpace)

Set the name space for this header

Parameters:

name -

value -

nameSpace -

getNameSpace

public java.lang.String getNameSpace(java.lang.String name)

Returns the namespace of a single header variable as a String.

Parameters:

name - The name of the header variable to look for.

getHeaderNameSpaces

public java.util.Map getHeaderNameSpaces()

Returns:

Returns the headerNameSpaces.

setHeaderNameSpaces

public void setHeaderNameSpaces(java.util.Map headerNameSpaces)

Parameters:

headerNameSpaces - The headerNameSpaces to set.

setNameSpace

public void setNameSpace(java.lang.String name,
                         java.lang.String nameSpace)