org.apache.axis.message
Class SOAPEnvelope

java.lang.Object
  |
  +--org.apache.axis.message.MessageElement
        |
        +--org.apache.axis.message.SOAPEnvelope

All Implemented Interfaces:

Node, SOAPElement, SOAPEnvelope

public class SOAPEnvelope

extends MessageElement

implements SOAPEnvelope

Inner classes inherited from class org.apache.axis.message.MessageElement

MessageElement.QNameAttr

Field Summary

protected static org.apache.commons.logging.Log	log
java.lang.String	messageType
java.util.Vector	trailers

Fields inherited from class org.apache.axis.message.MessageElement

_isDirty, _isRoot, attributes, context, elementRep, encodingStyle, endEventIndex, href, id, message, name, namespaces, namespaceURI, parent, prefix, qNameAttrs, recorder, startContentsIndex, startEventIndex, textRep, typeQName

Constructor Summary

SOAPEnvelope()

SOAPEnvelope(boolean registerPrefixes, SOAPConstants soapConstants)

SOAPEnvelope(java.io.InputStream input)

SOAPEnvelope(SOAPConstants soapConstants)

Method Summary

SOAPBody	addBody() Creates a SOAPBody object and sets it as the SOAPBody object for this SOAPEnvelope object.
void	addBodyElement(SOAPBodyElement element)
SOAPHeader	addHeader() Creates a SOAPHeader object and sets it as the SOAPHeader object for this SOAPEnvelope object.
void	addHeader(SOAPHeaderElement hdr)
void	addTrailer(MessageElement element)
void	clearBody()
Name	createName(java.lang.String localName) Creates a new Name object initialized with the given local name.
Name	createName(java.lang.String localName, java.lang.String prefix, java.lang.String uri) Creates a new Name object initialized with the given local name, namespace prefix, and namespace URI.
SOAPBody	getBody() Returns the SOAPBody object associated with this SOAPEnvelope object.
SOAPBodyElement	getBodyByName(java.lang.String namespace, java.lang.String localPart)
java.util.Vector	getBodyElements()
SOAPBodyElement	getFirstBody()
SOAPHeader	getHeader() Returns the SOAPHeader object for this SOAPEnvelope object.
SOAPHeaderElement	getHeaderByName(java.lang.String namespace, java.lang.String localPart) Get a header by name (always respecting the currently in-scope actors list)
SOAPHeaderElement	getHeaderByName(java.lang.String namespace, java.lang.String localPart, boolean accessAllHeaders) Get a header by name, filtering for headers targeted at this engine depending on the accessAllHeaders parameter.
java.util.Vector	getHeaders()
java.util.Vector	getHeadersByActor(java.util.ArrayList actors) Get all the headers targeted at a list of actors.
java.util.Enumeration	getHeadersByName(java.lang.String namespace, java.lang.String localPart)
java.util.Enumeration	getHeadersByName(java.lang.String namespace, java.lang.String localPart, boolean accessAllHeaders) Return an Enumeration of headers which match the given namespace and localPart.
java.lang.String	getMessageType()
java.util.Vector	getTrailers()
void	outputImpl(SerializationContext context) Should make SOAPSerializationException?
void	removeBody()
void	removeBodyElement(SOAPBodyElement element)
void	removeHeader(SOAPHeaderElement hdr)
void	removeHeaders()
void	removeTrailer(MessageElement element)
void	setBody(SOAPBody body)
void	setHeader(SOAPHeader hdr)
void	setMessageType(java.lang.String messageType)

Methods inherited from class org.apache.axis.message.MessageElement

addAttribute, addAttribute, addAttribute, addChild, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addMapping, addNamespaceDeclaration, addTextNode, detachNode, getAllAttributes, getAsDocument, getAsDOM, getAttributes, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildren, getCompleteAttributes, getElementName, getEncodingStyle, getEnvelope, getFixupDeserializer, getHref, getID, getName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getObjectValue, getParentElement, getPrefix, getPrefix, getRealElement, getRecorder, getType, getValue, getValueAsType, isDirty, isRoot, output, publishContents, publishToHandler, recycleNode, removeAttribute, removeNamespaceDeclaration, setAttribute, setContentsIndex, setDirty, setEncodingStyle, setEndIndex, setEnvelope, setFixupDeserializer, setName, setNamespaceURI, setNSMappings, setObjectValue, setParentElement, setPrefix, setRecorder, setType, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, removeAttribute, removeNamespaceDeclaration, setEncodingStyle

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setParentElement

Field Detail

log

protected static org.apache.commons.logging.Log log

trailers

public java.util.Vector trailers

messageType

public java.lang.String messageType

Constructor Detail

SOAPEnvelope

public SOAPEnvelope()

SOAPEnvelope

public SOAPEnvelope(SOAPConstants soapConstants)

SOAPEnvelope

public SOAPEnvelope(boolean registerPrefixes,
                    SOAPConstants soapConstants)

SOAPEnvelope

public SOAPEnvelope(java.io.InputStream input)
             throws org.xml.sax.SAXException

Method Detail

getMessageType

public java.lang.String getMessageType()

setMessageType

public void setMessageType(java.lang.String messageType)

getBodyElements

public java.util.Vector getBodyElements()
                                 throws AxisFault

getTrailers

public java.util.Vector getTrailers()

getFirstBody

public SOAPBodyElement getFirstBody()
                             throws AxisFault

getHeaders

public java.util.Vector getHeaders()
                            throws AxisFault

getHeadersByActor

public java.util.Vector getHeadersByActor(java.util.ArrayList actors)

Get all the headers targeted at a list of actors.

addHeader

public void addHeader(SOAPHeaderElement hdr)

addBodyElement

public void addBodyElement(SOAPBodyElement element)

removeHeaders

public void removeHeaders()

setHeader

public void setHeader(SOAPHeader hdr)

removeHeader

public void removeHeader(SOAPHeaderElement hdr)

removeBody

public void removeBody()

setBody

public void setBody(SOAPBody body)

removeBodyElement

public void removeBodyElement(SOAPBodyElement element)

removeTrailer

public void removeTrailer(MessageElement element)

clearBody

public void clearBody()

addTrailer

public void addTrailer(MessageElement element)

getHeaderByName

public SOAPHeaderElement getHeaderByName(java.lang.String namespace,
                                         java.lang.String localPart)
                                  throws AxisFault

Get a header by name (always respecting the currently in-scope actors list)

getHeaderByName

public SOAPHeaderElement getHeaderByName(java.lang.String namespace,
                                         java.lang.String localPart,
                                         boolean accessAllHeaders)
                                  throws AxisFault

Get a header by name, filtering for headers targeted at this engine depending on the accessAllHeaders parameter.

getBodyByName

public SOAPBodyElement getBodyByName(java.lang.String namespace,
                                     java.lang.String localPart)
                              throws AxisFault

getHeadersByName

public java.util.Enumeration getHeadersByName(java.lang.String namespace,
                                              java.lang.String localPart)
                                       throws AxisFault

getHeadersByName

public java.util.Enumeration getHeadersByName(java.lang.String namespace,
                                              java.lang.String localPart,
                                              boolean accessAllHeaders)
                                       throws AxisFault

Return an Enumeration of headers which match the given namespace and localPart. Depending on the value of the accessAllHeaders parameter, we will attempt to filter on the current engine's list of actors. !!! NOTE THAT RIGHT NOW WE ALWAYS ASSUME WE'RE THE "ULTIMATE DESTINATION" (i.e. we match on null actor). IF WE WANT TO FULLY SUPPORT INTERMEDIARIES WE'LL NEED TO FIX THIS.

outputImpl

public void outputImpl(SerializationContext context)
                throws java.lang.Exception

Should make SOAPSerializationException?

Overrides:

outputImpl in class MessageElement

addBody

public SOAPBody addBody()
                 throws SOAPException

Description copied from interface: SOAPEnvelope

Creates a SOAPBody object and sets it as the SOAPBody object for this SOAPEnvelope object.

It is illegal to add a body when the envelope already contains a body. Therefore, this method should be called only after the existing body has been removed.

Specified by:

addBody in interface SOAPEnvelope

Following copied from interface: javax.xml.soap.SOAPEnvelope

Returns:

the new SOAPBody object

Throws:

SOAPException - if this SOAPEnvelope object already contains a valid SOAPBody object

addHeader

public SOAPHeader addHeader()
                     throws SOAPException

Description copied from interface: SOAPEnvelope

Creates a SOAPHeader object and sets it as the SOAPHeader object for this SOAPEnvelope object.

It is illegal to add a header when the envelope already contains a header. Therefore, this method should be called only after the existing header has been removed.

Specified by:

addHeader in interface SOAPEnvelope

Following copied from interface: javax.xml.soap.SOAPEnvelope

Returns:

the new SOAPHeader object

Throws:

SOAPException - if this SOAPEnvelope object already contains a valid SOAPHeader object

createName

public Name createName(java.lang.String localName)
                throws SOAPException

Description copied from interface: SOAPEnvelope

Creates a new Name object initialized with the given local name.

This factory method creates Name objects for use in the SOAP/XML document.

Specified by:

createName in interface SOAPEnvelope

Following copied from interface: javax.xml.soap.SOAPEnvelope

Parameters:

localName - a String giving the local name

Returns:

a Name object initialized with the given local name

Throws:

SOAPException - if there is a SOAP error

createName

public Name createName(java.lang.String localName,
                       java.lang.String prefix,
                       java.lang.String uri)
                throws SOAPException

Description copied from interface: SOAPEnvelope

Creates a new Name object initialized with the given local name, namespace prefix, and namespace URI.

This factory method creates Name objects for use in the SOAP/XML document.

Specified by:

createName in interface SOAPEnvelope

Following copied from interface: javax.xml.soap.SOAPEnvelope

Parameters:

localName - a String giving the local name

prefix - a String giving the prefix of the namespace

uri - a String giving the URI of the namespace

Returns:

a Name object initialized with the given local name, namespace prefix, and namespace URI

Throws:

SOAPException - if there is a SOAP error

getBody

public SOAPBody getBody()
                 throws SOAPException

Description copied from interface: SOAPEnvelope

Returns the SOAPBody object associated with this SOAPEnvelope object.

A new SOAPMessage object is by default created with a SOAPEnvelope object that contains an empty SOAPBody object. As a result, the method getBody will always return a SOAPBody object unless the body has been removed and a new one has not been added.

Specified by:

getBody in interface SOAPEnvelope

Following copied from interface: javax.xml.soap.SOAPEnvelope

Returns:

the SOAPBody object for this SOAPEnvelope object or null if there is none

Throws:

SOAPException - if there is a problem obtaining the SOAPBody object

getHeader

public SOAPHeader getHeader()
                     throws SOAPException

Description copied from interface: SOAPEnvelope

Returns the SOAPHeader object for this SOAPEnvelope object.

A new SOAPMessage object is by default created with a SOAPEnvelope object that contains an empty SOAPHeader object. As a result, the method getHeader will always return a SOAPHeader object unless the header has been removed and a new one has not been added.

Specified by:

getHeader in interface SOAPEnvelope

Following copied from interface: javax.xml.soap.SOAPEnvelope

Returns:

the SOAPHeader object or null if there is none

Throws:

SOAPException - if there is a problem obtaining the SOAPHeader object