T.M. SoftStudio

feci quod potui, faciant meliora potentes

JAXM API и SAAJ API

Пакет javax.xml.soap

    Интерфейс Detail. Представляет дочерние элементы Detail элемента Fault SOAP-сообщения; расширяет SOAPFaultElement.

Интерфейс имеет следующие методы.

  • DetailEntry addDetailEntry(Name name)

Добавляет новый элемент Detail с указанным именем.

  • DetailEntry addDetailEntry(QName qname)

Добавляет новый элемент Detail с указанным QName-именем.

  • Iterator getDetailEntries()

Возвращает итератор элементов Detail.

    Интерфейс DetailEntry. Представляет дочерний элемент Detail элемента Fault SOAP-сообщения, идентифицированный полным именем; расширяет SOAPElement.

    Интерфейс Name. Представляет XML-имя и имеет следующие методы:

  • String getLocalName()

Возвращает локальное имя XML-элемента.

  • String getQualifiedName()

Возвращает локальное имя с префиксом пространства имен.

  • String getPrefix()

Возвращает префикс пространства имен.

  • String getURI()

Возвращает пространство имен.

    Интерфейс Node. Представляет узел XML-документа и имеет следующие методы:

  • String getValue()

Возвращает значение узла.

  • void setValue(String value)

Устанавливает значение узла.

  • void setParentElement(SOAPElement parent)

Устанавливает родительский узел для данного узла.

  • SOAPElement getParentElement()

Возвращает родительский узел для данного узла.

  • void detachNode()

Удаляет данный узел.

  • void recycleNode()

Вызывается после метода detachNode() и дает возможность использования удаленного узла повторно в дальнейшем.

    Интерфейс SOAPBody. Представляет тело SOAP-сообщения, расширяет SOAPElement и имеет следующие методы.

  • SOAPFault addFault()

Добавляет элемент Fault в тело SOAP-сообщения.

  • SOAPFault addFault(Name faultCode, String faultString, Locale locale)

Добавляет элемент Fault в тело SOAP-сообщения с дочерним элементом, имеющим указанное имя кода ошибки, и дочерним элементом причины ошибки. Параметр Locale указывает язык текста причины ошибки.

  • SOAPFault addFault(QName faultCode, String faultString, Locale locale)

Добавляет элемент Fault в тело SOAP-сообщения с дочерним элементом, имеющим указанное QName-имя кода ошибки, и дочерним элементом причины ошибки. Параметр Locale указывает язык текста причины ошибки.

  • SOAPFault addFault(Name faultCode, String faultString)

Добавляет элемент Fault в тело SOAP-сообщения с дочерним элементом, имеющим указанное имя кода ошибки, и дочерним элементом причины ошибки.

  • SOAPFault addFault(QName faultCode, String faultString)

Добавляет элемент Fault в тело SOAP-сообщения с дочерним элементом, имеющим указанное QName-имя кода ошибки, и дочерним элементом причины ошибки.

  • boolean hasFault()

Указывает, существует ли элемент Fault в теле SOAP-сообщения.

  • SOAPFault getFault()

Возвращает элемент Fault тела SOAP-сообщения.

  • SOAPBodyElement addBodyElement(Name name)

Добавляет новый элемент с указанным именем в тело SOAP-сообщения.

  • SOAPBodyElement addBodyElement(QName qname)

Добавляет новый элемент с указанным QName-именем в тело SOAP-сообщения.

  • SOAPBodyElement addDocument(Document document)

Добавляет корневой элемент в тело SOAP-сообщения.

  • Document extractContentAsDocument()

Возвращает объект, представляющий содержимое тела SOAP-сообщения.

    Интерфейс SOAPBodyElement. Представляет элемент тела SOAP-сообщения, расширяет SOAPElement.

    Интерфейс SOAPConstants. Определяет константы, относящиеся к SOAP-протоколу.

    Интерфейс SOAPElement. Базовый интерфейс для элементов SOAP-сообщения.

Интерфейс имеет следующие методы.

  • SOAPElement addChildElement(Name name)

Добавляет дочерний элемент с указанным именем.

  • SOAPElement addChildElement(QName qname)

Добавляет дочерний элемент с указанным QName-именем.

  • SOAPElement addChildElement(String localName)

Добавляет дочерний элемент с указанным локальным именем.

  • SOAPElement addChildElement(String localName, String prefix)

Добавляет дочерний элемент с указанным локальным именем и префиксом.

  • SOAPElement addChildElement(String localName, String prefix,
    String uri)

Добавляет дочерний элемент с указанным локальным именем, префиксом и пространством имен.

  • SOAPElement addChildElement(SOAPElement element)

Добавляет определенный дочерний элемент.

  • void removeContents()

Удаляет содержимое элемента.

  • SOAPElement addTextNode(String text)

Добавляет текстовое значение элемента.

  • SOAPElement addAttribute(Name name, String value)

Добавляет атрибут с указанным именем и значением в элемент.

  • SOAPElement addAttribute(QName qname, String value)

Добавляет атрибут с указанным QName-именем и значением в элемент.

  • SOAPElement addNamespaceDeclaration(String prefix, String uri)

Добавляет объявление пространства имен в элемент.

  • String getAttributeValue(Name name)

Возвращает значение атрибута с указанным именем.

  • String getAttributeValue(QName qname)

Возвращает значение атрибута с указанным QName-именем.

  • Iterator getAllAttributes()

Возвращает итератор имен атрибутов элемента.

  • Iterator getAllAttributesAsQNames()

Возвращает итератор QName-имен атрибутов элемента.

  • String getNamespaceURI(String prefix)

Возвращает пространство имен элемента для указанного префикса.

  • Iterator getNamespacePrefixes()

Возвращает итератор префиксов пространств имен элемента.

  • Iterator getVisibleNamespacePrefixes()

Возвращает итератор префиксов пространств имен видимой области элемента.

  • QName createQName(String localName, String prefix)

Создает QName-имя элемента.

  • Name getElementName()

Возвращает имя элемента.

  • QName getElementQName()

Возвращает QName-имя элемента.

  • SOAPElement setElementQName(QName newName)

Изменяет имя элемента.

  • boolean removeAttribute(Name name)

Удаляет атрибут с указанным именем.

  • boolean removeAttribute(QName qname)

Удаляет атрибут с указанным QName-именем.

  • boolean removeNamespaceDeclaration(String prefix)

Удаляет объявление пространства имен элемента.

  • Iterator getChildElements()

Возвращает итератор дочерних элементов данного элемента.

  • Iterator getChildElements(Name name)

Возвращает итератор дочерних элементов с указанным именем.

  • Iterator getChildElements(QName qname)

Возвращает итератор дочерних элементов с указанным QName-именем.

  • void setEncodingStyle(String encodingStyle)

Устанавливает стиль кодировки для данного элемента.

  • String getEncodingStyle()

Возвращает стиль кодировки элемента.

    Интерфейс SOAPEnvelope. Представляет элемент Envelope SOAP-сообщения, расширяет SOAPElement и имеет следующие методы:

  • Name createName(String localName, String prefix, String uri)

Создает имя элемента, состоящее из локального имени, префикса и пространства имен.

  • Name createName(String localName)

Создает имя элемента из локального имени.

  • SOAPHeader getHeader()

Возвращает заголовок SOAP-сообщения.

  • SOAPBody getBody()

Возвращает тело SOAP-сообщения.

  • SOAPHeader addHeader()

Добавляет заголовок SOAP-сообщения.

  • SOAPBody addBody()

Добавляет тело SOAP-сообщения.

    Интерфейс SOAPFault. Представляет элемент Fault SOAP-сообщения, расширяет SOAPBodyElement и имеет следующие методы:

  • void setFaultCode(Name faultCodeQName)

Устанавливает элемент Fault с именованным кодом ошибки.

  • void setFaultCode(QName faultCodeQName)

Устанавливает элемент Fault с QName-именованным кодом ошибки.

  • void setFaultCode(String faultCode)

Устанавливает элемент Fault с именованным строкой кодом ошибки.

  • Name getFaultCodeAsName()

Возвращает имя кода ошибки.

  • QName getFaultCodeAsQName()

Возвращает QName-имя кода ошибки.

  • Iterator getFaultSubcodes()

Возвращает итератор подкодов ошибки.

  • void removeAllFaultSubcodes()

Удаляет подкоды ошибки.

  • void appendFaultSubcode(QName subcode)

Добавляет подкод ошибки.

  • String getFaultCode()

Возвращает код ошибки.

  • void setFaultActor(String faultActor)

Устанавливает адресат, вызвавший ошибку.

  • String getFaultActor()

Возвращает идентификатор адресата, вызвавшего ошибку.

  • void setFaultString(String faultString)

Устанавливает текст причины ошибки.

  • void setFaultString(String faultString, Locale locale)

Устанавливает текст причины ошибки и его язык.

  • String getFaultString()

Возвращает текст причины ошибки.

  • Locale getFaultStringLocale()

Возвращает язык текста причины ошибки.

  • boolean hasDetail()

Возвращает true, если есть элемент Detail.

  • Detail getDetail()

Возвращает объект Detail.

  • Detail addDetail()

Добавляет объект Detail.

  • Iterator getFaultReasonLocales()

Возвращает итератор языков элементов Reason/Text.

  • Iterator getFaultReasonTexts()

Возвращает итератор элементов Reason/Text.

  • String getFaultReasonText(Locale locale)

Возвращает значение элемента Reason/Text с указанным языком.

  • void addFaultReasonText(String text, Locale locale)

Добавляет значение элемента Reason/Text с указанным языком.

  • String getFaultNode()

Возвращает значение элемента Node.

  • void setFaultNode(String uri)

Устанавливает значение элемента Node.

  • String getFaultRole()

Возвращает значение элемента Role.

  • void setFaultRole(String uri)

Устанавливает значение элемента Role.

    Интерфейс SOAPFaultElement. Представляет дочерние элементы элемента Fault, расширяет SOAPElement.

    Интерфейс SOAPHeader. Представляет заголовок SOAP-сообщения, расширяет SOAPElement и имеет следующие методы:

  • SOAPHeaderElement addHeaderElement(Name name)

Добавляет новый блок заголовка с указанным именем.

  • SOAPHeaderElement ddHeaderElement(QName qname)

Добавляет новый блок заголовка с указанным QName-именем.

  • Iterator examineMustUnderstandHeaderElements(String actor)

Возвращает итератор блоков заголовка для указанного адресата и с атрибутом MustUnderstand="true".

  • Iterator examineHeaderElements(String actor)

Возвращает итератор блоков заголовка для указанного адресата.

  • Iterator extractHeaderElements(String actor)

Возвращает итератор блоков заголовка для указанного адресата и удаляет их.

  • SOAPHeaderElement addNotUnderstoodHeaderElement(QName name)

Добавляет блок заголовка NotUnderstood в сообщении об ошибке.

  • SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs)

Добавляет блок заголовка Upgrade в сообщении об ошибке с указанным списком URI поддерживаемых SOAP-спецификаций.

  • SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris)

Добавляет блок заголовка Upgrade в сообщении об ошибке с указанным массивом URI поддерживаемых SOAP-спецификаций.

  • SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri)

Добавляет блок заголовка Upgrade в сообщении об ошибке с указанным URI поддерживаемой SOAP-спецификации.

  • Iterator examineAllHeaderElements()

Возвращает итератор блоков заголовков.

  • Iterator extractAllHeaderElements()

Возвращает итератор блоков заголовков и удаляет их.

    Интерфейс SOAPHeaderElement. Представляет блок заголовка, расширяет SOAPElement и имеет следующие методы:

  • void setActor(String actorURI)

Устанавливает адресата блока заголовка, по умолчанию SOAPConstants.URI_SOAP_ACTOR_NEXT.

  • void setRole(String uri)

Устанавливает значение атрибута Role.

  • String getActor()

Возвращает значение атрибута actor.

  • String getRole()

Возвращает значение атрибута Role.

  • void setMustUnderstand(boolean mustUnderstand)

Устанавливает значение атрибута mustUnderstand.

  • boolean getMustUnderstand()

Возвращает значение атрибута mustUnderstand.

  • void setRelay(boolean relay)

Устанавливает значение атрибута relay.

  • boolean getRelay()

Возвращает значение атрибута relay.

    Интерфейс Text. Представляет элемент Text, имеет метод boolean isComment(), возвращающий true, если содержимое элемента — комментарии.

    Класс AttachmentPart. Представляет вложение SOAP-сообщения, состоящее из MIME-заголовков и самого вложения.

Класс имеет следующие методы.

  • public abstract int getSize()

Возвращает размер вложения в байтах.

  • public abstract void clearContent()

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

  • public abstract Object getContent()

Возвращает содержимое вложения как объект.

  • public abstract InputStream getRawContent()

Возвращает содержимое вложения как поток.

  • public abstract byte[] getRawContentBytes()

Возвращает содержимое вложения как массив.

  • public abstract InputStream getBase64Content()

Возвращает содержимое вложения как поток Base64-символов.

  • public abstract void setContent(Object object, String contentType)

Устанавливает содержимое вложения из объекта с указанным заголовком Content-Type.

  • public abstract void setRawContent(InputStream content,
    String contentType)

Устанавливает содержимое вложения из потока с указанным заголовком Content-Type.

  • public abstract void setRawContentBytes(byte[] content, int offset,
    int len, String contentType)

Устанавливает содержимое вложения из массива с указанным заголовком Content-Type.

  • public abstract void setBase64Content(InputStream content,
    String contentType)

Устанавливает содержимое вложения из Base64-потока с указанным заголовком Content-Type.

  • public abstract DataHandler getDataHandler()

Возвращает объект класса javax.activation.DataHandler, предназначенный для управления данными.

  • public abstract void setDataHandler(DataHandler dataHandler)

Устанавливает объект DataHandler для вложения.

  • public String getContentId()

Возвращает значение MIME-заголовка Content-ID.

  • public String getContentLocation()

Возвращает значение MIME-заголовка Content-Location.

  • public String getContentType()

Возвращает значение MIME-заголовка Content-Type.

  • public void setContentId(String contentId)

Устанавливает значение MIME-заголовка Content-ID.

  • public void setContentLocation(String contentLocation)

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

  • public void setContentType(String contentType)

Устанавливает значение MIME-заголовка Content-Type.

  • public abstract void removeMimeHeader(String header)

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

  • public abstract void removeAllMimeHeaders()

Удаляет все MIME-заголовки.

  • public abstract String[] getMimeHeader(String name)

Возвращает значения MIME-заголовков с указанным именем.

  • public abstract void setMimeHeader(String name, String value)

Изменяет значение MIME-заголовка с указанным именем.

  • public abstract void addMimeHeader(String name, String value)

Добавляет MIME-заголовок с указанным именем и значением.

  • public abstract Iterator getAllMimeHeaders()

Возвращает итератор MIME-заголовков.

  • public abstract Iterator getMatchingMimeHeaders(String[] names)

Возвращает итератор MIME-заголовков с фильтром по именам.

  • public abstract Iterator getNonMatchingMimeHeaders(String[] names)

Возвращает итератор MIME-заголовков с фильтром по несовпадению имен.

    Класс MessageFactory. Класс-фабрика для создания объектов SOAPMessage, представляющих SOAP-сообщения.

Класс имеет следующие методы.

  • public static MessageFactory newInstance()

Создает новый объект MessageFactory, соответствующий реализации протокола SOAP 1.1 по умолчанию.

  • public static MessageFactory newInstance(String protocol)

Создает новый объект MessageFactory, соответствующий указанной реализации протокола, например SOAPConstants.SOAP_1_2_PROTOCOL.

  • public abstract SOAPMessage createMessage()

Создает новое SOAP-сообщение с заголовком и телом по умолчанию.

  • public abstract SOAPMessage createMessage(MimeHeaders headers,
    InputStream in)

Создает новое SOAP-сообщение из потока.

    Класс MimeHeader. Представляет MIME-заголовок и имеет следующие методы.

  • public String getName()

Возвращает имя заголовка.

  • public String getValue()

Возвращает значение заголовка.

    Класс MimeHeaders. Является контейнером для объектов MimeHeader и имеет следующие методы.

  • public String[] getHeader(String name)

Возвращает все значения заголовка с указанным именем.

  • public void setHeader(String name, String value)

Изменяет значение заголовка с указанным именем.

  • public void addHeader(String name, String value)

Добавляет заголовок в контейнер.

  • public void removeHeader(String name)

Удаляет заголовки с указанным именем из контейнера.

  • public void removeAllHeaders()

Удаляет все заголовки из контейнера.

  • public Iterator getAllHeaders()

Возвращает итератор заголовков в контейнере.

  • public Iterator getMatchingHeaders(String[] names)

Возвращает итератор заголовков в контейнере с фильтром по именам.

  • public Iterator getNonMatchingHeaders(String[] names)

Возвращает итератор заголовков в контейнере с фильтром по несовпадению имен.

    Класс SAAJMetaFactory. Класс реализации спецификации SAAJ.

    Класс SAAJResult. Представляет результаты преобразования JAXP или JAXB в виде дерева.

Класс имеет метод public Node getResult(), возвращающий результирующее дерево.

    Класс SOAPConnection. Представляет соединение клиента с адресатом и имеет следующие методы.

  • public abstract SOAPMessage call(SOAPMessage request, Object to)

Посылает синхронный запрос конечной точке, определенной вторым параметром типа java.lang.String, java.net.URL или javax.xml.messaging.URLEndpoint.

  • public SOAPMessage get(Object to)

Получает сообщение от конечной точки.

  • public abstract void close()

Закрывает соединение.

    Класс SOAPConnectionFactory. Класс-фабрика для создания объектов SOAPConnection.

Класс имеет следующие методы.

  • public static SOAPConnectionFactory newInstance()

Создает объект SOAPConnectionFactory.

  • public abstract SOAPConnection createConnection()

Создает соединение SOAPConnection.

    Класс SOAPFactory. Класс-фабрика для создания XML-фрагментов.

Класс имеет следующие методы:

  • public SOAPElement createElement(Element domElement)

Создает SOAP-элемент из DOM-элемента.

  • public abstract SOAPElement createElement(Name name)

Создает SOAP-элемент с указанным именем.

  • public SOAPElement createElement(QName qname)

Создает SOAP-элемент с указанным QName-именем.

  • public abstract SOAPElement createElement(String localName)

Создает SOAP-элемент с указанным локальным именем.

  • public abstract SOAPElement createElement(String localName,
    String prefix, String uri)

Создает SOAP-элемент с указанным локальным именем, префиксом и пространством имен.

  • public abstract Detail createDetail()

Создает новый объект Detail.

  • public abstract SOAPFault createFault(String reasonText,
    QName faultCode)

Создает новый объект Fault с кодом ошибки и ее причинами.

  • public abstract SOAPFault createFault()

Создает новый объект Fault по умолчанию.

  • public abstract Name createName(String localName, String prefix,
    String uri)

Создает имя из локального имени, префикса и пространства имен.

  • public abstract Name createName(String localName)

Формирует имя из локального имени.

  • public static SOAPFactory newInstance()

Создает новый объект SOAPFactory для протокола SOAP 1.1.

  • public static SOAPFactory newInstance(String protocol)

Создает новый объект SOAPFactory для указанного протокола.

    Класс SOAPMessage. Представляет SOAP-сообщение и имеет следующие методы.

  • public abstract void setContentDescription(String description)

Устанавливает описание содержимого сообщения.

  • public abstract String getContentDescription()

Возвращает описание содержимого сообщения.

  • public abstract SOAPPart getSOAPPart()

Возвращает основную часть сообщения, состоящую из MIME-заголовков, Envelope-, Body- и Header-элементов.

  • public SOAPBody getSOAPBody()

Возвращает тело сообщения.

  • public SOAPHeader getSOAPHeader()

Возвращает заголовок сообщения.

  • public abstract void removeAllAttachments()

Удаляет все вложения сообщения.

  • public abstract int countAttachments()

Возвращает количество вложений.

  • public abstract Iterator getAttachments()

Возвращает итератор вложений.

  • public abstract Iterator getAttachments(MimeHeaders headers)

Возвращает итератор вложений с фильтрацией по заголовкам.

  • public abstract void removeAttachments(MimeHeaders headers)

Удаляет вложения с фильтрацией по заголовкам.

  • public abstract AttachmentPart getAttachment(SOAPElement element)

Возвращает вложение по ссылке.

  • public abstract void addAttachmentPart(AttachmentPart AttachmentPart)

Добавляет вложение.

  • public abstract AttachmentPart createAttachmentPart()

Создает новое пустое вложение.

  • public AttachmentPart createAttachmentPart
    (javax.activation.DataHandler dataHandler)

Создает новое вложение.

  • public abstract MimeHeaders getMimeHeaders()

Возвращает MIME-заголовки.

  • public AttachmentPart createAttachmentPart(Object content,
    String contentType)

Создает новое вложение с содержимым.

  • public abstract void saveChanges()

Обновляет объект SOAPMessage.

  • public abstract boolean saveRequired()

Если возвращает true, тогда требуется вызов метода saveChanges().

  • public abstract void writeTo(OutputStream out)

Создает исходящий поток сообщения.

  • public void setProperty(String property, Object value)

Устанавливает свойства объекта SOAPMessage такие как WRITE_XML_DECLARATION и CHARACTER_SET_ENCODING.

  • public Object getProperty(String property)

Возвращает значение свойства объекта SOAPMessage.

    Класс SOAPPart. Представляет часть SOAP-сообщения, состоящую из MIME-заголовков, Envelope-, Body- и Header-элементов.

Класс имеет следующие методы.

  • public abstract SOAPEnvelope getEnvelope()

Возвращает конверт сообщения.

  • public String getContentId()

Возвращает MIME-заголовок Content-Id.

  • public String getContentLocation()

Возвращает MIME-заголовок Content-Location.

  • public void setContentId(String contentId)

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

  • public void setContentLocation(String contentLocation)

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

  • public abstract void removeMimeHeader(String header)

Удаляет MIME-заголовки с данным именем.

  • public abstract void removeAllMimeHeaders()

Удаляет все MIME-заголовки.

  • public abstract String[] getMimeHeader(String name)

Возвращает значения MIME-заголовка.

  • public abstract void setMimeHeader(String name, String value)

Устанавливает MIME-заголовок.

  • public abstract void addMimeHeader(String name, String value)

Добавляет MIME-заголовок.

  • public abstract Iterator getAllMimeHeaders()

Возвращает итератор MIME-заголовков.

  • public abstract Iterator getMatchingMimeHeaders(String[] names)

Возвращает итератор MIME-заголовков с фильтрацией по именам.

  • public abstract Iterator getNonMatchingMimeHeaders(String[] names)

Возвращает итератор MIME-заголовков с фильтрацией по несоответствию именам.

  • public abstract void setContent(javax.xml.transform.Source source)

Устанавливает содержимое конверта сообщения.

  • public abstract Source getContent()

Возвращает содержимое конверта сообщения.

    Исключение SOAPException. Представляет ошибки, связанные с установлением соединения, отправкой сообщения и др.



Как видно из приведенного списка, пакет javax.xml.soap дает возможность создания и детальной обработки SOAP-сообщений. Кроме того, пакет javax.xml.soap с помощью класса SOAPConnection позволяет установить соединение с конечной точкой и отправить/получить от нее синхронное сообщение.