|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
javax.xml.soap Class SOAPMessage
java.lang.Object javax.xml.soap.SOAPMessage
public abstract class SOAPMessage
- extends Object
所有 SOAP 消息的根类。因为 SOAP 消息是通过“导线”传输的,所以它是 XML 文档或第一个正文部分为 XML/SOAP 文档的 MIME 消息。
SOAPMessage
对象由一个 SOAP 部分和一个或多个附件部分(可选)组成。SOAPMessage
对象的 SOAP 部分是一个 SOAPPart
对象,包含了用于消息路由和标识的信息,并可以包含特定于应用程序的内容。消息 SOAP 部分中的所有数据都必须是 XML 格式。
默认情况下,新的 SOAPMessage
对象包含以下对象:
- 一个
SOAPPart
对象 - 一个
SOAPEnvelope
对象 - 一个
SOAPBody
对象 - 一个
SOAPHeader
对象
SOAPMessage.getSOAPPart()
检索消息的 SOAP 部分。SOAPEnvelope
对象是从 SOAPPart
对象检索的,SOAPEnvelope
对象用于检索 SOAPBody
和 SOAPHeader
对象。
SOAPPart sp = message.getSOAPPart(); SOAPEnvelope se = sp.getEnvelope(); SOAPBody sb = se.getBody(); SOAPHeader sh = se.getHeader();
除强制性 SOAPPart
对象之外,SOAPMessage
对象还可以包含零个或多个 AttachmentPart
对象,每个 AttachmentPart 对象都包含特定于应用程序的数据。SOAPMessage
接口提供了一些用于创建 AttachmentPart
对象的方法,以及一些将它们添加到 SOAPMessage
对象的方法。收到 SOAPMessage
对象的一方可以通过检索各个附件部分来检查消息内容。
与 SOAP 消息的其余部分不同,附件不需要是 XML 格式,因此可以是简单文本或图像文件等任何形式。因此,任何非 XML 格式的消息内容必须在 AttachmentPart
对象中。
MessageFactory
对象可以创建行为特定于具体 SAAJ 实现或应用程序的 SOAPMessage
对象。例如,MessageFactory
对象可以生成符合特定配置文件(如 ebXML)的 SOAPMessage
对象。在这种情况下,MessageFactory
对象可以生成使用 ebXML 头初始化的 SOAPMessage
对象。
为了确保与后向源的兼容性,在 SAAJ 规范的 1.1 版本之后添加到此类的方法都是具体而非抽象的,它们都具有默认实现。除在 JavaDocs 中有对这些方法的另行说明外,默认实现只是抛出 UnsupportedOperationException
,并且 SAAJ 实现代码必须使用提供指定行为的方法重写它们。但是,只要没有声明符合初始版本之后的某些更高版本规范,遗留客户端代码就没有这种限制。可以根据 SAAJ API 的未修改后续版本来编译和/或运行扩展 SOAPMessage 类的遗留类。如果正确实现了这样的类,则对于规范的更高版本(相对于初始版本)来说,该类将继续有效。
See also | javax.xml.soap.MessageFactory, javax.xml.soap.AttachmentPart |
The root class for all SOAP messages. As transmitted on the "wire", a SOAP message is an XML document or a MIME message whose first body part is an XML/SOAP document.
A SOAPMessage
object consists of a SOAP part and optionally
one or more attachment parts. The SOAP part for a SOAPMessage
object is a SOAPPart
object, which contains information used
for message routing and identification, and which can contain
application-specific content. All data in the SOAP Part of a message must be
in XML format.
A new SOAPMessage
object contains the following by default:
- A
SOAPPart
object - A
SOAPEnvelope
object - A
SOAPBody
object - A
SOAPHeader
object
SOAPMessage.getSOAPPart()
.
The SOAPEnvelope
object is retrieved from the SOAPPart
object, and the SOAPEnvelope
object is used to retrieve the
SOAPBody
and SOAPHeader
objects.
SOAPPart sp = message.getSOAPPart(); SOAPEnvelope se = sp.getEnvelope(); SOAPBody sb = se.getBody(); SOAPHeader sh = se.getHeader();
In addition to the mandatory SOAPPart
object, a SOAPMessage
object may contain zero or more AttachmentPart
objects, each
of which contains application-specific data. The SOAPMessage
interface provides methods for creating AttachmentPart
objects and also for adding them to a SOAPMessage
object. A
party that has received a SOAPMessage
object can examine its
contents by retrieving individual attachment parts.
Unlike the rest of a SOAP message, an attachment is not required to be in
XML format and can therefore be anything from simple text to an image file.
Consequently, any message content that is not in XML format must be in an
AttachmentPart
object.
A MessageFactory
object may create SOAPMessage
objects with behavior that is specialized to a particular implementation or
application of SAAJ. For instance, a MessageFactory
object
may produce SOAPMessage
objects that conform to a particular
Profile such as ebXML. In this case a MessageFactory
object
might produce SOAPMessage
objects that are initialized with
ebXML headers.
In order to ensure backward source compatibility, methods that are added to
this class after version 1.1 of the SAAJ specification are all concrete
instead of abstract and they all have default implementations. Unless
otherwise noted in the JavaDocs for those methods the default
implementations simply throw an UnsupportedOperationException
and the SAAJ implementation code must override them with methods that
provide the specified behavior. Legacy client code does not have this
restriction, however, so long as there is no claim made that it conforms to
some later version of the specification than it was originally written for.
A legacy class that extends the SOAPMessage class can be compiled and/or run
against succeeding versions of the SAAJ API without modification. If such a
class was correctly implemented then it will continue to behave correctly
relative to the version of the specification against which it was written.
- See Also:
MessageFactory
,AttachmentPart
Field Summary | |
---|---|
static String |
CHARACTER_SET_ENCODING
Specifies the character type encoding for the SOAP Message. |
static String |
WRITE_XML_DECLARATION
Specifies whether the SOAP Message will contain an XML declaration when it is sent. |
Constructor Summary | |
---|---|
SOAPMessage()
|
Method Summary | |
---|---|
abstract void |
addAttachmentPart(AttachmentPart AttachmentPart)
Adds the given AttachmentPart object to this SOAPMessage
object. |
abstract int |
countAttachments()
Gets a count of the number of attachments in this message. |
abstract AttachmentPart |
createAttachmentPart()
Creates a new empty AttachmentPart object. |
AttachmentPart |
createAttachmentPart(DataHandler dataHandler)
Creates an AttachmentPart object and populates it using
the given DataHandler object. |
AttachmentPart |
createAttachmentPart(Object content,
String contentType)
Creates an AttachmentPart object and populates it with
the specified data of the specified content type. |
abstract AttachmentPart |
getAttachment(SOAPElement element)
Returns an AttachmentPart object that is associated with an
attachment that is referenced by this SOAPElement or
null if no such attachment exists. |
abstract Iterator |
getAttachments()
Retrieves all the AttachmentPart objects that are part of
this SOAPMessage object. |
abstract Iterator |
getAttachments(MimeHeaders headers)
Retrieves all the AttachmentPart objects that have header
entries that match the specified headers. |
abstract String |
getContentDescription()
Retrieves a description of this SOAPMessage object's
content. |
abstract MimeHeaders |
getMimeHeaders()
Returns all the transport-specific MIME headers for this SOAPMessage
object in a transport-independent fashion. |
Object |
getProperty(String property)
Retrieves value of the specified property. |
SOAPBody |
getSOAPBody()
Gets the SOAP Body contained in this SOAPMessage object. |
SOAPHeader |
getSOAPHeader()
Gets the SOAP Header contained in this SOAPMessage
object. |
abstract SOAPPart |
getSOAPPart()
Gets the SOAP part of this SOAPMessage object. |
abstract void |
removeAllAttachments()
Removes all AttachmentPart objects that have been added
to this SOAPMessage object. |
abstract void |
removeAttachments(MimeHeaders headers)
Removes all the AttachmentPart objects that have header
entries that match the specified headers. |
abstract void |
saveChanges()
Updates this SOAPMessage object with all the changes that
have been made to it. |
abstract boolean |
saveRequired()
Indicates whether this SOAPMessage object needs to have
the method saveChanges called on it. |
abstract void |
setContentDescription(String description)
Sets the description of this SOAPMessage object's
content with the given description. |
void |
setProperty(String property,
Object value)
Associates the specified value with the specified property. |
abstract void |
writeTo(OutputStream out)
Writes this SOAPMessage object to the given output
stream. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
英文文档:
CHARACTER_SET_ENCODING
public static final String CHARACTER_SET_ENCODING
- Specifies the character type encoding for the SOAP Message. Valid values
include "utf-8" and "utf-16". See vendor documentation for additional
supported values. The default is "utf-8".
- Since:
- SAAJ 1.2
- See Also:
SOAPMessage.setProperty
, Constant Field Values
英文文档:
WRITE_XML_DECLARATION
public static final String WRITE_XML_DECLARATION
- Specifies whether the SOAP Message will contain an XML declaration when
it is sent. The only valid values are "true" and "false". The default is
"false".
- Since:
- SAAJ 1.2
- See Also:
SOAPMessage.setProperty
, Constant Field Values
Constructor Detail |
---|
public
SOAPMessage()
英文文档:
SOAPMessage
public SOAPMessage()
Method Detail |
---|
英文文档:
setContentDescription
public abstract void setContentDescription(String description)
- Sets the description of this
SOAPMessage
object's content with the given description. - Parameters:
description
- aString
describing the content of this message- See Also:
getContentDescription()
英文文档:
getContentDescription
public abstract String getContentDescription()
- Retrieves a description of this
SOAPMessage
object's content. - Returns:
- a
String
describing the content of this message ornull
if no description has been set - See Also:
setContentDescription(java.lang.String)
英文文档:
getSOAPPart
public abstract SOAPPart getSOAPPart()
- Gets the SOAP part of this
SOAPMessage
object.SOAPMessage
object contains one or more attachments, the SOAP Part must be the first MIME body part in the message. - Returns:
- the
SOAPPart
object for thisSOAPMessage
object
英文文档:
getSOAPBody
public SOAPBody getSOAPBody() throws SOAPException
- Gets the SOAP Body contained in this
SOAPMessage
object. - Returns:
- the
SOAPBody
object contained by thisSOAPMessage
object - Throws:
SOAPException
- if the SOAP Body does not exist or cannot be retrieved- Since:
- SAAJ 1.2
英文文档:
getSOAPHeader
public SOAPHeader getSOAPHeader() throws SOAPException
- Gets the SOAP Header contained in this
SOAPMessage
object. - Returns:
- the
SOAPHeader
object contained by thisSOAPMessage
object - Throws:
SOAPException
- if the SOAP Header does not exist or cannot be retrieved- Since:
- SAAJ 1.2
abstract public void
removeAllAttachments()
移除所有已经添加到此 SOAPMessage
对象的 AttachmentPart
对象。
此方法不接触 SOAP 部分。
removeAllAttachments
public abstract void removeAllAttachments()
- Removes all
AttachmentPart
objects that have been added to thisSOAPMessage
object.This method does not touch the SOAP part.
abstract public int
countAttachments()
获取此消息中附件数量的计数。此计数不包括 SOAP 部分。
return |
作为此 SOAPMessage 对象一部分的 AttachmentPart 对象的数量
|
countAttachments
public abstract int countAttachments()
- Gets a count of the number of attachments in this message. This count
does not include the SOAP part.
- Returns:
- the number of
AttachmentPart
objects that are part of thisSOAPMessage
object
英文文档:
getAttachments
public abstract Iterator getAttachments()
- Retrieves all the
AttachmentPart
objects that are part of thisSOAPMessage
object. - Returns:
- an iterator over all the attachments in this message
英文文档:
getAttachments
public abstract Iterator getAttachments(MimeHeaders headers)
- Retrieves all the
AttachmentPart
objects that have header entries that match the specified headers. Note that a returned attachment could have headers in addition to those specified. - Parameters:
headers
- aMimeHeaders
object containing the MIME headers for which to search- Returns:
- an iterator over all attachments that have a header that matches one of the given headers
abstract public void
removeAttachments(MimeHeaders headers)
移除所有头条目匹配指定头的 AttachmentPart
对象。注意,移除的附件除指定的头之外,还可以有其他头。
headers |
包含要搜索的 MIME 头的 MimeHeaders 对象 |
since | SAAJ 1.3 |
removeAttachments
public abstract void removeAttachments(MimeHeaders headers)
- Removes all the
AttachmentPart
objects that have header entries that match the specified headers. Note that the removed attachment could have headers in addition to those specified. - Parameters:
headers
- aMimeHeaders
object containing the MIME headers for which to search- Since:
- SAAJ 1.3
abstract public AttachmentPart
getAttachment(SOAPElement element) throws SOAPException
返回与此 SOAPElement
引用的附件关联的 AttachmentPart
对象,如果不存在此类附件,则返回 null
。可以通过 java.lang.NullPointerException
at com.sun.tools.javadoc.DocEnv.getClassSymbol(DocEnv.java:177)
at com.sun.tools.javadoc.DocEnv.lookupClass(DocEnv.java:133)
at com.sun.tools.javadoc.ClassDocImpl.searchClass(ClassDocImpl.java:682)
at com.sun.tools.javadoc.ClassDocImpl.findClass(ClassDocImpl.java:665)
at com.sun.tools.docserver.DocServlet.writeSeeTagDoc(DocServlet.java:900)
at com.sun.tools.docserver.DocServlet.writeInlineTagString(DocServlet.java:989)
at com.sun.tools.docserver.DocServlet.writeTagPara(DocServlet.java:614)
at com.sun.tools.docserver.DocServlet.writeDoc(DocServlet.java:523)
at com.sun.tools.docserver.DocServlet.writeMethodTable(DocServlet.java:877)
at com.sun.tools.docserver.DocServlet.processRequest(DocServlet.java:229)
at com.sun.tools.docserver.DocServlet.doGet(DocServlet.java:744)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:718)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:831)
at org.apache.catalina.core.ApplicationFilterChain.servletService(ApplicationFilterChain.java:411)
at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:290)
at org.apache.catalina.core.StandardContextValve.invokeInternal(StandardContextValve.java:271)
at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:202)
at org.apache.catalina.core.StandardPipeline.doInvoke(StandardPipeline.java:624)
at org.apache.catalina.core.StandardPipeline.doInvoke(StandardPipeline.java:577)
at com.sun.enterprise.web.WebPipeline.invoke(WebPipeline.java:94)
at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:206)
at org.apache.catalina.core.StandardPipeline.doInvoke(StandardPipeline.java:624)
at org.apache.catalina.core.StandardPipeline.doInvoke(StandardPipeline.java:577)
at org.apache.catalina.core.StandardPipeline.invoke(StandardPipeline.java:571)
at org.apache.catalina.core.ContainerBase.invoke(ContainerBase.java:1080)
at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:150)
at org.apache.catalina.core.StandardPipeline.doInvoke(StandardPipeline.java:624)
at org.apache.catalina.core.StandardPipeline.doInvoke(StandardPipeline.java:577)
at org.apache.catalina.core.StandardPipeline.invoke(StandardPipeline.java:571)
at org.apache.catalina.core.ContainerBase.invoke(ContainerBase.java:1080)
at org.apache.coyote.tomcat5.CoyoteAdapter.service(CoyoteAdapter.java:268)
at com.sun.enterprise.web.connector.grizzly.DefaultProcessorTask.invokeAdapter(DefaultProcessorTask.java:631)
at com.sun.enterprise.web.connector.grizzly.DefaultProcessorTask.doProcess(DefaultProcessorTask.java:562)
at com.sun.enterprise.web.connector.grizzly.DefaultProcessorTask.process(DefaultProcessorTask.java:803)
at com.sun.enterprise.web.connector.grizzly.DefaultReadTask.executeProcessorTask(DefaultReadTask.java:339)
at com.sun.enterprise.web.connector.grizzly.DefaultReadTask.doTask(DefaultReadTask.java:261)
at com.sun.enterprise.web.connector.grizzly.DefaultReadTask.doTask(DefaultReadTask.java:212)
at com.sun.enterprise.web.connector.grizzly.TaskBase.run(TaskBase.java:265)
at com.sun.enterprise.web.connector.grizzly.ssl.SSLWorkerThread.run(SSLWorkerThread.java:106)
About DocWeb · Bundles · Export · Export All Top 10 · Statistics · Login
About Sun · Contact · Privacy · Terms of Use · Trademarks Java EE 5 SDK · Copyright © 1994-2008 Sun Microsystems, Inc.
About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
About Sun · Contact · Privacy · Terms of Use · Trademarks | Java EE 5 SDK · Copyright © 1994-2008 Sun Microsystems, Inc. |
getAttachment
public abstract AttachmentPart getAttachment(SOAPElement element) throws SOAPException
- Returns an
AttachmentPart
object that is associated with an attachment that is referenced by thisSOAPElement
ornull
if no such attachment exists. References can be made via anhref
attribute as described in SOAP Messages with Attachments, or via a singleText
child node containing a URI as described in the WS-I Attachments Profile 1.0 for elements of schema type ref:swaRef(ref:swaRef). These two mechanisms must be supported. The support for references viahref
attribute also implies that this method should also be supported on an element that is an xop:Include element ( XOP). other reference mechanisms may be supported by individual implementations of this standard. Contact your vendor for details. - Parameters:
element
- TheSOAPElement
containing the reference to an Attachment- Returns:
- the referenced
AttachmentPart
or null if no suchAttachmentPart
exists or no reference can be found in thisSOAPElement
. - Throws:
SOAPException
- if there is an error in the attempt to access the attachment- Since:
- SAAJ 1.3
abstract public void
addAttachmentPart(AttachmentPart AttachmentPart)
将给定的 AttachmentPart
对象添加到此 SOAPMessage
对象。必须先创建 AttachmentPart
对象,然后才能将其添加到消息。
AttachmentPart |
将作为此 SOAPMessage 对象一部分的 AttachmentPart 对象 |
Throws | IllegalArgumentException: |
addAttachmentPart
public abstract void addAttachmentPart(AttachmentPart AttachmentPart)
- Adds the given
AttachmentPart
object to thisSOAPMessage
object. AnAttachmentPart
object must be created before it can be added to a message. - Parameters:
AttachmentPart
- anAttachmentPart
object that is to become part of thisSOAPMessage
object- Throws:
IllegalArgumentException
abstract public AttachmentPart
createAttachmentPart()
创建一个新的空 AttachmentPart
对象。注意,调用方法 addAttachmentPart
时必须将此新 AttachmentPart
对象作为参数,以便该对象成为此 SOAPMessage
对象的附件。
return |
可以填充并添加到此 SOAPMessage 对象的新的 AttachmentPart 对象
|
createAttachmentPart
public abstract AttachmentPart createAttachmentPart()
- Creates a new empty
AttachmentPart
object. Note that the methodaddAttachmentPart
must be called with this newAttachmentPart
object as the parameter in order for it to become an attachment to thisSOAPMessage
object. - Returns:
- a new
AttachmentPart
object that can be populated and added to thisSOAPMessage
object
public AttachmentPart
createAttachmentPart(DataHandler dataHandler)
创建 AttachmentPart
对象并使用给定的 DataHandler
对象填充。
dataHandler |
将生成此 SOAPMessage 对象内容的 javax.activation.DataHandler 对象 |
return |
包含给定 DataHandler 对象生成数据的新的 AttachmentPart 对象 |
Throws | IllegalArgumentException:
如果指定的 DataHandler 对象存在问题 |
See also | javax.activation.DataHandler, javax.activation.DataContentHandler |
createAttachmentPart
public AttachmentPart createAttachmentPart(DataHandler dataHandler)
- Creates an
AttachmentPart
object and populates it using the givenDataHandler
object. - Parameters:
dataHandler
- thejavax.activation.DataHandler
object that will generate the content for thisSOAPMessage
object- Returns:
- a new
AttachmentPart
object that contains data generated by the givenDataHandler
object - Throws:
IllegalArgumentException
- if there was a problem with the specifiedDataHandler
object- See Also:
DataHandler
,DataContentHandler
英文文档:
getMimeHeaders
public abstract MimeHeaders getMimeHeaders()
- Returns all the transport-specific MIME headers for this
SOAPMessage
object in a transport-independent fashion. - Returns:
- a
MimeHeaders
object containing theMimeHeader
objects
public AttachmentPart
createAttachmentPart(Object content, String contentType)
创建 AttachmentPart
对象并使用指定内容类型的指定数据填充。Object
的类型应该对应于指定给 Content-Type
的值。
content |
包含要创建的 AttachmentPart 对象内容的 Object |
contentType |
给出内容类型的 String 对象;例如 "text/xml"、"text/plain" 和 "image/jpeg" |
return |
包含给定数据的新的 AttachmentPart 对象 |
Throws | IllegalArgumentException:
如果 contentType 不匹配内容对象的类型,或者没有给定内容对象的 DataContentHandler 对象时抛出 |
See also | javax.activation.DataHandler, javax.activation.DataContentHandler |
createAttachmentPart
public AttachmentPart createAttachmentPart(Object content, String contentType)
- Creates an
AttachmentPart
object and populates it with the specified data of the specified content type. The type of theObject
should correspond to the value given for theContent-Type
. - Parameters:
content
- anObject
containing the content for theAttachmentPart
object to be createdcontentType
- aString
object giving the type of content; examples are "text/xml", "text/plain", and "image/jpeg"- Returns:
- a new
AttachmentPart
object that contains the given data - Throws:
IllegalArgumentException
- may be thrown if the contentType does not match the type of the content object, or if there was noDataContentHandler
object for the given content object- See Also:
DataHandler
,DataContentHandler
abstract public void
saveChanges() throws SOAPException
使用对其所作的所有更改更新此 SOAPMessage
对象。调用 writeTo(OutputStream)
时自动调用此方法。但是,如果是对已收到或已发送的消息进行更改,则需要显式调用方法 saveChanges
保存这些更改。方法 saveChanges
还生成任何可以回读的更改(例如,支持消息 id 的配置文件中 MessageId)。只有在调用 saveChanges
之后,才能保证为发送而创建的消息中的所有 MIME 头具有有效值。
此外,此方法标记了位置点,取自所有 AttachmentPart
对象组件的数据在该点处被拉入消息。
Throws | SOAPException :
如果在保存此消息的更改时出现问题。 |
saveChanges
public abstract void saveChanges() throws SOAPException
- Updates this
SOAPMessage
object with all the changes that have been made to it. This method is called automatically whenwriteTo(OutputStream)
is called. However, if changes are made to a message that was received or to one that has already been sent, the methodsaveChanges
needs to be called explicitly in order to save the changes. The methodsaveChanges
also generates any changes that can be read back (for example, a MessageId in profiles that support a message id). All MIME headers in a message that is created for sending purposes are guaranteed to have valid values only aftersaveChanges
has been called.In addition, this method marks the point at which the data from all constituent
AttachmentPart
objects are pulled into the message. - Throws:
SOAPException
- if there was a problem saving changes to this message.SOAPException
abstract public boolean
saveRequired()
指示是否此 SOAPMessage
对象需要调用方法 saveChanges
。
return |
如果需要调用 saveChanges ,则返回 true ;否则返回 false 。
|
saveRequired
public abstract boolean saveRequired()
- Indicates whether this
SOAPMessage
object needs to have the methodsaveChanges
called on it. - Returns:
true
ifsaveChanges
needs to be called;false
otherwise.
abstract public void
writeTo(java.io.OutputStream out) throws SOAPException, java.io.IOException
将此 SOAPMessage
对象写入给定输出流。具体化格式在 SOAP 1.1 with Attachments 规范中定义。
如果没有附件,则只写出 XML 流。对于有附件的消息,writeTo
写出 MIME 编码的字节流。
注意,此方法不写出特定于传输的消息的 MIME Header
out |
SOAPMessage 对象将写入的 OutputStream 对象 |
Throws | java.io.IOException: 如果发生 I/O * 错误 |
Throws | SOAPException: 在具体化此 SOAP 消息时出现问题 |
writeTo
public abstract void writeTo(OutputStream out) throws SOAPException, IOException
- Writes this
SOAPMessage
object to the given output stream. The externalization format is as defined by the SOAP 1.1 with Attachments specification.If there are no attachments, just an XML stream is written out. For those messages that have attachments,
writeTo
writes a MIME-encoded byte stream.Note that this method does not write the transport-specific MIME Headers of the Message
- Parameters:
out
- theOutputStream
object to which thisSOAPMessage
object will be written- Throws:
IOException
- if an I/O error occursSOAPException
- if there was a problem in externalizing this SOAP message
英文文档:
setProperty
public void setProperty(String property, Object value) throws SOAPException
- Associates the specified value with the specified property. If there was
already a value associated with this property, the old value is
replaced.
The valid property names include
WRITE_XML_DECLARATION
andCHARACTER_SET_ENCODING
. All of these standard SAAJ properties are prefixed by "javax.xml.soap". Vendors may also add implementation specific properties. These properties must be prefixed with package names that are unique to the vendor.Setting the property
WRITE_XML_DECLARATION
to"true"
will cause an XML Declaration to be written out at the start of the SOAP message. The default value of "false" suppresses this declaration.The property
CHARACTER_SET_ENCODING
defaults to the value"utf-8"
which causes the SOAP message to be encoded using UTF-8. SettingCHARACTER_SET_ENCODING
to"utf-16"
causes the SOAP message to be encoded using UTF-16.Some implementations may allow encodings in addition to UTF-8 and UTF-16. Refer to your vendor's documentation for details.
- Parameters:
property
- the property with which the specified value is to be associated.value
- the value to be associated with the specified property- Throws:
SOAPException
- if the property name is not recognized.- Since:
- SAAJ 1.2
英文文档:
getProperty
public Object getProperty(String property) throws SOAPException
- Retrieves value of the specified property.
- Parameters:
property
- the name of the property to retrieve- Returns:
- the value associated with the named property or
null
if no such property exists. - Throws:
SOAPException
- if the property name is not recognized.- Since:
- SAAJ 1.2
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Submit a bug or feature
Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. 一看就知道只有菜鸟才干这么无知的事啦。
PS : 未经我党受权你也可自由散发此文档。 如有任何错误请自行修正;若因此而造成任何损失请直接找人民主席,请勿与本人联系。谢谢!