Класс SOAPPart

public abstract class SOAPPart
extends Object
implements Document, Node

Контейнер для части объекта SOAP-специфичной части объекта SOAPMessage. Все сообщения должны иметь часть SOAP, поэтому при создании объекта SOAPMessage, он автоматически будет содержать объект SOAPPart.

Объект SOAPPart является MIME-частью и имеет MIME-заголовки Content-Id, Content-Location и Content-Type. Поскольку значение Content-Type должно быть «text/xml», объект SOAPPart автоматически имеет MIME-заголовок Content-Type со значением, установленным в «text/xml». Значение должно быть «text/xml», потому что содержимое в части SOAP сообщения должно быть в формате XML. Содержимое, которое не имеет типа «text/xml», должно быть в объекте AttachmentPart вместо объекта SOAPPart.

При отправке сообщения его часть SOAP должна иметь MIME-заголовок Content-Type, установленный в «text/xml». Или, с другой стороны, часть SOAP любого полученного сообщения должна иметь MIME-заголовок Content-Type со значением «text/xml».

Клиент может получить доступ к объекту SOAPPart объекта SOAPMessage, вызвав метод SOAPMessage.getSOAPPart. Следующая строка кода, в которой message — это объект SOAPMessage, извлекает часть SOAP сообщения.

SOAPPart soapPart = message.getSOAPPart();

Объект SOAPPart содержит объект SOAPEnvelope, который в свою очередь содержит объект SOAPBody и объект SOAPHeader. Метод SOAPPart getEnvelope может быть использован для получения объекта SOAPEnvelope.

Конструкторы

SOAPPart

public SOAPPart()

Методы

getEnvelope

public abstract SOAPEnvelope getEnvelope()
                                  throws SOAPException

Получает объект SOAPEnvelope , связанный с этим объектом SOAPPart. После получения SOAP-огибающей, её содержимое можно получить.

Возвращает:

объект SOAPEnvelope для этого объекта SOAPPart

Исключение:

SOAPException - если произошла ошибка SOAP

getContentId

public String getContentId()

Извлекает значение MIME-заголовка с именем "Content-Id".

Возвращает:

строку String , содержащую значение MIME-заголовка с именем "Content-Id"

См. также:

setContentId(java.lang.String)

getContentLocation

public String getContentLocation()

Извлекает значение MIME-заголовка с именем "Content-Location".

Возвращает:

строку String , содержащую значение MIME-заголовка с именем "Content-Location"

См. также:

setContentLocation(java.lang.String)

setContentId

public void setContentId(String contentId)

Устанавливает значение MIME-заголовка с именем "Content-Id" на указанное значение String.

Параметры:

contentId - строка String , содержащая значение MIME-заголовка "Content-Id"

Исключение:

IllegalArgumentException - если возникла проблема при установке идентификатора содержимого

См. также:

getContentId()

setContentLocation

public void setContentLocation(String contentLocation)

Устанавливает значение MIME-заголовка "Content-Location" на указанное значение String.

Параметры:

contentLocation - строка String , содержащая значение MIME-заголовка "Content-Location"

Исключение:

IllegalArgumentException - если возникла проблема при установке расположения содержимого.

См. также:

getContentLocation()

removeMimeHeader

public abstract void removeMimeHeader(String header)

Удаляет все MIME-заголовки, соответствующие заданному имени.

Параметры:

header - строка String , содержащая имя(а) MIME-заголовка(ов) для удаления

removeAllMimeHeaders

public abstract void removeAllMimeHeaders()

Удаляет все объекты MimeHeader для этого объекта SOAPEnvelope.

getMimeHeader

public abstract String[] getMimeHeader(String name)

Получает все значения объекта MimeHeader в этом объекте SOAPPart , идентифицированные заданным именем String.

Параметры:

name - имя заголовка; например: "Content-Type"

Возвращает:

массив строк String , содержащий все значения для указанного заголовка

См. также:

setMimeHeader(java.lang.String, java.lang.String)

setMimeHeader

public abstract void setMimeHeader(String name,
                                   String value)

Параметры:

name - строка String , содержащая имя заголовка для поиска

value - строка String , содержащая значение для установки. Это значение будет заменено на текущее(ые) значение(я) первого заголовка, который соответствует, если таковой существует. Если совпадения нет, это значение будет значением для нового объекта MimeHeader.

Исключение:

IllegalArgumentException - если возникла проблема с указанным именем или значением MIME-заголовка

См. также:

getMimeHeader(java.lang.String)

addMimeHeader

public abstract void addMimeHeader(String name,
                                   String value)

Параметры:

name - строка String , содержащая имя заголовка

value - строка String , содержащая значение для установки или добавления

Исключение:

IllegalArgumentException - если возникла проблема с указанным именем или значением MIME-заголовка

getAllMimeHeaders

public abstract Iterator getAllMimeHeaders()

Извлекает все заголовки для этого объекта SOAPPart в виде итератора по объектам MimeHeader.

Возвращает:

объект Iterator со всеми заголовками Mime для этого объекта SOAPPart

getMatchingMimeHeaders

public abstract Iterator getMatchingMimeHeaders(String[] names)

Извлекает все объекты MimeHeader , которые соответствуют имени в заданном массиве.

Параметры:

names - массив строк String с именем(ами) MIME-заголовков, которые должны быть возвращены

Возвращает:

все MIME-заголовки, которые соответствуют одному из имён в заданном массиве, возвращённые в виде объекта Iterator

getNonMatchingMimeHeaders

public abstract Iterator getNonMatchingMimeHeaders(String[] names)

Извлекает все объекты MimeHeader , чьё имя не соответствует имени в заданном массиве.

Параметры:

names - массив строк String с именем(ами) MIME-заголовков, которые не должны быть возвращены

Возвращает:

все MIME-заголовки в этом объекте SOAPPart за исключением тех, которые соответствуют одному из имён в заданном массиве. Несоответствующие MIME-заголовки возвращаются в виде объекта Iterator.

setContent

public abstract void setContent(Source source)
                         throws SOAPException

Устанавливает содержимое объекта SOAPEnvelope с данными из указанного объекта Source. Этот объект Source должен содержать допустимый SOAP-документ.

Параметры:

source - объект javax.xml.transform.Source с данными, которые необходимо установить

Исключение:

SOAPException - если возникла проблема при установке источника

См. также:

getContent()

getContent

public abstract Source getContent()
                           throws SOAPException

Возвращает содержимое SOAPEnvelope в виде объекта JAXP Source.

Возвращает:

содержимое в виде объекта javax.xml.transform.Source

Исключение:

SOAPException - если реализация не может преобразовать указанный объект Source

См. также:

setContent(javax.xml.transform.Source)