AttachmentPart (Java Platform SE 8 )

java.lang.Object
- javax.xml.soap.AttachmentPart

```
public abstract class AttachmentPart
extends Object
```
一个连接到 SOAPMessage对象。一个 SOAPMessage对象可能包含零个或多 AttachmentPart对象，。每个 AttachmentPart对象主要分为两个部分，具体内容和MIME标头中的应用。MIME标头包含名称/值对，可以用来识别和描述的内容。
一个AttachmentPart对象必须符合一定的标准。
1. 它必须符合 MIME [RFC2045] standards
2. 它必须包含内容
3. 标题部分必须包括以下标题：
  - Content-Type
    这头标识在一个AttachmentPart对象内容的数据类型必须与[ rfc2045 ]。下面是一个例子：一个内容类型标头
```
内容类型：应用程序/ XML
```
    下面这行代码，这是一个AttachmentPart ap对象，设置在前面的例子中所示的标题。
```
AP。setmimeheader（“内容类型”、“application/xml”）；
```
有一个 AttachmentPart对象的内容部分没有限制。内容可能是任何从一个简单的纯文本对象到一个复杂的XML文档或图像文件。

一个AttachmentPart对象与方法SOAPMessage.createAttachmentPart创建。后设置MIME标头，该AttachmentPart对象添加到创建它的方法SOAPMessage.addAttachmentPart消息。

下面的代码片段，其中m是SOAPMessage对象和contentStringl是String，创造AttachmentPart实例，一些内容和标题信息的AttachmentPart对象集，并增加了AttachmentPart对象的SOAPMessage对象。
```
attachmentpart AP1 = M createattachmentpart()；AP1。setContent（contentstring1，“text/plain”）；m.addattachmentpart（AP1）；
```
下面的代码片段创建和加入了第二AttachmentPart实例相同的消息。jpegData是二进制字节缓冲区代表的JPEG文件。
```
attachmentpart AP2 = M createattachmentpart()；字节[] jpegdata =…；AP2。setContent（新从字节数组读取的输入流（jpegdata）、“image/jpeg”）；m.addattachmentpart（AP2）；
```
的getContent方法从AttachmentPart对象检索和标头的内容。根据DataContentHandler对象，返回的Object可以是一个类型的java对象对应的MIME类型或InputStream包含内容为字节。
```
字符串内容= getcontent() AP1；java.io.inputstream内容= getcontent() AP2；
```
方法 clearContent删除所有的内容从 AttachmentPart对象，但并不影响它的头信息。
```
clearcontent() AP1；
```

构造方法摘要

构造方法

Constructor and Description

AttachmentPart()

构造方法
Constructor and Description
`AttachmentPart()`

方法摘要

所有方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`abstract void`	`addMimeHeader(String name, String value)` 增加了 `AttachmentPart`对象具有指定名称和值的MIME标头。
`abstract void`	`clearContent()` 明确了这 `AttachmentPart`对象的内容。
`abstract Iterator`	`getAllMimeHeaders()` 检索所有这 `AttachmentPart`对象的标题在 `MimeHeader`对象迭代器。
`abstract InputStream`	`getBase64Content()` 返回一个 `InputStream`可获得 `AttachmentPart`含量为Base64编码的字符数据，该方法将base64编码和返回连接的原始字节。
`abstract Object`	`getContent()` 作为一个java对象得到这个 `AttachmentPart`对象的内容。
`String`	`getContentId()` 获取该MIME头名叫“内容身份的价值”。
`String`	`getContentLocation()` 获取价值的MIME标头的名称是“内容的位置”。
`String`	`getContentType()` 获取该MIME头名叫“内容类型”的价值。
`abstract DataHandler`	`getDataHandler()` 获取此 `AttachmentPart`对象的 `DataHandler`对象。
`abstract Iterator`	`getMatchingMimeHeaders(String[] names)` 检索匹配的名字在给定的数组对象的所有 `MimeHeader`。
`abstract String[]`	`getMimeHeader(String name)` 获取标头了 `String`确定所有的值。
`abstract Iterator`	`getNonMatchingMimeHeaders(String[] names)` 检索所有 `MimeHeader`对象的名字不在给定的数组名字匹配。
`abstract InputStream`	`getRawContent()` 得到这 `AttachmentPart`对象的内容作为InputStream好像打了 `getContent`没有 `DataContentHandler`已经注册为本 `AttachmentPart`的 `content-type`。
`abstract byte[]`	`getRawContentBytes()` 获取内容这 `AttachmentPart`对象作为字节数组[ ]如果一个电话就 `getContent`没有 `DataContentHandler`已注册为 `content-type`这 `AttachmentPart`。
`abstract int`	`getSize()` 在这 `AttachmentPart`对象返回的字节数。
`abstract void`	`removeAllMimeHeaders()` 删除所有的MIME标头项。
`abstract void`	`removeMimeHeader(String header)` 移除给定的名称匹配所有MIME标头。
`abstract void`	`setBase64Content(InputStream content, String contentType)` 设置此附件部分内容从base64源 `InputStream`和集包含在 `contentType`价值的 `Content-Type`标头的值，该方法先解码base64输入写产生的原始字节的依恋。
`abstract void`	`setContent(Object object, String contentType)` 设置此附件部分的内容，给出 `Object`和设置为给定类型的 `Content-Type`标头的值。
`void`	`setContentId(String contentId)` 设置MIME标头的名称是“具有给定值的内容ID”。
`void`	`setContentLocation(String contentLocation)` 设置MIME标头的名称是“具有给定值的内容定位”。
`void`	`setContentType(String contentType)` 设置MIME标头的名称是“具有给定值的内容类型”。
`abstract void`	`setDataHandler(DataHandler dataHandler)` 设置给定的 `DataHandler`对象作为这 `AttachmentPart`对象的数据处理程序。
`abstract void`	`setMimeHeader(String name, String value)` 更改与给定名称匹配给定值的第一头文件项，如果没有现有的标题匹配，将添加一个新的头文件。
`abstract void`	`setRawContent(InputStream content, String contentType)` 集的内容本附件部分包含由 `InputStream` `content`和集包含在 `contentType`价值的 `Content-Type`标头的值。
`abstract void`	`setRawContentBytes(byte[] content, int offset, int len, String contentType)` 集的内容本附件部分包含由 `byte[]`阵列 `content`和集包含在 `contentType`价值的 `Content-Type`标头的值。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AttachmentPart
```
public AttachmentPart()
```
- 方法详细信息
  - getSize
```
public abstract int getSize()
                     throws SOAPException
```
    在这 AttachmentPart对象返回的字节数。
    
    结果
    
    这 AttachmentPart对象大小的字节或1如果大小无法确定
    
    异常
    
    SOAPException如果本附件的内容被损坏，如果有例外，而试图确定尺寸。
  - clearContent
```
public abstract void clearContent()
```
    明确了这 AttachmentPart对象的内容。MIME标头部分原封不动。
  - getContent
```
public abstract Object getContent()
                           throws SOAPException
```
    作为一个java对象得到这个 AttachmentPart对象的内容。java的返回对象的类型取决于（1）的 DataContentHandler对象，用于解释字节，（2）在给定的头 Content-Type。
    对于MIME内容类型“text/plain”、“text/html”和“text/xml”的DataContentHandler对象进行转换和对应的MIME类型的java类型。其他的MIME类型，该DataContentHandler对象可以返回一个对象，InputStream包含原始字节内容数据。
    
    一种用于兼容的实现必须为最小值，返回对应的任何内容流有text/plain Content-Type价值java.lang.String对象，对应于一个text/xml Content-Type价值内容流javax.xml.transform.stream.StreamSource对象，对应于一个image/gif或image/jpeg Content-Type价值内容流java.awt.Image对象。这些内容类型，安装DataContentHandler对象不理解的DataContentHandler对象必须返回一个与原始字节java.io.InputStream对象。
    
    结果
    
    这与 AttachmentPart对象内容的java对象
    
    异常
    
    SOAPException -如果没有内容设置成这 AttachmentPart对象或者数据转换时出现错误
  - getRawContent
```
public abstract InputStream getRawContent()
                                   throws SOAPException
```
    得到这 AttachmentPart对象的内容作为InputStream好像打了 getContent没有 DataContentHandler已经注册为本 AttachmentPart的 content-type。
    注意，从返回的InputStream读取会导致消费数据流。它是调用者的责任，称随后的API复位前适当的输入流。如果一份原始附件的内容要求那么getRawContentBytes() API应该用来代替。
    
    结果
    
    从一个 InputStream由 AttachmentPart包含原始数据可以被访问。
    
    异常
    
    SOAPException -如果没有内容设置成这 AttachmentPart对象或者数据转换时出现错误。
    
    从以下版本开始：
    
    SAAJ 1.3
    
    另请参见：
    
    getRawContentBytes()
  - getRawContentBytes
```
public abstract byte[] getRawContentBytes()
                                   throws SOAPException
```
    获取内容这 AttachmentPart对象作为字节数组[ ]如果一个电话就 getContent没有 DataContentHandler已注册为 content-type这 AttachmentPart。
    
    结果
    
    一个包含原始数据的 AttachmentPart byte[]阵列。
    
    异常
    
    SOAPException -如果没有内容设置成这 AttachmentPart对象或者数据转换时出现错误。
    
    从以下版本开始：
    
    SAAJ 1.3
  - getBase64Content
```
public abstract InputStream getBase64Content()
                                      throws SOAPException
```
    返回一个 InputStream可获得 AttachmentPart含量为Base64编码的字符数据，该方法将base64编码和返回连接的原始字节。
    
    结果
    
    一个 InputStream从base64编码 AttachmentPart可以读。
    
    异常
    
    SOAPException -如果没有内容设置成这 AttachmentPart对象或者数据转换时出现错误。
    
    从以下版本开始：
    
    SAAJ 1.3
  - setContent
```
public abstract void setContent(Object object,
                                String contentType)
```
    设置此附件部分的内容，给出 Object和设置为给定类型的 Content-Type标头的值。 Object的类型应符合给定的 Content-Type价值。这取决于 DataContentHandler对象的特定使用。
    
    参数
    
    object的java对象，弥补了此附件部分的内容
    
    contentType - MIME字符串，指定内容类型
    
    异常
    
    IllegalArgumentException可能如果contentType不的内容对象的类型匹配抛出，或如果有此内容的对象没有 DataContentHandler对象
    
    另请参见：
    
    getContent()
  - setRawContent
```
public abstract void setRawContent(InputStream content,
                                   String contentType)
                            throws SOAPException
```
    集的内容本附件部分包含由 InputStream content和集包含在 contentType价值的 Content-Type标头的值。
    随后调用getsize()不得内容大小的准确度量。
    
    参数
    
    content -原数据添加到附件部分
    
    contentType -设置为 Content-Type标头的值
    
    异常
    
    SOAPException -如果有内容设置错误
    
    NullPointerException -如果 content是空的
    
    从以下版本开始：
    
    SAAJ 1.3
  - setRawContentBytes
```
public abstract void setRawContentBytes(byte[] content,
                                        int offset,
                                        int len,
                                        String contentType)
                                 throws SOAPException
```
    集的内容本附件部分包含由 byte[]阵列 content和集包含在 contentType价值的 Content-Type标头的值。
    
    参数
    
    content -原数据添加到附件部分
    
    contentType -设置为 Content-Type标头的值
    
    在内容的字节数组的偏移 offset -
    
    len -字节形式的内容的数量
    
    异常
    
    SOAPException -如果有设定的内容或内容的一个错误是空的
    
    从以下版本开始：
    
    SAAJ 1.3
  - setBase64Content
```
public abstract void setBase64Content(InputStream content,
                                      String contentType)
                               throws SOAPException
```
    设置此附件部分内容从base64源 InputStream和集包含在 contentType价值的 Content-Type标头的值，该方法先解码base64输入写产生的原始字节的依恋。
    随后调用getsize()不得内容大小的准确度量。
    
    参数
    
    content的Base64编码的数据添加到附件部分
    
    contentType -设置为 Content-Type标头的值
    
    异常
    
    SOAPException -如果有内容设置错误
    
    NullPointerException -如果 content是空的
    
    从以下版本开始：
    
    SAAJ 1.3
  - getDataHandler
```
public abstract DataHandler getDataHandler()
                                    throws SOAPException
```
    获取此 AttachmentPart对象的 DataHandler对象。
    
    结果
    
    这 AttachmentPart对象相关的 DataHandler对象
    
    异常
    
    SOAPException -如果有这 AttachmentPart对象没有数据
  - setDataHandler
```
public abstract void setDataHandler(DataHandler dataHandler)
```
    设置给定的 DataHandler对象作为这 AttachmentPart对象的数据处理程序。通常情况下，在传入消息中，数据处理程序将自动设置。当一个消息被创建和填充的内容，在 setDataHandler方法可以用来把数据从不同的数据源的信息。
    
    参数
    
    dataHandler - DataHandler对象被设置
    
    异常
    
    IllegalArgumentException -如果有指定的 DataHandler对象问题
  - getContentId
```
public String getContentId()
```
    获取该MIME头名叫“内容身份的价值”。
    
    结果
    
    一个 String给出“内容身份”头或 null价值如果没有
    
    另请参见：
    
    setContentId(java.lang.String)
  - getContentLocation
```
public String getContentLocation()
```
    获取价值的MIME标头的名称是“内容的位置”。
    
    结果
    
    一个 String给出“内容定位”头或 null价值如果没有
  - getContentType
```
public String getContentType()
```
    获取该MIME头名叫“内容类型”的价值。
    
    结果
    
    一个 String给出“内容类型”头或 null如果没有价值
  - setContentId
```
public void setContentId(String contentId)
```
    设置MIME标头的名称是“具有给定值的内容ID”。
    
    参数
    
    contentId - String赋予价值的“内容身份”头
    
    异常
    
    IllegalArgumentException -如果有指定的 contentId价值问题
    
    另请参见：
    
    getContentId()
  - setContentLocation
```
public void setContentLocation(String contentLocation)
```
    设置MIME标头的名称是“具有给定值的内容定位”。
    
    参数
    
    contentLocation - String赋予价值的“内容定位”头
    
    异常
    
    IllegalArgumentException -如果有指定的内容定位问题
  - setContentType
```
public void setContentType(String contentType)
```
    设置MIME标头的名称是“具有给定值的内容类型”。
    
    参数
    
    contentType - String赋予价值的“内容类型”头
    
    异常
    
    IllegalArgumentException -如果有指定内容类型的问题
  - removeMimeHeader
```
public abstract void removeMimeHeader(String header)
```
    移除给定的名称匹配所有MIME标头。
    
    参数
    
    header的MIME头/要删除的字符串名称
  - removeAllMimeHeaders
```
public abstract void removeAllMimeHeaders()
```
    删除所有的MIME标头项。
  - getMimeHeader
```
public abstract String[] getMimeHeader(String name)
```
    获取标头了 String确定所有的值。
    
    参数
    
    name -标头的名称；例如：“内容类型”
    
    结果
    
    一个 String阵列给指定的标头的值
    
    另请参见：
    
    setMimeHeader(java.lang.String, java.lang.String)
  - setMimeHeader
```
public abstract void setMimeHeader(String name,
                                   String value)
```
    更改与给定名称匹配给定值的第一头文件项，如果没有现有的标题匹配，将添加一个新的头文件。此方法还移除所有匹配的标题，但第一个。
    注意RFC822头只能包含US-ASCII字符。
    
    参数
    
    name - String给出的标题名称搜索
    
    value - String给设置的名称相匹配的名字的标头的值
    
    异常
    
    IllegalArgumentException -如果有指定的MIME标头名称或值的问题
  - addMimeHeader
```
public abstract void addMimeHeader(String name,
                                   String value)
```
    增加了 AttachmentPart对象具有指定名称和值的MIME标头。
    注意RFC822头只能包含US-ASCII字符。
    
    参数
    
    name - String给标头的名称应加
    
    value - String给要添加标题的价值
    
    异常
    
    IllegalArgumentException -如果有指定的MIME标头名称或值的问题
  - getAllMimeHeaders
```
public abstract Iterator getAllMimeHeaders()
```
    检索所有这 AttachmentPart对象的标题在 MimeHeader对象迭代器。
    
    结果
    
    一个 Iterator对象所有的MIME标头这 AttachmentPart对象
  - getMatchingMimeHeaders
```
public abstract Iterator getMatchingMimeHeaders(String[] names)
```
    检索匹配的名字在给定的数组对象的所有 MimeHeader。
    
    参数
    
    names -一个叫 String阵列（S）的MIME标头被退回
    
    结果
    
    所有的MIME标头匹配一个在给定数组作为 Iterator对象的名称
  - getNonMatchingMimeHeaders
```
public abstract Iterator getNonMatchingMimeHeaders(String[] names)
```
    检索所有 MimeHeader对象的名字不在给定的数组名字匹配。
    
    参数
    
    names -一个叫 String阵列（S）的MIME头不回
    
    结果
    
    除了那些匹配一个在给定数组的名字都在这 AttachmentPart对象的MIME标头。这种不匹配的MIME标头是 Iterator对象返回。

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Class AttachmentPart

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

Constructor Detail

AttachmentPart

方法详细信息

getSize

clearContent

getContent

getRawContent

getRawContentBytes

getBase64Content

setContent

setRawContent

setRawContentBytes

setBase64Content

getDataHandler

setDataHandler

getContentId

getContentLocation

getContentType

setContentId

setContentLocation

setContentType

removeMimeHeader

removeAllMimeHeaders

getMimeHeader

setMimeHeader

addMimeHeader

getAllMimeHeaders

getMatchingMimeHeaders

getNonMatchingMimeHeaders