org.apache.axis.message
Class SOAPEnvelope

java.lang.Object
  |
  +--org.apache.axis.message.MessageElement
        |
        +--org.apache.axis.message.SOAPEnvelope
All Implemented Interfaces:
Node, SOAPElement

public class SOAPEnvelope
extends MessageElement


Inner classes inherited from class org.apache.axis.message.MessageElement
MessageElement.QNameAttr
 
Field Summary
 java.util.Vector bodyElements
           
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, typeQName
 
Constructor Summary
SOAPEnvelope()
           
SOAPEnvelope(boolean registerPrefixes, SOAPConstants soapConstants)
           
SOAPEnvelope(java.io.InputStream input)
           
SOAPEnvelope(SOAPConstants soapConstants)
           
 
Method Summary
 void addBodyElement(SOAPBodyElement element)
           
 void addHeader(SOAPHeaderElement hdr)
           
 void addTrailer(MessageElement element)
           
 void clearBody()
           
protected  MessageElement findElement(java.util.Vector vec, java.lang.String namespace, java.lang.String localPart)
           
 SOAPBodyElement getBodyByName(java.lang.String namespace, java.lang.String localPart)
           
 java.util.Vector getBodyElements()
           
 SOAPBodyElement getFirstBody()
           
 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 removeBodyElement(SOAPBodyElement element)
           
 void removeHeader(SOAPHeaderElement hdr)
           
 void removeHeaders()
           
 void removeTrailer(MessageElement element)
           
 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, 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
 

Field Detail

log

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

bodyElements

public java.util.Vector bodyElements

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()

removeHeader

public void removeHeader(SOAPHeaderElement hdr)

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

findElement

protected MessageElement findElement(java.util.Vector vec,
                                     java.lang.String namespace,
                                     java.lang.String localPart)

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


Copyright © 2001 Apache XML Project. All Rights Reserved.