Класс W3CEndpointReferenceBuilder

public final class W3CEndpointReferenceBuilder
extends Object

Этот класс используется для построения экземпляров W3CEndpointReference. Предполагаемое использование этого класса — для компонента приложения, например, компонента-фабрики, для создания ссылки на конечную точку веб-службы, опубликованной тем же приложением Java EE. Его также можно использовать для создания ссылок на конечную точку на базе Java SE, указав свойство address.

При создании ссылки на конечную точку, которая не опубликована тем же приложением Java EE, ОБОЯЗАТЕЛЬНО необходимо указать свойство address.

При создании ссылки на конечную точку, опубликованную тем же приложением Java EE, свойство address МОЖЕТ быть null, но тогда свойства serviceName и endpointName ДОЛЖНЫ указывать на конечную точку, опубликованную тем же приложением Java EE.

Если свойство wsdlDocumentLocation указано, оно ДОЛЖНО ссылаться на действительный документ WSDL, а свойства serviceName и endpointName (если указаны) ДОЛЖНЫ соответствовать службе и порту в документе WSDL.

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

W3CEndpointReferenceBuilder

public W3CEndpointReferenceBuilder()

Создаёт новый экземпляр W3CEndpointReferenceBuilder.

Методы

address

public W3CEndpointReferenceBuilder address(String address)

Параметры:

address - Адрес конечной точки, на которую будет нацелен возвращаемый W3CEndpointReference.

Возвращает:

Экземпляр W3CEndpointReferenceBuilder с установленным address в wsa:Address.

interfaceName

public W3CEndpointReferenceBuilder interfaceName(QName interfaceName)

Устанавливает interfaceName в качестве элемента wsam:InterfaceName в элементе wsa:Metadata. Подробнее см. 2.1 Ссылка на метаданные WSDL из EPR.

Параметры:

interfaceName - Имя типа порта конечной точки, на которую будет нацелен возвращаемый W3CEndpointReference.

Возвращает:

Экземпляр W3CEndpointReferenceBuilder с interfaceName в качестве элемента wsam:InterfaceName добавленного к элементу wsa:Metadata.

serviceName

public W3CEndpointReferenceBuilder serviceName(QName serviceName)

Устанавливает serviceName в качестве элемента wsam:ServiceName в элементе wsa:Metadata. Подробнее см. 2.1 Ссылка на метаданные WSDL из EPR.

Параметры:

serviceName - Имя службы конечной точки, на которую будет нацелен возвращаемый W3CEndpointReference. Этот параметр также может быть использован с параметром endpointName (portName) для поиска address веб-сервисной конечной точки, опубликованной тем же Java EE-приложением.

Возвращает:

Экземпляр W3CEndpointReferenceBuilder с serviceName в качестве элемента wsam:ServiceName добавленного к элементу wsa:Metadata.

endpointName

public W3CEndpointReferenceBuilder endpointName(QName endpointName)

Параметры:

endpointName - Имя конечной точки, на которую будет нацелен возвращаемый W3CEndpointReference. Параметр endpointName (portName) также может быть использован с параметром serviceName для поиска address веб-сервисной конечной точки, опубликованной тем же Java EE-приложением.

Возвращает:

Экземпляр W3CEndpointReferenceBuilder с endpointName в качестве wsam:ServiceName/@EndpointName в элементе wsa:Metadata.

Выбрасывает:

IllegalStateException, - если serviceName не установлен.

IllegalArgumentException, - если URI пространства имён endpointName не совпадает с URI пространства имён serviceName.

wsdlDocumentLocation

public W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation)

Параметры:

wsdlDocumentLocation - Путь к документу WSDL, который необходимо указать в wsa:Metadata W3CEndpointReference.

Возвращает:

Экземпляр W3CEndpointReferenceBuilder с указанным wsdlDocumentLocation.

referenceParameter

public W3CEndpointReferenceBuilder referenceParameter(Element referenceParameter)

Добавляет referenceParameter к экземпляру W3CEndpointReference в элемент wsa:ReferenceParameters.

Параметры:

referenceParameter - Элемент, который необходимо добавить в элемент wsa:ReferenceParameters.

Возвращает:

Экземпляр W3CEndpointReferenceBuilder с добавленным referenceParameter к элементу wsa:ReferenceParameters.

Выбрасывает:

IllegalArgumentException - если referenceParameter является null.

metadata

public W3CEndpointReferenceBuilder metadata(Element metadataElement)

Добавляет metadataElement к элементу W3CEndpointReference экземпляра wsa:Metadata.

Параметры:

metadataElement - Элемент, который необходимо добавить к элементу wsa:Metadata.

Возвращает:

Экземпляр W3CEndpointReferenceBuilder с добавленным metadataElement к элементу wsa:Metadata.

Выбрасывает:

IllegalArgumentException - если metadataElement является null.

element

public W3CEndpointReferenceBuilder element(Element element)

Добавляет элемент расширения к элементу W3CEndpointReference экземпляра wsa:EndpointReference.

Параметры:

element - Элемент расширения, который необходимо добавить к W3CEndpointReference

Возвращает:

Экземпляр W3CEndpointReferenceBuilder с добавленным элементом расширения element к экземпляру W3CEndpointReference.

Выбрасывает:

IllegalArgumentException - если element является null.

С момента:

JAX-WS 2.2

attribute

public W3CEndpointReferenceBuilder attribute(QName name,
                                             String value)

Добавляет атрибут расширения к элементу W3CEndpointReference экземпляра wsa:EndpointReference.

Параметры:

name - Имя атрибута расширения, которое необходимо добавить к W3CEndpointReference

value - значение атрибута расширения

Возвращает:

Экземпляр W3CEndpointReferenceBuilder с добавленным атрибутом расширения к экземпляру W3CEndpointReference.

Выбрасывает:

IllegalArgumentException - если name или value является null.

С момента:

JAX-WS 2.2

build

public W3CEndpointReference build()

Возвращает:

Экземпляр W3CEndpointReference из накопленных свойств, установленных в этом экземпляре W3CEndpointReferenceBuilder.

Выбрасывает:

IllegalStateException -

• Если address, serviceName и endpointName все имеют значение null.
• Если служба serviceName является null и endpointName НЕ является null.
• Если свойство address имеет значение null и serviceName и endpointName не указывают действительную конечную точку, опубликованную тем же Java EE-приложением.
• Если serviceName НЕ является null и отсутствует в указанном WSDL.
• Если порт endpointName не является null и не присутствует в службе serviceName в WSDL.
• Если wsdlDocumentLocation НЕ является null и не представляет собой действительный WSDL.

WebServiceException - Если при создании W3CEndpointReference произошла ошибка.