SOAPMessage (Платформа Java SE 7)

java.lang. Объект
- javax.xml.soap. SOAPMessage

```
public abstract class SOAPMessage
extends Object
```
Корневой класс для всех сообщений SOAP. Как передано на "проводе", сообщение SOAP является XML-документом или сообщением MIME, первая часть тела которого является документом XML/SOAP.
A SOAPMessage объект состоит из части SOAP и дополнительно одной или более присоединяемых частей. Часть SOAP для a SOAPMessage объект является a SOAPPart объект, который содержит информацию, используемую для маршрутизации сообщения и идентификации, и который может содержать специализированный контент. Все данные в Части SOAP сообщения должны быть в формате XML.
Новое SOAPMessage объект содержит следующий по умолчанию:
- A SOAPPart объект
- A SOAPEnvelope объект
- A SOAPBody объект
- A SOAPHeader объект
Часть SOAP сообщения может быть получена, вызывая метод SOAPMessage.getSOAPPart(). SOAPEnvelope объект получается от SOAPPart объект, и SOAPEnvelope объект используется, чтобы получить SOAPBody и SOAPHeader объекты.
```
     SOAPPart sp = message.getSOAPPart();
     SOAPEnvelope se = sp.getEnvelope();
     SOAPBody sb = se.getBody();
     SOAPHeader sh = se.getHeader();
 
```
В дополнение к обязательному SOAPPart объект, a SOAPMessage объект может содержать нуль или больше AttachmentPart объекты, каждый из которых содержит специализированные данные. SOAPMessage интерфейс обеспечивает методы для того, чтобы они создали AttachmentPart объекты и также для того, чтобы добавить их к a SOAPMessage объект. Сторона, которая получила a SOAPMessage объект может исследовать свое содержание, получая отдельные присоединяемые части.
В отличие от остальной части сообщения SOAP, присоединение не обязано быть в формате XML и может поэтому быть чем-либо от простого текста до файла образа. Следовательно, любой контент сообщения, который не находится в формате XML, должен быть в AttachmentPart объект.
A MessageFactory объект может создать SOAPMessage объекты с поведением, которое специализируется к определенной реализации или приложению SAAJ. Например, a MessageFactory объект может произвести SOAPMessage объекты, которые соответствуют определенному Профилю, такому как ebXML. В этом случае a MessageFactory объект мог бы произвести SOAPMessage объекты, которые инициализируются с заголовками ebXML.
Чтобы гарантировать обратную исходную совместимость, методы, которые добавляются к этому классу после того, как версия 1.1 спецификации SAAJ является всем бетоном вместо краткого обзора и у них всех есть реализации по умолчанию. Если не указано иное, в JavaDocs для тех методов реализации по умолчанию просто бросают UnsupportedOperationException и код реализации SAAJ должен переопределить их с методами, которые обеспечивают указанное поведение. У клиентского кода наследства нет этого ограничения, однако, пока нет никакой претензии, внесенной, что это соответствует некоторой более поздней версии спецификации, чем это было первоначально записано для. Класс наследства, который расширяет класс SOAPMessage, может быть скомпилирован и/или выполнен против последующих версий API SAAJ без модификации. Если такой класс был правильно реализован тогда, он будет продолжать вести себя правильно относительно версии спецификации, против которой он был записан.
См. Также:
MessageFactory, AttachmentPart

Полевая Сводка

Поля
Модификатор и Тип	Поле и Описание
`static String`	`CHARACTER_SET_ENCODING` Определяет кодирование символьного типа для сообщения SOAP.
`static String`	`WRITE_XML_DECLARATION` Определяет, будет ли сообщение SOAP содержать объявление XML, когда оно будет отправлено.

Сводка конструктора

Конструкторы
Конструктор и Описание

SOAPMessage()

Конструкторы
Конструктор и Описание
`SOAPMessage()`

Сводка метода

Методы
Модификатор и Тип	Метод и Описание
`abstract void`	`addAttachmentPart(AttachmentPart AttachmentPart)` Добавляет данный `AttachmentPart` возразите против этого `SOAPMessage` объект.
`abstract int`	`countAttachments()` Получает количество числа присоединений в этом сообщении.
`abstract AttachmentPart`	`createAttachmentPart()` Создает новое пустое `AttachmentPart` объект.
`AttachmentPart`	`createAttachmentPart(DataHandler dataHandler)` Создает `AttachmentPart` возразите и заполняет это использующий данный `DataHandler` объект.
`AttachmentPart`	`createAttachmentPart(Object content, String contentType)` Создает `AttachmentPart` возразите и заполняет это с указанными данными указанного типа контента.
`abstract AttachmentPart`	`getAttachment(SOAPElement element)` Возвраты `AttachmentPart` объект, который связывается с присоединением, на которое ссылается это `SOAPElement` или `null` если никакое такое присоединение не существует.
`abstract Iterator`	`getAttachments()` Получает весь `AttachmentPart` объекты, которые являются частью этого `SOAPMessage` объект.
`abstract Iterator`	`getAttachments(MimeHeaders headers)` Получает весь `AttachmentPart` объекты, у которых есть записи заголовка, которые соответствуют указанные заголовки.
`abstract String`	`getContentDescription()` Получает описание этого `SOAPMessage` контент объекта.
`abstract MimeHeaders`	`getMimeHeaders()` Возвраты все транспортно-специфичные заголовки MIME для этого `SOAPMessage` объект независимым от транспорта способом.
`Объект`	`getProperty(String property)` Получает значение указанного свойства.
`SOAPBody`	`getSOAPBody()` Содержали Тело SOAP в этом `SOAPMessage` объект.
`SOAPHeader`	`getSOAPHeader()` Содержали Заголовок SOAP в этом `SOAPMessage` объект.
`abstract SOAPPart`	`getSOAPPart()` Получает часть SOAP этого `SOAPMessage` объект.
`abstract void`	`removeAllAttachments()` Удаляет все `AttachmentPart` объекты, которые были добавлены к этому `SOAPMessage` объект.
`abstract void`	`removeAttachments(MimeHeaders headers)` Удаляет весь `AttachmentPart` объекты, у которых есть записи заголовка, которые соответствуют указанные заголовки.
`abstract void`	`saveChanges()` Обновления это `SOAPMessage` объект со всеми изменениями, которые были произведены в этом.
`abstract boolean`	`saveRequired()` Указывает ли это `SOAPMessage` возразите должен иметь метод `saveChanges` обращенный это.
`abstract void`	`setContentDescription(String description)` Устанавливает описание этого `SOAPMessage` контент объекта с данным описанием.
`void`	`setProperty(String property, Object value)` Связывает указанное значение с указанным свойством.
`abstract void`	`writeTo(OutputStream out)` Записи это `SOAPMessage` возразите против данного потока вывода.

Методы java.lang унаследованный от класса. Объект
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Полевая Деталь
  - CHARACTER_SET_ENCODING
```
public static final String CHARACTER_SET_ENCODING
```
    Определяет кодирование символьного типа для сообщения SOAP. Допустимые значения включают "utf-8" и "utf-16". См. документацию поставщика для дополнительных поддерживаемых значений. Значение по умолчанию является "utf-8".
    
    С тех пор:
    
    SAAJ 1.2
    
    См. Также:
    SOAPMessage.setProperty, Постоянные Значения полей
  - WRITE_XML_DECLARATION
```
public static final String WRITE_XML_DECLARATION
```
    Определяет, будет ли сообщение SOAP содержать объявление XML, когда оно будет отправлено. Единственные допустимые значения являются "истиной" и "ложью". Значение по умолчанию является "ложью".
    
    С тех пор:
    
    SAAJ 1.2
    
    См. Также:
    SOAPMessage.setProperty, Постоянные Значения полей
- Деталь конструктора
  - SOAPMessage
```
public SOAPMessage()
```
- Деталь метода
  - setContentDescription
```
public abstract void setContentDescription(String description)
```
    Устанавливает описание этого SOAPMessage контент объекта с данным описанием.
    
    Параметры:
    description - a String описание контента этого сообщения
    См. Также:
    getContentDescription()
  - getContentDescription
```
public abstract String getContentDescription()
```
    Получает описание этого SOAPMessage контент объекта.
    
    Возвраты:
    a String описание контента этого сообщения или null если никакое описание не было установлено
    См. Также:
    setContentDescription(java.lang.String)
  - getSOAPPart
```
public abstract SOAPPart getSOAPPart()
```
    Получает часть SOAP этого SOAPMessage объект.
    SOAPMessage объект содержит одно или более присоединений, Часть SOAP должна быть первой частью тела MIME в сообщении.
    
    Возвраты:
    SOAPPart объект для этого SOAPMessage объект
  - getSOAPBody
```
public SOAPBody getSOAPBody()
                     throws SOAPException
```
    Содержали Тело SOAP в этом SOAPMessage объект.
    
    Возвраты:
    SOAPBody объект содержится этим SOAPMessage объект
    
    Броски:
    
    SOAPException - если Тело SOAP не существует или не может быть получено
    С тех пор:
    
    SAAJ 1.2
  - getSOAPHeader
```
public SOAPHeader getSOAPHeader()
                         throws SOAPException
```
    Содержали Заголовок SOAP в этом SOAPMessage объект.
    
    Возвраты:
    SOAPHeader объект содержится этим SOAPMessage объект
    
    Броски:
    
    SOAPException - если Заголовок SOAP не существует или не может быть получен
    С тех пор:
    
    SAAJ 1.2
  - removeAllAttachments
```
public abstract void removeAllAttachments()
```
    Удаляет все AttachmentPart объекты, которые были добавлены к этому SOAPMessage объект.
    Этот метод не касается части SOAP.
  - countAttachments
```
public abstract int countAttachments()
```
    Получает количество числа присоединений в этом сообщении. Это количество не включает часть SOAP.
    
    Возвраты:
    число AttachmentPart объекты, которые являются частью этого SOAPMessage объект
  - getAttachments
```
public abstract Iterator getAttachments()
```
    Получает весь AttachmentPart объекты, которые являются частью этого SOAPMessage объект.
    
    Возвраты:
    iterator по всем присоединениям в этом сообщении
  - getAttachments
```
public abstract Iterator getAttachments(MimeHeaders headers)
```
    Получает весь AttachmentPart объекты, у которых есть записи заголовка, которые соответствуют указанные заголовки. Отметьте, что у возвращенного присоединения могли быть заголовки в дополнение к определенным.
    
    Параметры:
    headers - a MimeHeaders объект, содержащий заголовки MIME, которые можно искать
    
    Возвраты:
    iterator по всем присоединениям, у которых есть заголовок, который соответствует один из данных заголовков
  - removeAttachments
```
public abstract void removeAttachments(MimeHeaders headers)
```
    Удаляет весь AttachmentPart объекты, у которых есть записи заголовка, которые соответствуют указанные заголовки. Отметьте, что у удаленного присоединения могли быть заголовки в дополнение к определенным.
    
    Параметры:
    headers - a MimeHeaders объект, содержащий заголовки MIME, которые можно искать
    С тех пор:
    
    SAAJ 1.3
  - getAttachment
```
public abstract AttachmentPart getAttachment(SOAPElement element)
                                      throws SOAPException
```
    Возвраты AttachmentPart объект, который связывается с присоединением, на которое ссылается это SOAPElement или null если никакое такое присоединение не существует. Ссылки могут быть сделаны через href припишите как описано в сообщениях SOAP с Присоединениями, или через сингл Text дочерний узел, содержащий URI как описано в Присоединяемом Профиле WS-I 1.0 для элементов схемы, вводит ref:swaRef. Эти два механизма должны поддерживаться. Поддержка ссылок через href атрибут также подразумевает, что этот метод должен также поддерживаться на элементе, который является xop:Include элементом (XOP). другие ссылочные механизмы могут поддерживаться отдельными реализациями этого стандарта. Свяжитесь со своим поставщиком для деталей.
    
    Параметры:
    element - SOAPElement содержа ссылку на Присоединение
    
    Возвраты:
    ссылаемый AttachmentPart или нуль, если не такой AttachmentPart существует или никакая ссылка не может быть найдена в этом SOAPElement.
    
    Броски:
    
    SOAPException - если есть ошибка в попытке получить доступ к присоединению
    С тех пор:
    
    SAAJ 1.3
  - addAttachmentPart
```
public abstract void addAttachmentPart(AttachmentPart AttachmentPart)
```
    Добавляет данный AttachmentPart возразите против этого SOAPMessage объект. AttachmentPart объект должен быть создан прежде, чем он сможет быть добавлен к сообщению.
    
    Параметры:
    AttachmentPart - AttachmentPart объект, который должен стать частью этого SOAPMessage объект
    
    Броски:
    
    IllegalArgumentException
  - createAttachmentPart
```
public abstract AttachmentPart createAttachmentPart()
```
    Создает новое пустое AttachmentPart объект. Отметьте что метод addAttachmentPart должен быть вызван с этим новым AttachmentPart возразите как параметр для этого, чтобы стать присоединением к этому SOAPMessage объект.
    
    Возвраты:
    новое AttachmentPart объект, который может быть заполнен и добавлен к этому SOAPMessage объект
  - createAttachmentPart
```
public AttachmentPart createAttachmentPart(DataHandler dataHandler)
```
    Создает AttachmentPart возразите и заполняет это использующий данный DataHandler объект.
    
    Параметры:
    dataHandler - javax.activation.DataHandler объект, который генерирует контент для этого SOAPMessage объект
    
    Возвраты:
    новое AttachmentPart объект, который содержит данные, сгенерированные данным DataHandler объект
    
    Броски:
    
    IllegalArgumentException - если была проблема с указанным DataHandler объект
    См. Также:
    DataHandler, DataContentHandler
  - getMimeHeaders
```
public abstract MimeHeaders getMimeHeaders()
```
    Возвраты все транспортно-специфичные заголовки MIME для этого SOAPMessage объект независимым от транспорта способом.
    
    Возвраты:
    a MimeHeaders объект, содержащий MimeHeader объекты
  - createAttachmentPart
```
public AttachmentPart createAttachmentPart(Object content,
                                  String contentType)
```
    Создает AttachmentPart возразите и заполняет это с указанными данными указанного типа контента. Тип Object должен соответствовать значению, данному для Content-Type.
    
    Параметры:
    content - Object содержа контент для AttachmentPart объект, который будет создан
    contentType - a String объект, дающий тип контента; примерами является "text/xml", "текст/плоскость", и "image/jpeg"
    
    Возвраты:
    новое AttachmentPart объект, который содержит определенные данные
    
    Броски:
    
    IllegalArgumentException - может быть брошен, если contentType не соответствует тип объекта контента, или если было нет DataContentHandler объект для данного объекта контента
    См. Также:
    DataHandler, DataContentHandler
  - saveChanges
```
public abstract void saveChanges()
                          throws SOAPException
```
    Обновления это SOAPMessage объект со всеми изменениями, которые были произведены в этом. Этот метод вызывают автоматически когда writeTo(OutputStream) вызывается. Однако, если изменения производятся в сообщении, которое было получено или в том, который был уже отправлен, метод saveChanges потребности, которые вызовут явно, чтобы сохранить изменения. Метод saveChanges также генерирует любые изменения, которые могут быть считаны назад (например, MessageId в профилях, которые поддерживают идентификатор сообщения). У всех заголовков MIME в сообщении, которое создается для того, чтобы отправить цели, как гарантируют, будут допустимые значения только после saveChanges был вызван.
    Кроме того, этот метод отмечает точку в который данные от всей составляющей AttachmentPart объекты вытягивают в сообщение.
    
    Броски:
    
    SOAPException - если была проблема, сохраняющая изменения к этому сообщению.
    
    SOAPException
  - saveRequired
```
public abstract boolean saveRequired()
```
    Указывает ли это SOAPMessage возразите должен иметь метод saveChanges обращенный это.
    
    Возвраты:
    true если saveChanges потребности, которые вызовут; false иначе.
  - writeTo
```
public abstract void writeTo(OutputStream out)
                      throws SOAPException,
                             IOException
```
    Записи это SOAPMessage возразите против данного потока вывода. Формат воплощения как определяется SOAP 1.1 с Присоединяемой спецификацией.
    Если нет никаких присоединений, только поток XML выписывается. Для тех сообщений, у которых есть присоединения, writeTo пишет закодированный MIME поток байтов.
    Отметьте, что этот метод не пишет транспортно-специфичные Заголовки MIME сообщения
    
    Параметры:
    out - OutputStream возразите против который это SOAPMessage объект будет записан
    
    Броски:
    
    IOException - если ошибка ввода-вывода происходит
    
    SOAPException - если была проблема в воплощении этого сообщения SOAP
  - setProperty
```
public void setProperty(String property,
               Object value)
                 throws SOAPException
```
    Связывает указанное значение с указанным свойством. Если уже было значение, связанное с этим свойством, старое значение заменяется.
    Допустимые имена свойства включают WRITE_XML_DECLARATION и CHARACTER_SET_ENCODING. Все эти стандартные свойства SAAJ снабжаются префиксом "javax.xml.soap". Поставщики могут также добавить реализацию определенные свойства. Эти свойства должны быть снабжены префиксом имена пакета, которые уникальны для поставщика.
    Установка свойства WRITE_XML_DECLARATION к "true" заставит XML Объявление быть выписанным в начале сообщения SOAP. Значение по умолчанию "лжи" подавляет это объявление.
    Свойство CHARACTER_SET_ENCODING значения по умолчанию к значению "utf-8" который заставляет сообщение SOAP быть закодированным, используя UTF-8. Установка CHARACTER_SET_ENCODING к "utf-16" заставляет сообщение SOAP быть закодированным, используя UTF-16.
    Некоторые реализации могут позволить кодировки в дополнение к UTF-8 и UTF-16. Сошлитесь на документацию своего поставщика для деталей.
    
    Параметры:
    property - свойство, с которым должно быть связано указанное значение.
    value - значение, которое будет связано с указанным свойством
    
    Броски:
    
    SOAPException - если имя свойства не распознается.
    С тех пор:
    
    SAAJ 1.2
  - getProperty
```
public Object getProperty(String property)
                   throws SOAPException
```
    Получает значение указанного свойства.
    
    Параметры:
    property - имя свойства, чтобы получить
    
    Возвраты:
    значение, связанное с именованным свойством или null если никакое такое свойство не существует.
    
    Броски:
    
    SOAPException - если имя свойства не распознается.
    С тех пор:
    
    SAAJ 1.2

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.

Класс SOAPMessage

Полевая Сводка

Сводка конструктора

Сводка метода

Методы java.lang унаследованный от класса. Объект

Полевая Деталь

CHARACTER_SET_ENCODING

WRITE_XML_DECLARATION

Деталь конструктора

SOAPMessage

Деталь метода

setContentDescription

getContentDescription

getSOAPPart

getSOAPBody

getSOAPHeader

removeAllAttachments

countAttachments

getAttachments

getAttachments

removeAttachments

getAttachment

addAttachmentPart

createAttachmentPart

createAttachmentPart

getMimeHeaders

createAttachmentPart

saveChanges

saveRequired

writeTo

setProperty

getProperty