javax.xml.soap

Класс MessageFactory

java.lang. Объект

javax.xml.soap. MessageFactory

public abstract class MessageFactory
extends Object

Фабрика для того, чтобы создать SOAPMessage объекты.

Клиент SAAJ может создать a MessageFactory объект используя метод newInstance, как показано в следующих строках кода.

       MessageFactory mf = MessageFactory.newInstance();
       MessageFactory mf12 = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);
 

Все MessageFactory объекты, независимо от того, как они создаются, произведут SOAPMessage объекты, у которых есть следующие элементы по умолчанию:

• A SOAPPart объект
• A SOAPEnvelope объект
• A SOAPBody объект
• A SOAPHeader объект

В некоторых случаях специализированные объекты MessageFactory могут быть получены, которые производят сообщения, предварительно заполненные с дополнительными записями в SOAPHeader возразите и SOAPBody объект. Контент нового SOAPMessage объект зависит от который из двух MessageFactory методы используются, чтобы создать это.

• createMessage()
  Это - клиенты метода, обычно использовал бы, чтобы создать сообщение запроса.
• createMessage(MimeHeaders, java.io.InputStream) - у сообщения есть контент от InputStream объект и заголовки от MimeHeaders объект
  Этот метод может использоваться внутренне реализацией службы, чтобы создать сообщение, которое является ответом на запрос.

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

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

Конструктор и Описание
MessageFactory()

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

Методы

Модификатор и Тип	Метод и Описание
abstract SOAPMessage	createMessage() Создает новое SOAPMessage объект со значением по умолчанию SOAPPart, SOAPEnvelope, SOAPBody, и SOAPHeader объекты.
abstract SOAPMessage	createMessage(MimeHeaders headers, InputStream in) Усваивает содержание данного InputStream объект в новое SOAPMessage возразите и возвращается SOAPMessage объект.
static MessageFactory	newInstance() Создает новое MessageFactory объект, который является экземпляром реализации по умолчанию (SOAP 1.1), Этот метод, использует следующую упорядоченную процедуру поиска, чтобы определить класс реализации MessageFactory загрузки: Используйте javax.xml.soap. Системное свойство MessageFactory.
static MessageFactory	newInstance(String protocol) Создает новое MessageFactory объект, который является экземпляром указанной реализации.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

MessageFactory

public MessageFactory()

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

newInstance

public static MessageFactory newInstance()
                                  throws SOAPException

Создает новое MessageFactory объект, который является экземпляром реализации по умолчанию (SOAP 1.1), Этот метод, использует следующую упорядоченную процедуру поиска, чтобы определить класс реализации MessageFactory загрузки:

• Используйте javax.xml.soap. Системное свойство MessageFactory.
• Используйте файл свойств "lib/jaxm.properties" в каталоге JRE. Этот конфигурационный файл находится в стандарте java.util. Свойства форматируют, и содержит полностью определенное имя класса реализации с ключом, являющимся системным свойством, определенным выше.
• Используйте API Служб (как детализировано в спецификации JAR), при наличии, чтобы определить имя класса. API Служб будет искать имя класса в файле META-INF/services/javax.xml.soap.MessageFactory во флягах, доступных времени выполнения.
• Используйте экземпляр SAAJMetaFactory, чтобы определить местоположение класса реализации MessageFactory.

Возвраты:

новый экземпляр a MessageFactory

Броски:

SOAPException - если была ошибка в создании реализации по умолчанию MessageFactory.

См. Также:

SAAJMetaFactory

newInstance

public static MessageFactory newInstance(String protocol)
                                  throws SOAPException

Создает новое MessageFactory объект, который является экземпляром указанной реализации. Может быть динамическая фабрика сообщения, SOAP 1.1 фабрики сообщения, или SOAP 1.2 фабрики сообщения. Динамическая фабрика сообщения создает сообщения, основанные на заголовках MIME, определенных как параметры createMessage метод. Этот метод использует SAAJMetaFactory, чтобы определить местоположение класса реализации и создать экземпляр MessageFactory.

Параметры:

protocol - строковая константа, представляющая класс указанной реализации фабрики сообщения. Может быть также DYNAMIC_SOAP_PROTOCOL, DEFAULT_SOAP_PROTOCOL (который является тем же самым как), SOAP_1_1_PROTOCOL, или SOAP_1_2_PROTOCOL.

Возвраты:

новый экземпляр a MessageFactory

Броски:

SOAPException - если была ошибка в создании указанной реализации MessageFactory.

С тех пор:

SAAJ 1.3

См. Также:

SAAJMetaFactory

createMessage

public abstract SOAPMessage createMessage()
                                   throws SOAPException

Создает новое SOAPMessage объект со значением по умолчанию SOAPPart, SOAPEnvelope, SOAPBody, и SOAPHeader объекты. Специфичные для профиля фабрики сообщения могут хотеть предварительно заполнять SOAPMessage объект со специфичными для профиля заголовками.

Контент может быть добавлен к этому сообщению SOAPPart объект, и сообщение могут быть отправлены, "как", когда сообщение, содержащее только часть SOAP, достаточно. Иначе, SOAPMessage возразите должен создать один или больше AttachmentPart объекты и добавляют их к себе. Любой контент, который не находится в формате XML, должен быть в AttachmentPart объект.

Возвраты:

новое SOAPMessage объект

Броски:

SOAPException - если ошибка SOAP происходит

UnsupportedOperationException - если протокол этого MessageFactory экземпляр DYNAMIC_SOAP_PROTOCOL

createMessage

public abstract SOAPMessage createMessage(MimeHeaders headers,
                        InputStream in)
                                   throws IOException,
                                          SOAPException

Усваивает содержание данного InputStream объект в новое SOAPMessage возразите и возвращается SOAPMessage объект.

Параметры:

in - InputStream объект, который содержит данные для сообщения

headers - транспортно-специфичные заголовки, которые передают к сообщению независимым от транспорта способом для создания сообщения

Возвраты:

новое SOAPMessage объект, содержащий данные от данного InputStream объект

Броски:

IOException - если есть проблема в чтении данных от входного потока

SOAPException - может быть брошен, если сообщение недопустимо

IllegalArgumentException - если MessageFactory требует, чтобы один или более заголовков MIME присутствовали в headers параметр и они отсутствуют. MessageFactory реализации для SOAP_1_1_PROTOCOL или SOAP_1_2_PROTOCOL не должен бросить IllegalArgumentException по этой причине.