javax.xml.ws

Interface WebServiceContext

public interface WebServiceContext

A WebServiceContext使Web服务端点实现类可以相对于正在服务的请求访问消息上下文和安全信息。 通常， WebServiceContext注入到使用端点实现类Resource注解。

从以下版本开始：

JAX-WS 2.0

另请参见：

Resource

方法摘要

Modifier and Type	Method and Description
<T extends EndpointReference> T	getEndpointReference(类<T> clazz, Element... referenceParameters) 返回与此端点相关 EndpointReference EndpointReference。
EndpointReference	getEndpointReference(Element... referenceParameters) 返回此端点的 EndpointReference 。
MessageContext	getMessageContext() 返回在 MessageContext此方法时提供的请求的 MessageContext 。
Principal	getUserPrincipal() 返回标识当前正在处理的请求的发件人的Principal。
boolean	isUserInRole(String role) 返回一个布尔值，指示经过身份验证的用户是否包含在指定的逻辑角色中。

方法详细信息

getMessageContext

MessageContext getMessageContext()

返回在MessageContext此方法时提供的请求的MessageContext 。 只有具有APPLICATION范围的属性才能对应用程序可见。

结果

MessageContext消息上下文。

异常

IllegalStateException - 如果在没有请求服务的情况下调用该方法，则抛出此异常。

另请参见：

MessageContext ， MessageContext.Scope ， IllegalStateException

getUserPrincipal

Principal getUserPrincipal()

返回标识当前正在处理的请求的发件人的Principal。 如果发件人尚未认证，则该方法返回null 。

结果

校长主要对象。

异常

IllegalStateException - 如果在没有请求服务的情况下调用该方法，则抛出此异常。

另请参见：

Principal ， IllegalStateException

isUserInRole

boolean isUserInRole(String role)

返回一个布尔值，指示经过身份验证的用户是否包含在指定的逻辑角色中。 如果用户尚未认证，该方法返回false 。

参数

role - A String指定角色的名称

结果

一个 boolean指示请求的发送者是否属于给定的角色

异常

IllegalStateException - 如果在没有请求服务的情况下调用该方法，则抛出此异常。

getEndpointReference

EndpointReference getEndpointReference(Element... referenceParameters)

返回此端点的EndpointReference 。

如果这个bindingProvider的bindingProvider是SOAP1.1 / HTTP或SOAP1.2 / HTTP，则必须返回一个W3CEndpointReference 。

参数

referenceParameters - 与返回的 EndpointReference实例相关联的 EndpointReference参数。

结果

与此WebServiceContext的端点的WebServiceContext 。 如果返回的EndpointReference是W3CEndpointReference那么它必须包含指定的referenceParameters 。

异常

IllegalStateException - 如果在没有请求服务的情况下调用该方法，则抛出此异常。

从以下版本开始：

JAX-WS 2.1

另请参见：

W3CEndpointReference

getEndpointReference

<T extends EndpointReference> T getEndpointReference(类<T> clazz,
                                                     Element... referenceParameters)

返回与此端点 EndpointReference EndpointReference。

参数

clazz - 必须返回的类型 EndpointReference 。

referenceParameters - 与返回的 EndpointReference实例相关联的 EndpointReference参数。

结果

与此WebServiceContext实例clazz的端点类型为clazz的WebServiceContext 。 如果返回的EndpointReference是W3CEndpointReference那么它必须包含指定的referenceParameters 。

异常

IllegalStateException - 如果在没有请求服务的情况下调用该方法，则抛出此异常。

WebServiceException -如果 clazz型 EndpointReference不支持。

从以下版本开始：

JAX-WS 2.1