org.jboss.axis.message
Class SOAPEnvelopeAxisImpl

java.lang.Object
  extended byorg.jboss.axis.message.NodeImpl (src) 
      extended byorg.jboss.axis.message.SOAPElementImpl (src) 
          extended byorg.jboss.axis.message.SOAPElementAxisImpl (src) 
              extended byorg.jboss.axis.message.SOAPEnvelopeImpl (src) 
                  extended byorg.jboss.axis.message.SOAPEnvelopeAxisImpl
All Implemented Interfaces:
java.lang.Cloneable, org.w3c.dom.Element, Node (src) , org.w3c.dom.Node, SOAPElement (src) , SOAPEnvelope (src)

public class SOAPEnvelopeAxisImpl
extends SOAPEnvelopeImpl (src)

Implementation of a SOAP Envelope


Nested Class Summary
 
Nested classes inherited from class org.jboss.axis.message.SOAPElementAxisImpl (src)
SOAPElementAxisImpl.QNameAttr (src)
 
Field Summary
 java.lang.String messageType
           
 java.util.Vector trailers
           
 
Fields inherited from class org.jboss.axis.message.SOAPElementAxisImpl (src)
_isRoot, attributes, context, elementRep, encodingStyle, endEventIndex, href, id, message, name, namespaces, namespaceURI, objectValue, prefix, qNameAttrs, recorder, soapPart, startContentsIndex, startEventIndex, typeQName
 
Fields inherited from class org.jboss.axis.message.NodeImpl (src)
domNode, soapParent
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
SOAPEnvelopeAxisImpl()
           
SOAPEnvelopeAxisImpl(boolean registerPrefixes, SOAPConstants (src)  soapConstants)
           
SOAPEnvelopeAxisImpl(boolean registerPrefixes, SOAPConstants (src)  soapConstants, SchemaVersion (src)  schemaVersion)
           
SOAPEnvelopeAxisImpl(SOAPConstants (src)  soapConstants)
           
SOAPEnvelopeAxisImpl(SOAPConstants (src)  soapConstants, SchemaVersion (src)  schemaVersion)
           
 
Method Summary
 SOAPBody (src) addBody()
          Add a soap body if one does not exist
 void addBodyElement(SOAPBodyElementAxisImpl (src)  element)
          Add a SOAP Body Element
 SOAPHeader (src) addHeader()
          Add a soap header if one does not exist
 void addHeader(SOAPHeaderElementAxisImpl (src)  hdr)
          Add a HeaderElement
 void addTrailer(SOAPElementAxisImpl (src)  element)
          Add an element to the trailer
 void clearBody()
          clear the elements in the soap body
 Name (src) createName(java.lang.String localName)
          create a Name given the local part
 Name (src) createName(java.lang.String localName, java.lang.String prefix, java.lang.String uri)
          Create a name given local part, prefix and uri
 SOAPBody (src) getBody()
          Get the soap body
 SOAPBodyElementAxisImpl (src) getBodyByName(java.lang.String namespace, java.lang.String localPart)
          Get a body element given its name
 java.util.Vector getBodyElements()
          Get all the BodyElement's in the soap body
 SOAPBodyElementAxisImpl (src) getFirstBody()
          Get the first BodyElement in the SOAP Body
 SOAPHeader (src) getHeader()
          Get the soap header
 SOAPHeaderElementAxisImpl (src) getHeaderByName(java.lang.String namespace, java.lang.String localPart)
          Get a header by name (always respecting the currently in-scope actors list)
 SOAPHeaderElementAxisImpl (src) 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()
          Get Headers
 java.util.Enumeration getHeadersByName(java.lang.String namespace, java.lang.String localPart)
          Get an enumeration of header elements given the namespace and 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()
          Get the Message Type (REQUEST/RESPONSE)
 SchemaVersion (src) getSchemaVersion()
          Get the schema version for this envelope
 SOAPConstants (src) getSOAPConstants()
          Get the soap constants for this envelope
 java.util.Vector getTrailers()
          Return trailers
 boolean isModified()
           
 boolean isProcessingRPCInvocation()
           
static SOAPEnvelopeAxisImpl (src) newSOAPEnvelope(java.io.InputStream input)
           
 void outputImpl(SerializationContext (src)  context)
          Should make SOAPSerializationException?
 void removeBody()
          Remove the SOAP Body
 void removeBodyElement(SOAPBodyElementAxisImpl (src)  element)
          Remove a Body Element from the soap body
 org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
           
 void removeHeader(SOAPHeaderElementAxisImpl (src)  hdr)
          Remove a Header Element from SOAP Header
 void removeHeaders()
          Remove all headers
 void removeTrailer(SOAPElementAxisImpl (src)  element)
          Remove an element from the trailer
 void setBody(SOAPBodyAxisImpl (src)  newBody)
          Set the soap body
 void setHeader(SOAPHeaderAxisImpl (src)  header)
          Set the SOAP Header
 void setMessageType(java.lang.String messageType)
          Set the Message Type (REQUEST/RESPONSE)
 void setModified(boolean modified)
           
 void setProcessingRPCInvocation(boolean flag)
           
 void setSAAJEncodingCompliance(boolean comply)
           
 void setSchemaVersion(SchemaVersion (src)  schemaVersion)
          Set the schema version for this envelope
 void setSoapConstants(SOAPConstants (src)  soapConstants)
          Set the soap constants for this envelope
 
Methods inherited from class org.jboss.axis.message.SOAPEnvelopeImpl (src)
addTextNode
 
Methods inherited from class org.jboss.axis.message.SOAPElementAxisImpl (src)
addAttribute, addAttribute, addAttribute, addAttribute, addChild, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addMapping, addNamespaceDeclaration, appendChild, cloneNode, clonning, detachAllChildren, detachNode, getAllAttributes, getAsDocument, getAsDOM, getAsString, getAsStringFromInternal, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesEx, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildNodes, getChildren, getCompleteAttributes, getElementName, getElementsByTagName, getElementsByTagNameNS, getElementsNS, getEncodingStyle, getEnvelope, getFirstChild, getFixupDeserializer, getHref, getID, getLastChild, getLocalName, getName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeType, getNodeValue, getObjectValue, getObjectValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPrefix, getPreviousSibling, getQName, getRealElement, getRecorder, getTagName, getType, getValueAsType, getValueAsType, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, insertBefore, isDirty, isImmutable, isRoot, isSupported, makeAttributesEditable, normalize, output, printFromInternal, publishContents, publishToHandler, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeContents, removeNamespaceDeclaration, replaceChild, setAllAttributes, setAllImmutable, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setContentsIndex, setDirty, setEncodingStyle, setEndIndex, setEnvelope, setFixupDeserializer, setImmutable, setName, setNamespaceURI, setNSMappings, setObjectValue, setOwnerDocument, setParentElement, setPrefix, setQName, setRecorder, setType
 
Methods inherited from class org.jboss.axis.message.SOAPElementImpl (src)
getSchemaTypeInfo, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
Methods inherited from class org.jboss.axis.message.NodeImpl (src)
compareDocumentPosition, getBaseURI, getFeature, getNodeName, getTextContent, getUserData, getValue, hashCode, isDefaultNamespace, isEqualNode, isSameNode, lookupNamespaceURI, lookupPrefix, recycleNode, setNodeValue, setTextContent, setUserData, setValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.xml.soap.SOAPElement (src)
addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle
 
Methods inherited from interface javax.xml.soap.Node (src)
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, replaceChild, setNodeValue, setPrefix
 
Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS
 

Field Detail

trailers

public java.util.Vector trailers

messageType

public java.lang.String messageType
Constructor Detail

SOAPEnvelopeAxisImpl

public SOAPEnvelopeAxisImpl()

SOAPEnvelopeAxisImpl

public SOAPEnvelopeAxisImpl(SOAPConstants (src)  soapConstants)

SOAPEnvelopeAxisImpl

public SOAPEnvelopeAxisImpl(SOAPConstants (src)  soapConstants,
                            SchemaVersion (src)  schemaVersion)

SOAPEnvelopeAxisImpl

public SOAPEnvelopeAxisImpl(boolean registerPrefixes,
                            SOAPConstants (src)  soapConstants)

SOAPEnvelopeAxisImpl

public SOAPEnvelopeAxisImpl(boolean registerPrefixes,
                            SOAPConstants (src)  soapConstants,
                            SchemaVersion (src)  schemaVersion)
Method Detail

newSOAPEnvelope

public static SOAPEnvelopeAxisImpl (src)  newSOAPEnvelope(java.io.InputStream input)
                                            throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

getMessageType

public java.lang.String getMessageType()
Get the Message Type (REQUEST/RESPONSE)

Returns:
message type

setMessageType

public void setMessageType(java.lang.String messageType)
Set the Message Type (REQUEST/RESPONSE)

Parameters:
messageType -

getBodyElements

public java.util.Vector getBodyElements()
                                 throws AxisFault (src) 
Get all the BodyElement's in the soap body

Returns:
vector with body elements
Throws:
AxisFault (src)

getTrailers

public java.util.Vector getTrailers()
Return trailers

Returns:

getFirstBody

public SOAPBodyElementAxisImpl (src)  getFirstBody()
                                     throws AxisFault (src) 
Get the first BodyElement in the SOAP Body

Returns:
first Body Element
Throws:
AxisFault (src)

isModified

public boolean isModified()

setModified

public void setModified(boolean modified)

isProcessingRPCInvocation

public boolean isProcessingRPCInvocation()

setProcessingRPCInvocation

public void setProcessingRPCInvocation(boolean flag)

getHeaders

public java.util.Vector getHeaders()
                            throws AxisFault (src) 
Get Headers

Returns:
Vector containing Header's
Throws:
AxisFault (src)

addHeader

public void addHeader(SOAPHeaderElementAxisImpl (src)  hdr)
Add a HeaderElement

Parameters:
hdr -

addBodyElement

public void addBodyElement(SOAPBodyElementAxisImpl (src)  element)
Add a SOAP Body Element

Parameters:
element -

removeHeaders

public void removeHeaders()
Remove all headers


setHeader

public void setHeader(SOAPHeaderAxisImpl (src)  header)
Set the SOAP Header


removeHeader

public void removeHeader(SOAPHeaderElementAxisImpl (src)  hdr)
Remove a Header Element from SOAP Header

Parameters:
hdr -

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
                             throws org.w3c.dom.DOMException
Specified by:
removeChild in interface org.w3c.dom.Node
Overrides:
removeChild in class SOAPElementAxisImpl (src)
Throws:
org.w3c.dom.DOMException

removeBody

public void removeBody()
Remove the SOAP Body


setBody

public void setBody(SOAPBodyAxisImpl (src)  newBody)
Set the soap body

Parameters:
newBody -

removeBodyElement

public void removeBodyElement(SOAPBodyElementAxisImpl (src)  element)
Remove a Body Element from the soap body

Parameters:
element -

removeTrailer

public void removeTrailer(SOAPElementAxisImpl (src)  element)
Remove an element from the trailer

Parameters:
element -

clearBody

public void clearBody()
clear the elements in the soap body


addTrailer

public void addTrailer(SOAPElementAxisImpl (src)  element)
Add an element to the trailer

Parameters:
element -

getHeaderByName

public SOAPHeaderElementAxisImpl (src)  getHeaderByName(java.lang.String namespace,
                                                 java.lang.String localPart)
                                          throws AxisFault (src) 
Get a header by name (always respecting the currently in-scope actors list)

Throws:
AxisFault (src)

getHeaderByName

public SOAPHeaderElementAxisImpl (src)  getHeaderByName(java.lang.String namespace,
                                                 java.lang.String localPart,
                                                 boolean accessAllHeaders)
                                          throws AxisFault (src) 
Get a header by name, filtering for headers targeted at this engine depending on the accessAllHeaders parameter.

Throws:
AxisFault (src)

getBodyByName

public SOAPBodyElementAxisImpl (src)  getBodyByName(java.lang.String namespace,
                                             java.lang.String localPart)
                                      throws AxisFault (src) 
Get a body element given its name

Parameters:
namespace -
localPart -
Returns:
Throws:
AxisFault (src)

getHeadersByName

public java.util.Enumeration getHeadersByName(java.lang.String namespace,
                                              java.lang.String localPart)
                                       throws AxisFault (src) 
Get an enumeration of header elements given the namespace and localpart

Parameters:
namespace -
localPart -
Returns:
Throws:
AxisFault (src)

getHeadersByName

public java.util.Enumeration getHeadersByName(java.lang.String namespace,
                                              java.lang.String localPart,
                                              boolean accessAllHeaders)
                                       throws AxisFault (src) 
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.

Throws:
AxisFault (src)

outputImpl

public void outputImpl(SerializationContext (src)  context)
                throws java.lang.Exception
Should make SOAPSerializationException?

Overrides:
outputImpl in class SOAPElementAxisImpl (src)
Throws:
java.lang.Exception

getSOAPConstants

public SOAPConstants (src)  getSOAPConstants()
Get the soap constants for this envelope

Returns:

setSoapConstants

public void setSoapConstants(SOAPConstants (src)  soapConstants)
Set the soap constants for this envelope

Parameters:
soapConstants -

getSchemaVersion

public SchemaVersion (src)  getSchemaVersion()
Get the schema version for this envelope

Returns:

setSchemaVersion

public void setSchemaVersion(SchemaVersion (src)  schemaVersion)
Set the schema version for this envelope

Parameters:
schemaVersion -

addBody

public SOAPBody (src)  addBody()
                 throws SOAPException (src) 
Add a soap body if one does not exist

Specified by:
addBody in interface SOAPEnvelope (src)
Overrides:
addBody in class SOAPEnvelopeImpl (src)
Returns:
Throws:
SOAPException (src)

addHeader

public SOAPHeader (src)  addHeader()
                     throws SOAPException (src) 
Add a soap header if one does not exist

Specified by:
addHeader in interface SOAPEnvelope (src)
Overrides:
addHeader in class SOAPEnvelopeImpl (src)
Returns:
Throws:
SOAPException (src)

createName

public Name (src)  createName(java.lang.String localName)
                throws SOAPException (src) 
create a Name given the local part

Specified by:
createName in interface SOAPEnvelope (src)
Overrides:
createName in class SOAPEnvelopeImpl (src)
Parameters:
localName -
Returns:
Throws:
SOAPException (src)

createName

public Name (src)  createName(java.lang.String localName,
                       java.lang.String prefix,
                       java.lang.String uri)
                throws SOAPException (src) 
Create a name given local part, prefix and uri

Specified by:
createName in interface SOAPEnvelope (src)
Overrides:
createName in class SOAPEnvelopeImpl (src)
Parameters:
localName -
prefix -
uri -
Returns:
Throws:
SOAPException (src)

getBody

public SOAPBody (src)  getBody()
Get the soap body

Specified by:
getBody in interface SOAPEnvelope (src)
Overrides:
getBody in class SOAPEnvelopeImpl (src)

getHeader

public SOAPHeader (src)  getHeader()
Get the soap header

Specified by:
getHeader in interface SOAPEnvelope (src)
Overrides:
getHeader in class SOAPEnvelopeImpl (src)
Returns:

setSAAJEncodingCompliance

public void setSAAJEncodingCompliance(boolean comply)