javax.xml.ws

Интерфейсный WebServiceContext

public interface WebServiceContext

A WebServiceContext позволяет классу реализации конечной точки веб-сервиса контекста сообщения доступа и информации о безопасности относительно подаваемого запроса. Обычно a WebServiceContext вводится в класс реализации конечной точки, используя Resource аннотация.

С тех пор:

JAX-WS 2.0

См. Также:

Resource

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

Методы

Модификатор и Тип	Метод и Описание
<T extends EndpointReference> T	getEndpointReference(Class<T> clazz, Element... referenceParameters) Возвраты EndpointReference связанный с этой конечной точкой.
EndpointReference	getEndpointReference(Element... referenceParameters) Возвраты EndpointReference для этой конечной точки.
MessageContext	getMessageContext() Возвраты MessageContext для запроса, подаваемого в то время, когда вызывают этот метод.
Принципал	getUserPrincipal() Возвращает Принципал, который идентифицирует отправителя запроса, в настоящий момент обслуживаемого.
boolean	isUserInRole(String role) Возвращает булевскую переменную, указывающую, включается ли аутентифицируемый пользователь в указанную логическую роль.

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

getMessageContext

MessageContext getMessageContext()

Возвраты MessageContext для запроса, подаваемого в то время, когда вызывают этот метод. Только свойства с ОБЛАСТЬЮ ДЕЙСТВИЯ ПРИЛОЖЕНИЯ будут видимы к приложению.

Возвраты:

MessageContext контекст сообщения.

Броски:

IllegalStateException - Это исключение выдается, если метод вызывают, в то время как никакой запрос не обслуживается.

См. Также:

MessageContext, MessageContext.Scope, IllegalStateException

getUserPrincipal

Principal getUserPrincipal()

Возвращает Принципал, который идентифицирует отправителя запроса, в настоящий момент обслуживаемого. Если отправитель не аутентифицировался, возвраты метода null.

Возвраты:

Принципал объект принципала.

Броски:

IllegalStateException - Это исключение выдается, если метод вызывают, в то время как никакой запрос не обслуживается.

См. Также:

Principal, IllegalStateException

isUserInRole

boolean isUserInRole(String role)

Возвращает булевскую переменную, указывающую, включается ли аутентифицируемый пользователь в указанную логическую роль. Если пользователь не аутентифицировался, возвраты метода false.

Параметры:

role - A String определение имени роли

Возвраты:

a boolean указание, принадлежит ли отправитель запроса данной роли

Броски:

IllegalStateException - Это исключение выдается, если метод вызывают, в то время как никакой запрос не обслуживается.

getEndpointReference

EndpointReference getEndpointReference(Element... referenceParameters)

Возвраты EndpointReference для этой конечной точки.

Если Binding для этого bindingProvider или SOAP1.1/HTTP или SOAP1.2/HTTP, тогда a 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