|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.axis.message.MessageElement | +--org.apache.axis.message.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 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 |
protected static org.apache.commons.logging.Log log
public java.util.Vector trailers
public java.lang.String messageType
Constructor Detail |
public SOAPEnvelope()
public SOAPEnvelope(SOAPConstants soapConstants)
public SOAPEnvelope(boolean registerPrefixes, SOAPConstants soapConstants)
public SOAPEnvelope(java.io.InputStream input) throws org.xml.sax.SAXException
Method Detail |
public java.lang.String getMessageType()
public void setMessageType(java.lang.String messageType)
public java.util.Vector getBodyElements() throws AxisFault
public java.util.Vector getTrailers()
public SOAPBodyElement getFirstBody() throws AxisFault
public java.util.Vector getHeaders() throws AxisFault
public java.util.Vector getHeadersByActor(java.util.ArrayList actors)
public void addHeader(SOAPHeaderElement hdr)
public void addBodyElement(SOAPBodyElement element)
public void removeHeaders()
public void setHeader(SOAPHeader hdr)
public void removeHeader(SOAPHeaderElement hdr)
public void removeBody()
public void setBody(SOAPBody body)
public void removeBodyElement(SOAPBodyElement element)
public void removeTrailer(MessageElement element)
public void clearBody()
public void addTrailer(MessageElement element)
public SOAPHeaderElement getHeaderByName(java.lang.String namespace, java.lang.String localPart) throws AxisFault
public SOAPHeaderElement getHeaderByName(java.lang.String namespace, java.lang.String localPart, boolean accessAllHeaders) throws AxisFault
public SOAPBodyElement getBodyByName(java.lang.String namespace, java.lang.String localPart) throws AxisFault
public java.util.Enumeration getHeadersByName(java.lang.String namespace, java.lang.String localPart) throws AxisFault
public java.util.Enumeration getHeadersByName(java.lang.String namespace, java.lang.String localPart, boolean accessAllHeaders) throws AxisFault
public void outputImpl(SerializationContext context) throws java.lang.Exception
outputImpl
in class MessageElement
public SOAPBody addBody() throws SOAPException
SOAPEnvelope
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.
addBody
in interface SOAPEnvelope
javax.xml.soap.SOAPEnvelope
SOAPBody
objectSOAPException
- if this
SOAPEnvelope
object already contains a valid
SOAPBody
objectpublic SOAPHeader addHeader() throws SOAPException
SOAPEnvelope
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.
addHeader
in interface SOAPEnvelope
javax.xml.soap.SOAPEnvelope
SOAPHeader
objectSOAPException
- if this
SOAPEnvelope
object already contains a valid
SOAPHeader
objectpublic Name createName(java.lang.String localName) throws SOAPException
SOAPEnvelope
Name
object initialized with the
given local name.
This factory method creates Name
objects
for use in the SOAP/XML document.
createName
in interface SOAPEnvelope
javax.xml.soap.SOAPEnvelope
localName
- a String
giving
the local nameName
object initialized with the given
local nameSOAPException
- if there is a SOAP errorpublic Name createName(java.lang.String localName, java.lang.String prefix, java.lang.String uri) throws SOAPException
SOAPEnvelope
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.
createName
in interface SOAPEnvelope
javax.xml.soap.SOAPEnvelope
localName
- a String
giving
the local nameprefix
- a String
giving
the prefix of the namespaceuri
- a String
giving the
URI of the namespaceName
object initialized with the given
local name, namespace prefix, and namespace URISOAPException
- if there is a SOAP errorpublic SOAPBody getBody() throws SOAPException
SOAPEnvelope
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.
getBody
in interface SOAPEnvelope
javax.xml.soap.SOAPEnvelope
SOAPBody
object for this
SOAPEnvelope
object or null
if there
is noneSOAPException
- if there is a problem
obtaining the SOAPBody
objectpublic SOAPHeader getHeader() throws SOAPException
SOAPEnvelope
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.
getHeader
in interface SOAPEnvelope
javax.xml.soap.SOAPEnvelope
SOAPHeader
object or
null
if there is noneSOAPException
- if there is a problem
obtaining the SOAPHeader
object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |