Класс Endpoint

public abstract class Endpoint
extends Object

Точка входа веб-сервиса.

Точки входа создаются с помощью статических методов, определённых в этом классе. Точка входа всегда связана с одним Binding и одним реализующим объектом, оба задаются во время создания точки входа.

Точка входа может быть опубликована или не опубликована. Методы publish могут быть использованы для начала публикации точки входа, в этот момент она начинает принимать входящие запросы. И наоборот, метод stop может быть использован для остановки приёма входящих запросов и вывода точки входа из работы. После остановки точку входа нельзя опубликовать повторно.

Для лучшего управления потоками, используемыми для обработки входящих запросов, можно задать Executor для точки входа. Например, пул потоков с определёнными параметрами может быть включён путём создания ThreadPoolExecutor и его регистрации в точке входа.

Цепочки обработчиков можно задать, используя содержащиеся Binding.

Точка входа может иметь список метаданных, таких как WSDL и XMLSchema-документы, привязанные к ней. Во время публикации реализация JAX-WS попытается повторно использовать как можно больше метаданных, вместо генерации новых на основе аннотаций, присутствующих в реализующем объекте.

Поля

WSDL_SERVICE

public static final String WSDL_SERVICE

См. также:

Constant Field Values

WSDL_PORT

public static final String WSDL_PORT

См. также:

Constant Field Values

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

Endpoint

public Endpoint()

Методы

create

public static Endpoint create(Object implementor)

Параметры:

implementor - Реализатор конечной точки.

Возвращает:

Недавно созданная конечная точка.

create

public static Endpoint create(Object implementor,
                              WebServiceFeature... features)

Параметры:

implementor - Реализатор конечной точки.

features - Список WebServiceFeature для настройки конечной точки. Для поддерживаемых функций, не указанных в параметре features , будут использоваться значения по умолчанию.

Возвращает:

Недавно созданная конечная точка.

С версии:

JAX-WS 2.2

create

public static Endpoint create(String bindingId,
                              Object implementor)

Параметры:

bindingId - URI, указывающий на используемую привязку. Если bindingID равен null и привязка не указана с помощью аннотации BindingType, ДОЛЖНА быть использована привязка SOAP 1.1 / HTTP по умолчанию.

implementor - Реализатор конечной точки.

Возвращает:

Недавно созданная конечная точка.

create

public static Endpoint create(String bindingId,
                              Object implementor,
                              WebServiceFeature... features)

Параметры:

bindingId - URI, указывающий на используемую привязку. Если bindingID равен null и привязка не указана с помощью аннотации BindingType, ДОЛЖНА быть использована привязка SOAP 1.1 / HTTP по умолчанию.

implementor - Реализатор конечной точки.

features - Список WebServiceFeature для настройки конечной точки. Для поддерживаемых функций, не указанных в параметре features , будут использоваться значения по умолчанию.

Возвращает:

Недавно созданная конечная точка.

С версии:

JAX-WS 2.2

getBinding

public abstract Binding getBinding()

Возвращает привязку для этой конечной точки.

Возвращает:

Привязка для этой конечной точки

getImplementor

public abstract Object getImplementor()

Возвращает объект реализации для этой конечной точки.

Возвращает:

Реализатор для этой конечной точки

publish

public abstract void publish(String address)

Опубликовывает эту конечную точку по указанному адресу. Необходимая серверная инфраструктура будет создана и настроена реализацией JAX-WS с использованием некоторой конфигурации по умолчанию. Для получения большего контроля над конфигурацией сервера используйте вместо этого метод publish(Object).

Параметры:

address - URI, указывающий на используемый адрес. Адрес ДОЛЖЕН быть совместим с привязкой, указанной при создании конечной точки.

Исключения:

IllegalArgumentException - Если предоставленный URI адреса не может быть использован в сочетании с привязкой конечной точки.

IllegalStateException - Если конечная точка уже опубликована или остановлена.

SecurityException - Если используется java.lang.SecurityManger и у приложения нет разрешения WebServicePermission("publishEndpoint").

publish

public static Endpoint publish(String address,
                               Object implementor)

Параметры:

address - URI, указывающий на используемый адрес и транспорт/протокол. URI http: ДОЛЖЕН привести к использованию привязки SOAP 1.1/HTTP. Реализации могут поддерживать другие схемы URI.

implementor - Реализатор конечной точки.

Возвращает:

Недавно созданная конечная точка.

Исключения:

SecurityException - Если используется java.lang.SecurityManger и у приложения нет разрешения WebServicePermission("publishEndpoint").

publish

public static Endpoint publish(String address,
                               Object implementor,
                               WebServiceFeature... features)

Параметры:

address - URI, указывающий на используемый адрес и транспорт/протокол. URI http: ДОЛЖЕН привести к использованию привязки SOAP 1.1/HTTP. Реализации могут поддерживать другие схемы URI.

implementor - Реализатор конечной точки.

features - Список WebServiceFeature для настройки конечной точки. Для поддерживаемых функций, не указанных в параметре features , будут использоваться значения по умолчанию.

Возвращает:

Недавно созданная конечная точка.

Исключения:

SecurityException - Если используется java.lang.SecurityManger и у приложения нет разрешения WebServicePermission("publishEndpoint").

С версии:

JAX-WS 2.2

publish

public abstract void publish(Object serverContext)

Опубликовывает эту конечную точку в предоставленном контексте сервера. Контекст сервера инкапсулирует серверную инфраструктуру и информацию об адресации для конкретного транспорта. Для успешного вызова этого метода контекст сервера, переданный в качестве аргумента, ДОЛЖЕН быть совместим с привязкой конечной точки.

Параметры:

serverContext - Объект, представляющий контекст сервера, который будет использоваться для публикации конечной точки.

Исключения:

IllegalArgumentException - Если предоставленный контекст сервера не поддерживается реализацией или оказывается непригодным для использования в сочетании с привязкой конечной точки.

IllegalStateException - Если конечная точка уже опубликована или остановлена.

SecurityException - Если используется java.lang.SecurityManger и у приложения нет разрешения WebServicePermission("publishEndpoint").

publish

public void publish(HttpContext serverContext)

Параметры:

serverContext - Объект, представляющий контекст сервера, который будет использоваться для публикации конечной точки.

Исключения:

IllegalArgumentException - Если предоставленный контекст сервера не поддерживается реализацией или оказывается непригодным для использования в сочетании с привязкой конечной точки.

IllegalStateException - Если конечная точка уже опубликована или остановлена.

SecurityException - Если используется java.lang.SecurityManger и у приложения нет разрешения WebServicePermission("publishEndpoint").

С версии:

JAX-WS 2.2

stop

public abstract void stop()

Останавливает публикацию этой конечной точки. Если конечная точка не находится в опубликованном состоянии, этот метод не оказывает никакого действия.

isPublished

public abstract boolean isPublished()

Возвращает true, если конечная точка находится в опубликованном состоянии.

Возвращает:

true если конечная точка находится в опубликованном состоянии.

getMetadata

public abstract List<Source> getMetadata()

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

Возвращает:

List<javax.xml.transform.Source> Список документов метаданных для службы

setMetadata

public abstract void setMetadata(List<Source> metadata)

Устанавливает метаданные для этой конечной точки.

Параметры:

metadata - Список источников XML-документов, содержащих информацию о метаданных для конечной точки (например, документы WSDL или XML Schema)

Исключения:

IllegalStateException - Если конечная точка уже опубликована.

getExecutor

public abstract Executor getExecutor()

Возвращает исполняющий механизм для этого экземпляра Endpoint. Исполняющий механизм используется для отправки входящего запроса объекту реализатора.

Возвращает:

java.util.concurrent.Executor для отправки запроса.

См. также:

Executor

setExecutor

public abstract void setExecutor(Executor executor)

Устанавливает исполнителя для данного экземпляра Endpoint. Исполнитель используется для отправки входящего запроса объекту-исполнителю. Если данный экземпляр Endpoint опубликован с помощью метода publish(Object), и заданный контекст сервера определяет собственное поведение потоков, исполнитель может быть проигнорирован.

Параметры:

executor - java.util.concurrent.Executor для отправки запроса.

Исключения:

SecurityException - Если экземпляр не поддерживает установку исполнителя по соображениям безопасности (например, отсутствуют необходимые разрешения).

См. также:

Executor

getProperties

public abstract Map<String,Object> getProperties()

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

Возвращает:

Map<String,Object> Набор свойств, связанных с данным экземпляром.

setProperties

public abstract void setProperties(Map<String,Object> properties)

Устанавливает набор свойств для данного экземпляра Endpoint.

Параметры:

properties - Набор свойств, связанных с этим экземпляром.

getEndpointReference

public abstract EndpointReference getEndpointReference(Element... referenceParameters)

Параметры:

referenceParameters - Параметры ссылок, которые должны быть связаны с возвращенным экземпляром EndpointReference.

Возвращает:

Ссылка на конечную точку этого экземпляра Endpoint. Если возвращаемая ссылка на конечную точку EndpointReference является типа W3CEndpointReference, то она ДОЛЖНА содержать указанные referenceParameters.

Исключения:

WebServiceException - Если при создании EndpointReference произошла ошибка или экземпляр Endpoint не находится в опубликованном состоянии.

UnsupportedOperationException - Если этот экземпляр BindingProvider использует привязку XML/HTTP.

См. также:

W3CEndpointReference

getEndpointReference

public abstract <T extends EndpointReference> T getEndpointReference(Class<T> clazz,
                                                                     Element... referenceParameters)

Возвращает EndpointReference , связанный с этим экземпляром Endpoint.

Параметры:

clazz - Указывает тип ссылки на конечную точку, который ДОЛЖЕН быть возвращён.

referenceParameters - Параметры ссылок, которые должны быть связаны с возвращенным экземпляром EndpointReference.

Возвращает:

Ссылка на конечную точку типа clazz этого экземпляра Endpoint. Если возвращаемая ссылка на конечную точку EndpointReference является типа W3CEndpointReference, то она ДОЛЖНА содержать указанные referenceParameters.

Исключения:

WebServiceException - Если при создании EndpointReference произошла ошибка или экземпляр Endpoint не находится в опубликованном состоянии или clazz не является поддерживаемым типом EndpointReference.

UnsupportedOperationException - Если этот экземпляр BindingProvider использует привязку XML/HTTP.

См. также:

JAX-WS 2.1

setEndpointContext

public void setEndpointContext(EndpointContext ctxt)

Параметры:

ctxt - который используется для нескольких конечных точек.

Исключения:

IllegalStateException - Если конечная точка уже была опубликована или остановлена.

См. также:

JAX-WS 2.2