Класс SOAPFactory
- java.lang.Object
-
- javax.xml.soap.SOAPFactory
public abstract class SOAPFactory extends Object
SOAPFactory является фабрикой для создания различных объектов, существующих в дереве SOAP XML. SOAPFactory может использоваться для создания фрагментов XML, которые в конечном итоге окажутся в части SOAP. Эти фрагменты могут быть вставлены как дочерние элементы SOAPHeaderElement или SOAPBodyElement или SOAPEnvelope или других SOAPElement объектов. SOAPFactory также имеет методы для создания javax.xml.soap.Detail объектов, а также java.xml.soap.Name объектов.
Конструкторы
| Конструктор и описание |
|---|
SOAPFactory() |
Методы
| Модификатор и тип | Метод и описание |
|---|---|
abstract Detail |
createDetail() Создаёт новый |
SOAPElement |
createElement(Element domElement) Создаёт |
abstract SOAPElement |
createElement(Name name) Создаёт |
SOAPElement |
createElement(QName qname) Создаёт |
abstract SOAPElement |
createElement(String localName) Создаёт |
abstract SOAPElement |
createElement(String localName,
String prefix,
String uri) Создаёт новый |
abstract SOAPFault |
createFault() Создаёт новый по умолчанию |
abstract SOAPFault |
createFault(String reasonText,
QName faultCode) Создаёт новый |
abstract Name |
createName(String localName) Создаёт новый |
abstract Name |
createName(String localName,
String prefix,
String uri) Создаёт новый |
static SOAPFactory |
newInstance() Создаёт новый |
static SOAPFactory |
newInstance(String protocol) Создаёт новый |
Методы, унаследованные от класса java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Конструкторы
SOAPFactory
public SOAPFactory()
Методы
createElement
public SOAPElement createElement(Element domElement)
throws SOAPException Создаёт объект SOAPElement из существующего DOM Element. Если переданный в качестве аргумента DOM Element уже является SOAPElement, то этот метод должен вернуть его без изменений без каких-либо дополнительных действий. В противном случае создаётся новый SOAPElement и делается глубокая копия аргумента domElement. Конкретный тип возвращаемого значения будет зависеть от имени аргумента domElement. Если любая часть дерева, укоренённого в domElement, нарушает правила SOAP, будет выброшено исключение SOAPException.
- Параметры:
-
domElement- - копируемыйElement. - Возвращает:
- новый
SOAPElement, являющийся копиейdomElement. - Исключения:
-
SOAPException- если при создании объектаSOAPElementпроизошла ошибка - С тех пор как:
- SAAJ 1.3
createElement
public abstract SOAPElement createElement(Name name)
throws SOAPException Создаёт объект SOAPElement , инициализированный заданным объектом Name . Конкретный тип возвращаемого значения будет зависеть от имени, присвоенного новому SOAPElement. Например, новый SOAPElement с именем "{http://www.w3.org/2003/05/soap-envelope}Envelope" приведёт к созданию SOAPEnvelope , поддерживающего поведение SOAP 1.2.
- Параметры:
-
name- объектNameс XML-именем для нового элемента - Возвращает:
- новый объект
SOAPElement, который был создан - Исключения:
-
SOAPException- если при создании объектаSOAPElementпроизошла ошибка - См. также:
createElement(javax.xml.namespace.QName)
createElement
public SOAPElement createElement(QName qname)
throws SOAPException Создаёт объект SOAPElement , инициализированный заданным объектом QName . Конкретный тип возвращаемого значения будет зависеть от имени, присвоенного новому SOAPElement. Например, новый SOAPElement с именем "{http://www.w3.org/2003/05/soap-envelope}Envelope" приведёт к созданию SOAPEnvelope , поддерживающего поведение SOAP 1.2.
- Параметры:
-
qname- объектQNameс XML-именем для нового элемента - Возвращает:
- новый объект
SOAPElement, который был создан - Исключения:
-
SOAPException- если при создании объектаSOAPElementпроизошла ошибка - С тех пор как:
- SAAJ 1.3
- См. также:
createElement(Name)
createElement
public abstract SOAPElement createElement(String localName)
throws SOAPException Создаёт объект SOAPElement , инициализированный заданным локальным именем.
- Параметры:
-
localName-String, задающий локальное имя для нового элемента - Возвращает:
- новый объект
SOAPElement, который был создан - Исключения:
-
SOAPException- если при создании объектаSOAPElementпроизошла ошибка
createElement
public abstract SOAPElement createElement(String localName,
String prefix,
String uri)
throws SOAPException Создаёт новый объект SOAPElement с заданным локальным именем, префиксом и URI. Конкретный тип возвращаемого значения будет зависеть от имени, присвоенного новому элементу. Например, новый SOAPElement с именем "{http://www.w3.org/2003/05/soap-envelope}Envelope" приведёт к созданию SOAPEnvelope , поддерживающего поведение SOAP 1.2.
- Параметры:
-
localName-String, задающий локальное имя для нового элемента -
prefix- префикс для этогоSOAPElement -
uri-String, задающий URI пространства имён, к которому принадлежит новый элемент - Исключения:
-
SOAPException- если при создании объектаSOAPElementпроизошла ошибка
createDetail
public abstract Detail createDetail()
throws SOAPException Создаёт новый объект Detail , который служит контейнером для объектов DetailEntry .
Этот фабричный метод создаёт объекты Detail для использования в ситуациях, когда непрактично использовать абстракцию SOAPFault .
- Возвращает:
- объект
Detail - Исключения:
-
SOAPException- если произошла ошибка SOAP -
UnsupportedOperationException- если протокол, указанный для SOAPFactory, былDYNAMIC_SOAP_PROTOCOL
createFault
public abstract SOAPFault createFault(String reasonText,
QName faultCode)
throws SOAPException Создаёт новый объект SOAPFault , инициализированный заданными значениями reasonText и faultCode .
- Параметры:
-
reasonText- ReasonText/FaultString для ошибки -
faultCode- FaultCode для ошибки - Возвращает:
- объект
SOAPFault - Исключения:
-
SOAPException- если произошла ошибка SOAP - С тех пор как:
- SAAJ 1.3
createFault
public abstract SOAPFault createFault()
throws SOAPException Создаёт новый объект по умолчанию SOAPFault
- Возвращает:
- объект
SOAPFault - Исключения:
-
SOAPException- если произошла ошибка SOAP - С тех пор как:
- SAAJ 1.3
createName
public abstract Name createName(String localName,
String prefix,
String uri)
throws SOAPException Создаёт новый объект Name , инициализированный заданными локальным именем, префиксом пространства имён и URI пространства имён.
Этот фабричный метод создаёт объекты Name для использования в ситуациях, когда непрактично использовать абстракцию SOAPEnvelope .
- Параметры:
-
localName-String, задающее локальное имя -
prefix-String, задающее префикс пространства имён -
uri-String, задающее URI пространства имён - Возвращает:
- объект
Name, инициализированный заданным локальным именем, префиксом пространства имён и URI пространства имён - Исключения:
-
SOAPException- если произошла ошибка SOAP
createName
public abstract Name createName(String localName)
throws SOAPException Создаёт новый объект Name , инициализированный заданным локальным именем.
Этот фабричный метод создаёт объекты Name для использования в ситуациях, когда непрактично использовать абстракцию SOAPEnvelope .
- Параметры:
-
localName-String, задающее локальное имя - Возвращает:
- объект
Name, инициализированный заданным локальным именем - Исключения:
-
SOAPException- если произошла ошибка SOAP
newInstance
public static SOAPFactory newInstance()
throws SOAPException Создаёт новый объект SOAPFactory , являющийся экземпляром реализации по умолчанию (SOAP 1.1). Этот метод использует следующий упорядоченный поиск для определения класса реализации SOAPFactory для загрузки:
- Использует системную переменную среды javax.xml.soap.SOAPFactory.
- Использует файл свойств "lib/jaxm.properties" в каталоге JRE. Этот файл конфигурации находится в стандартном формате java.util.Properties и содержит полное квалифицированное имя класса реализации с ключом, соответствующим вышеуказанной системной переменной.
- Использует API сервисов (как подробно описано в спецификации JAR), если оно доступно, для определения имени класса.
- Использует экземпляр SAAJMetaFactory для поиска класса реализации SOAPFactory.
- Возвращает:
- новый экземпляр
SOAPFactory - Исключения:
-
SOAPException- если произошла ошибка при создании объектаSOAPFactoryпо умолчанию - См. также:
SAAJMetaFactory
newInstance
public static SOAPFactory newInstance(String protocol)
throws SOAPException Создаёт новый объект SOAPFactory , являющийся экземпляром указанной реализации. Этот метод использует SAAJMetaFactory для поиска класса реализации и создания экземпляра SOAPFactory.
- Параметры:
-
protocol- строковая константа, представляющая протокол указанной реализации SOAP-фабрики. Может бытьDYNAMIC_SOAP_PROTOCOL,DEFAULT_SOAP_PROTOCOL(что эквивалентно)SOAP_1_1_PROTOCOL, илиSOAP_1_2_PROTOCOL. - Возвращает:
- новый экземпляр
SOAPFactory - Исключения:
-
SOAPException- если произошла ошибка при создании указанного объектаSOAPFactory - С тех пор как:
- SAAJ 1.3
- См. также:
SAAJMetaFactory
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.