Интерфейс WebServiceContext
public interface WebServiceContext
Объект WebServiceContext позволяет классу-реализации конечной точки веб-сервиса получить доступ к контексту сообщения и безопасности, относящимся к обслуживаемому запросу. Обычно объект WebServiceContext вводится в класс реализации конечной точки с помощью аннотации Resource.
- С момента:
- JAX-WS 2.0
- См. также:
Resource
Методы
| Модификатор и тип | Метод и описание |
|---|---|
<T extends EndpointReference> |
getEndpointReference(Class<T> clazz,
Element... referenceParameters) Возвращает |
EndpointReference |
getEndpointReference(Element... referenceParameters) Возвращает |
MessageContext |
getMessageContext() Возвращает |
Principal |
getUserPrincipal() Возвращает объект Principal, определяющий отправителя текущего обрабатываемого запроса. |
boolean |
isUserInRole(String role) Возвращает значение boolean, указывающее, входит ли аутентифицированный пользователь в указанную логическую роль. |
Методы
getMessageContext
MessageContext getMessageContext()
Возвращает MessageContext для запроса, обрабатываемого в момент вызова этого метода. Только свойства со scope APPLICATION будут видны приложению.
- Возвращает:
- MessageContext Контекст сообщения.
- Исключения:
-
IllegalStateException- Данное исключение выбрасывается, если метод вызывается, когда запрос не обрабатывается. - См. также:
-
MessageContext,MessageContext.Scope,IllegalStateException
getUserPrincipal
Principal getUserPrincipal()
Возвращает объект Principal, определяющий отправителя текущего обрабатываемого запроса. Если отправитель не был аутентифицирован, метод возвращает null.
- Возвращает:
- Principal Объект principal.
- Исключения:
-
IllegalStateException- Данное исключение выбрасывается, если метод вызывается, когда запрос не обрабатывается. - См. также:
-
Principal,IllegalStateException
isUserInRole
boolean isUserInRole(String role)
Возвращает значение boolean, указывающее, входит ли аутентифицированный пользователь в указанную логическую роль. Если пользователь не был аутентифицирован, метод возвращает false.
- Параметры:
-
role- Строка, определяющая имя роли - Возвращает:
- Значение boolean, указывающее, принадлежит ли отправитель запроса данной роли
- Исключения:
-
IllegalStateException- Данное исключение выбрасывается, если метод вызывается, когда запрос не обрабатывается.
getEndpointReference
EndpointReference getEndpointReference(Element... referenceParameters)
Возвращает EndpointReference для этой конечной точки.
Если Binding для этой bindingProvider равен SOAP1.1/HTTP или SOAP1.2/HTTP, то ДОЛЖЕН быть возвращен W3CEndpointReference.
- Параметры:
-
referenceParameters- Параметры ссылки, которые должны быть связаны с возвращаемым экземпляромEndpointReference. - Возвращает:
- EndpointReference конечной точки, связанной с этим объектом
WebServiceContext. Если возвращаемыйEndpointReferenceимеет типW3CEndpointReference, то он ДОЛЖЕН содержать указанныеreferenceParameters. - Исключения:
-
IllegalStateException- Это исключение выбрасывается, если метод вызывается, когда запрос не обрабатывается. - С момента:
- JAX-WS 2.1
- См. также:
W3CEndpointReference
getEndpointReference
<T extends EndpointReference> T getEndpointReference(Class<T> clazz,
Element... referenceParameters) Возвращает EndpointReference , связанный с этой конечной точкой.
- Параметры:
-
clazz- ТипEndpointReference, который ДОЛЖЕН быть возвращён. -
referenceParameters- Параметры ссылки, которые должны быть связаны с возвращаемым экземпляромEndpointReference. - Возвращает:
- EndpointReference типа
clazzконечной точки, связанной с этим экземпляромWebServiceContext. Если возвращаемыйEndpointReferenceимеет типW3CEndpointReference, то он ДОЛЖЕН содержать указанныеreferenceParameters. - Исключения:
-
IllegalStateException- Это исключение выбрасывается, если метод вызывается, когда запрос не обрабатывается. -
WebServiceException- Если типclazzобъектаEndpointReferenceне поддерживается. - С момента:
- JAX-WS 2.1
© 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.