|
||||||||||
| PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.xml.soap.SOAPPart (src)
org.jboss.axis.message.SOAPPartImpl (src)
org.jboss.axis.message.SOAPPartAxisImpl (src)
org.jboss.axis.MessagePart
The SOAPPart provides access to the root part of the Message which contains the envelope.
SOAPPart implements Part, providing common MIME operations. SOAPPart also allows access to its envelope, as a string, byte[], InputStream, or SOAPEnvelope. (This functionality used to be in Message, and has been moved here more or less verbatim pending further cleanup.)
| Field Summary | |
static int |
FORM_BODYINSTREAM
|
static int |
FORM_BYTES
|
static int |
FORM_FAULT
|
static int |
FORM_INPUTSTREAM
|
static int |
FORM_SOAPENVELOPE
|
static int |
FORM_STRING
|
protected org.w3c.dom.Document |
mDocument
SOAPEnvelope is the Document Elements of this XML docuement |
| 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 | |
MessagePart(Message (src) parent,
java.lang.Object initialContents,
boolean isBodyStream)
Create a new SOAPPart. |
|
| Method Summary | |
void |
addMimeHeader(java.lang.String header,
java.lang.String value)
Add the specified MIME header, as per JAXM. |
org.w3c.dom.Node |
adoptNode(org.w3c.dom.Node node)
|
org.w3c.dom.Node |
appendChild(org.w3c.dom.Node newChild)
|
org.w3c.dom.Node |
cloneNode(boolean deep)
|
org.w3c.dom.Attr |
createAttribute(java.lang.String name)
|
org.w3c.dom.Attr |
createAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
|
org.w3c.dom.CDATASection |
createCDATASection(java.lang.String data)
|
org.w3c.dom.Comment |
createComment(java.lang.String data)
|
org.w3c.dom.DocumentFragment |
createDocumentFragment()
|
org.w3c.dom.Element |
createElement(java.lang.String tagName)
|
org.w3c.dom.Element |
createElementNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
|
org.w3c.dom.EntityReference |
createEntityReference(java.lang.String name)
|
org.w3c.dom.ProcessingInstruction |
createProcessingInstruction(java.lang.String target,
java.lang.String data)
|
org.w3c.dom.Text |
createTextNode(java.lang.String data)
|
java.util.Iterator |
getAllMimeHeaders()
Retrieves all the headers for this SOAPPart
object as an iterator over the MimeHeader
objects. |
byte[] |
getAsBytes()
Get the contents of this Part (not the headers!), as a byte array. |
SOAPEnvelopeAxisImpl (src) |
getAsSOAPEnvelope()
Get the contents of this Part (not the MIME headers!), as a SOAPEnvelope. |
java.lang.String |
getAsString()
Get the contents of this Part (not the headers!), as a String. |
org.w3c.dom.NamedNodeMap |
getAttributes()
|
org.w3c.dom.NodeList |
getChildNodes()
|
javax.xml.transform.Source |
getContent()
Returns the content of the SOAPEnvelope as a JAXP
Source object. |
java.lang.String |
getContentId()
Content ID. |
java.lang.String |
getContentIdRef()
Content ID. |
int |
getContentLength()
Get the content length for this SOAPPart. |
java.lang.String |
getContentLocation()
Content location. |
java.lang.String |
getContentType()
Content type is always "text/xml" for SOAPParts. |
java.lang.Object |
getCurrentMessage()
Get the current message, in whatever form it happens to be right now. |
org.w3c.dom.DocumentType |
getDoctype()
|
org.w3c.dom.Element |
getDocumentElement()
|
org.w3c.dom.Element |
getElementById(java.lang.String elementId)
|
org.w3c.dom.NodeList |
getElementsByTagName(java.lang.String tagname)
|
org.w3c.dom.NodeList |
getElementsByTagNameNS(java.lang.String namespaceURI,
java.lang.String localName)
|
java.lang.String |
getEncoding()
|
SOAPEnvelope (src) |
getEnvelope()
Gets the SOAPEnvelope object associated with
this SOAPPart object. |
org.w3c.dom.Node |
getFirstChild()
|
org.w3c.dom.DOMImplementation |
getImplementation()
|
org.w3c.dom.Node |
getLastChild()
|
java.lang.String |
getLocalName()
|
java.util.Iterator |
getMatchingMimeHeaders(java.lang.String[] match)
Get all headers that match. |
Message (src) |
getMessage()
Get the Message for this Part. |
java.lang.String[] |
getMimeHeader(java.lang.String name)
Gets all the values of the MimeHeader object
in this SOAPPart object that is identified by
the given String. |
java.lang.String |
getNamespaceURI()
|
org.w3c.dom.Node |
getNextSibling()
|
java.lang.String |
getNodeName()
Node Implementation |
short |
getNodeType()
|
java.lang.String |
getNodeValue()
|
java.util.Iterator |
getNonMatchingMimeHeaders(java.lang.String[] match)
Get all headers that do not match. |
org.w3c.dom.Document |
getOwnerDocument()
|
org.w3c.dom.Node |
getParentNode()
|
java.lang.String |
getPrefix()
|
org.w3c.dom.Node |
getPreviousSibling()
|
int |
getSize()
Get the total size in bytes, including headers, of this Part. |
org.w3c.dom.Document |
getSOAPDocument()
|
boolean |
getStandalone()
|
boolean |
getStrictErrorChecking()
|
java.lang.String |
getVersion()
|
boolean |
hasAttributes()
|
boolean |
hasChildNodes()
|
org.w3c.dom.Node |
importNode(org.w3c.dom.Node importedNode,
boolean deep)
|
org.w3c.dom.Node |
insertBefore(org.w3c.dom.Node newChild,
org.w3c.dom.Node refChild)
|
boolean |
isSupported(java.lang.String feature,
java.lang.String version)
|
void |
normalize()
|
void |
removeAllMimeHeaders()
Removes all the MimeHeader objects for this
SOAPEnvelope object. |
org.w3c.dom.Node |
removeChild(org.w3c.dom.Node oldChild)
|
void |
removeMimeHeader(java.lang.String header)
Removes all MIME headers that match the given name. |
org.w3c.dom.Node |
replaceChild(org.w3c.dom.Node newChild,
org.w3c.dom.Node oldChild)
|
void |
setContent(javax.xml.transform.Source source)
Sets the content of the SOAPEnvelope object
with the data from the given Source object. |
void |
setContentId(java.lang.String newCid)
Sets Content-Id of this part. |
void |
setContentLocation(java.lang.String loc)
Set content location. |
void |
setCurrentMessage(java.lang.Object currMsg,
int form)
Set the current message |
void |
setEncoding(java.lang.String s)
|
void |
setMessage(Message (src) msg)
Set the Message for this Part. |
void |
setMimeHeader(java.lang.String name,
java.lang.String value)
Changes the first header entry that matches the given header name so that its value is the given value, adding a new header with the given name and value if no existing header is a match. |
void |
setNodeValue(java.lang.String nodeValue)
|
void |
setPrefix(java.lang.String prefix)
|
void |
setSOAPEnvelope(SOAPEnvelopeAxisImpl (src) env)
This set the SOAP Envelope for this part. |
void |
setStandalone(boolean flag)
|
void |
setStrictErrorChecking(boolean flag)
|
void |
setVersion(java.lang.String s)
|
void |
writeTo(java.io.Writer writer)
Write the contents to the specified writer. |
| Methods inherited from class org.jboss.axis.message.SOAPPartImpl (src) |
compareDocumentPosition, getBaseURI, getDocumentURI, getDomConfig, getFeature, getInputEncoding, getTextContent, getUserData, getXmlEncoding, getXmlStandalone, getXmlVersion, isDefaultNamespace, isEqualNode, isSameNode, lookupNamespaceURI, lookupPrefix, normalizeDocument, renameNode, setDocumentURI, setTextContent, setUserData, setXmlStandalone, setXmlVersion |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final int FORM_STRING
public static final int FORM_INPUTSTREAM
public static final int FORM_SOAPENVELOPE
public static final int FORM_BYTES
public static final int FORM_BODYINSTREAM
public static final int FORM_FAULT
protected org.w3c.dom.Document mDocument
| Constructor Detail |
public MessagePart(Message (src) parent,
java.lang.Object initialContents,
boolean isBodyStream)
parent - the parent MessageinitialContents - the initial contens ObjectisBodyStream - if the body is in a stream| Method Detail |
public Message (src) getMessage()
Message for this Part.
Message for this Partpublic void setMessage(Message (src) msg)
msg - the Message for this partpublic java.lang.String getContentType()
getContentType in interface Part (src) public int getContentLength()
public void setSOAPEnvelope(SOAPEnvelopeAxisImpl (src) env)
env - the SOAPEnvelope for this SOAPPartpublic int getSize()
public void writeTo(java.io.Writer writer)
throws java.io.IOException
writer - the Writer to write to
java.io.IOExceptionpublic java.lang.Object getCurrentMessage()
public void setCurrentMessage(java.lang.Object currMsg,
int form)
currMsg - form -
public byte[] getAsBytes()
throws AxisFault (src)
AxisFault (src) - if this Part can't be serialized to the byte array
public java.lang.String getAsString()
throws AxisFault (src)
String containing the content of this message
AxisFault (src) - if there is an error serializing this part
public SOAPEnvelopeAxisImpl (src) getAsSOAPEnvelope()
throws AxisFault (src)
SOAPEnvelope containing the message content
AxisFault (src) - if the envelope could not be constructed
public void addMimeHeader(java.lang.String header,
java.lang.String value)
addMimeHeader in interface Part (src) addMimeHeader in class SOAPPartImpl (src) header - the header to addvalue - the value of that headerpublic java.lang.String getContentLocation()
getContentLocation in interface Part (src) getContentLocation in class SOAPPartImpl (src) public void setContentLocation(java.lang.String loc)
setContentLocation in interface Part (src) setContentLocation in class SOAPPartImpl (src) loc - the content locationpublic void setContentId(java.lang.String newCid)
setContentId in interface Part (src) setContentId in class SOAPPartImpl (src) newCid - new Content-Idpublic java.lang.String getContentId()
getContentId in interface Part (src) getContentId in class SOAPPartImpl (src) public java.lang.String getContentIdRef()
getContentIdRef in interface Part (src) public java.util.Iterator getMatchingMimeHeaders(java.lang.String[] match)
getMatchingMimeHeaders in interface Part (src) getMatchingMimeHeaders in class SOAPPartImpl (src) match - an array of Strings giving mime header names
Iterator over all values matching these headerspublic java.util.Iterator getNonMatchingMimeHeaders(java.lang.String[] match)
getNonMatchingMimeHeaders in interface Part (src) getNonMatchingMimeHeaders in class SOAPPartImpl (src) match - an array of Strings giving mime header names
Iterator over all values not matching these
headers
public void setContent(javax.xml.transform.Source source)
throws SOAPException (src)
SOAPEnvelope object
with the data from the given Source object.
setContent in class SOAPPartImpl (src) source - javax.xml.transform.Source object with the data to
be set
SOAPException (src) - if there is a problem in
setting the sourcegetContent()
public javax.xml.transform.Source getContent()
throws SOAPException (src)
Source object.
getContent in class SOAPPartImpl (src)
javax.xml.transform.Source object
SOAPException (src) - if the implementation cannot
convert the specified Source objectsetContent(javax.xml.transform.Source)public java.util.Iterator getAllMimeHeaders()
SOAPPart
object as an iterator over the MimeHeader
objects.
getAllMimeHeaders in class SOAPPartImpl (src) Iterator object with all of the Mime
headers for this SOAPPart object
public void setMimeHeader(java.lang.String name,
java.lang.String value)
Note that RFC822 headers can contain only US-ASCII characters.
setMimeHeader in class SOAPPartImpl (src) name - a String giving the
header name for which to searchvalue - a String giving the
value to be set. This value will be substituted for the
current value(s) of the first header that is a match if
there is one. If there is no match, this value will be
the value for a new MimeHeader object.getMimeHeader(java.lang.String)public java.lang.String[] getMimeHeader(java.lang.String name)
MimeHeader object
in this SOAPPart object that is identified by
the given String.
getMimeHeader in interface Part (src) getMimeHeader in class SOAPPartImpl (src) name - the name of the header; example:
"Content-Type"
String array giving all the values for
the specified headersetMimeHeader(java.lang.String, java.lang.String)public void removeAllMimeHeaders()
MimeHeader objects for this
SOAPEnvelope object.
removeAllMimeHeaders in class SOAPPartImpl (src) public void removeMimeHeader(java.lang.String header)
removeMimeHeader in class SOAPPartImpl (src) header - a String giving
the name of the MIME header(s) to be removed
public SOAPEnvelope (src) getEnvelope()
throws SOAPException (src)
SOAPEnvelope object associated with
this SOAPPart object. Once the SOAP envelope is
obtained, it can be used to get its contents.
getEnvelope in class SOAPPartImpl (src) SOAPEnvelope object for this
SOAPPart object
SOAPException (src) - if there is a SOAP errorpublic org.w3c.dom.Document getSOAPDocument()
public org.w3c.dom.DocumentType getDoctype()
getDoctype in interface org.w3c.dom.DocumentgetDoctype in class SOAPPartImpl (src) public org.w3c.dom.DOMImplementation getImplementation()
getImplementation in interface org.w3c.dom.DocumentgetImplementation in class SOAPPartImpl (src) public org.w3c.dom.Element getDocumentElement()
getDocumentElement in interface org.w3c.dom.DocumentgetDocumentElement in class SOAPPartImpl (src)
public org.w3c.dom.Element createElement(java.lang.String tagName)
throws org.w3c.dom.DOMException
createElement in interface org.w3c.dom.DocumentcreateElement in class SOAPPartImpl (src) tagName -
org.w3c.dom.DOMExceptionpublic org.w3c.dom.DocumentFragment createDocumentFragment()
createDocumentFragment in interface org.w3c.dom.DocumentcreateDocumentFragment in class SOAPPartImpl (src) public org.w3c.dom.Text createTextNode(java.lang.String data)
createTextNode in interface org.w3c.dom.DocumentcreateTextNode in class SOAPPartImpl (src) public org.w3c.dom.Comment createComment(java.lang.String data)
createComment in interface org.w3c.dom.DocumentcreateComment in class SOAPPartImpl (src)
public org.w3c.dom.CDATASection createCDATASection(java.lang.String data)
throws org.w3c.dom.DOMException
createCDATASection in interface org.w3c.dom.DocumentcreateCDATASection in class SOAPPartImpl (src) org.w3c.dom.DOMException
public org.w3c.dom.ProcessingInstruction createProcessingInstruction(java.lang.String target,
java.lang.String data)
throws org.w3c.dom.DOMException
createProcessingInstruction in interface org.w3c.dom.DocumentcreateProcessingInstruction in class SOAPPartImpl (src) org.w3c.dom.DOMException
public org.w3c.dom.Attr createAttribute(java.lang.String name)
throws org.w3c.dom.DOMException
createAttribute in interface org.w3c.dom.DocumentcreateAttribute in class SOAPPartImpl (src) org.w3c.dom.DOMException
public org.w3c.dom.EntityReference createEntityReference(java.lang.String name)
throws org.w3c.dom.DOMException
createEntityReference in interface org.w3c.dom.DocumentcreateEntityReference in class SOAPPartImpl (src) org.w3c.dom.DOMExceptionpublic org.w3c.dom.NodeList getElementsByTagName(java.lang.String tagname)
getElementsByTagName in interface org.w3c.dom.DocumentgetElementsByTagName in class SOAPPartImpl (src)
public org.w3c.dom.Node importNode(org.w3c.dom.Node importedNode,
boolean deep)
throws org.w3c.dom.DOMException
importNode in interface org.w3c.dom.DocumentimportNode in class SOAPPartImpl (src) org.w3c.dom.DOMException
public org.w3c.dom.Element createElementNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
throws org.w3c.dom.DOMException
createElementNS in interface org.w3c.dom.DocumentcreateElementNS in class SOAPPartImpl (src) org.w3c.dom.DOMException
public org.w3c.dom.Attr createAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
throws org.w3c.dom.DOMException
createAttributeNS in interface org.w3c.dom.DocumentcreateAttributeNS in class SOAPPartImpl (src) org.w3c.dom.DOMException
public org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String namespaceURI,
java.lang.String localName)
getElementsByTagNameNS in interface org.w3c.dom.DocumentgetElementsByTagNameNS in class SOAPPartImpl (src) public org.w3c.dom.Element getElementById(java.lang.String elementId)
getElementById in interface org.w3c.dom.DocumentgetElementById in class SOAPPartImpl (src) public java.lang.String getEncoding()
public void setEncoding(java.lang.String s)
public boolean getStandalone()
public void setStandalone(boolean flag)
public boolean getStrictErrorChecking()
getStrictErrorChecking in class SOAPPartImpl (src) public void setStrictErrorChecking(boolean flag)
setStrictErrorChecking in class SOAPPartImpl (src) public java.lang.String getVersion()
public void setVersion(java.lang.String s)
public org.w3c.dom.Node adoptNode(org.w3c.dom.Node node)
throws org.w3c.dom.DOMException
adoptNode in class SOAPPartImpl (src) org.w3c.dom.DOMExceptionpublic java.lang.String getNodeName()
getNodeName in interface org.w3c.dom.NodegetNodeName in class SOAPPartImpl (src)
public java.lang.String getNodeValue()
throws org.w3c.dom.DOMException
getNodeValue in interface org.w3c.dom.NodegetNodeValue in class SOAPPartImpl (src) org.w3c.dom.DOMException
public void setNodeValue(java.lang.String nodeValue)
throws org.w3c.dom.DOMException
setNodeValue in interface org.w3c.dom.NodesetNodeValue in class SOAPPartImpl (src) org.w3c.dom.DOMExceptionpublic short getNodeType()
getNodeType in interface org.w3c.dom.NodegetNodeType in class SOAPPartImpl (src) public org.w3c.dom.Node getParentNode()
getParentNode in interface org.w3c.dom.NodegetParentNode in class SOAPPartImpl (src) public org.w3c.dom.NodeList getChildNodes()
getChildNodes in interface org.w3c.dom.NodegetChildNodes in class SOAPPartImpl (src) public org.w3c.dom.Node getFirstChild()
getFirstChild in interface org.w3c.dom.NodegetFirstChild in class SOAPPartImpl (src) public org.w3c.dom.Node getLastChild()
getLastChild in interface org.w3c.dom.NodegetLastChild in class SOAPPartImpl (src) public org.w3c.dom.Node getPreviousSibling()
getPreviousSibling in interface org.w3c.dom.NodegetPreviousSibling in class SOAPPartImpl (src) public org.w3c.dom.Node getNextSibling()
getNextSibling in interface org.w3c.dom.NodegetNextSibling in class SOAPPartImpl (src) public org.w3c.dom.NamedNodeMap getAttributes()
getAttributes in interface org.w3c.dom.NodegetAttributes in class SOAPPartImpl (src) public org.w3c.dom.Document getOwnerDocument()
getOwnerDocument in interface org.w3c.dom.NodegetOwnerDocument in class SOAPPartImpl (src)
public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
org.w3c.dom.Node refChild)
throws org.w3c.dom.DOMException
insertBefore in interface org.w3c.dom.NodeinsertBefore in class SOAPPartImpl (src) org.w3c.dom.DOMException
public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
org.w3c.dom.Node oldChild)
throws org.w3c.dom.DOMException
replaceChild in interface org.w3c.dom.NodereplaceChild in class SOAPPartImpl (src) org.w3c.dom.DOMException
public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
throws org.w3c.dom.DOMException
removeChild in interface org.w3c.dom.NoderemoveChild in class SOAPPartImpl (src) org.w3c.dom.DOMException
public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
throws org.w3c.dom.DOMException
appendChild in interface org.w3c.dom.NodeappendChild in class SOAPPartImpl (src) org.w3c.dom.DOMExceptionpublic boolean hasChildNodes()
hasChildNodes in interface org.w3c.dom.NodehasChildNodes in class SOAPPartImpl (src) public org.w3c.dom.Node cloneNode(boolean deep)
cloneNode in interface org.w3c.dom.NodecloneNode in class SOAPPartImpl (src) public void normalize()
normalize in interface org.w3c.dom.Nodenormalize in class SOAPPartImpl (src)
public boolean isSupported(java.lang.String feature,
java.lang.String version)
isSupported in interface org.w3c.dom.NodeisSupported in class SOAPPartImpl (src) public java.lang.String getNamespaceURI()
getNamespaceURI in interface org.w3c.dom.NodegetNamespaceURI in class SOAPPartImpl (src) public java.lang.String getPrefix()
getPrefix in interface org.w3c.dom.NodegetPrefix in class SOAPPartImpl (src)
public void setPrefix(java.lang.String prefix)
throws org.w3c.dom.DOMException
setPrefix in interface org.w3c.dom.NodesetPrefix in class SOAPPartImpl (src) org.w3c.dom.DOMExceptionpublic java.lang.String getLocalName()
getLocalName in interface org.w3c.dom.NodegetLocalName in class SOAPPartImpl (src) public boolean hasAttributes()
hasAttributes in interface org.w3c.dom.NodehasAttributes in class SOAPPartImpl (src)
|
||||||||||
| PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||