javax.xml.ws

Interface WebServiceContext

public interface WebServiceContext

一个 WebServiceContext使得Web服务端点实现类来访问消息上下文相关的信息服务和安全要求。一个典型的 WebServiceContext注入一个端点实现类使用 Resource注释。

从以下版本开始：

JAX-WS 2

另请参见：

Resource

方法摘要

Modifier and Type	Method and Description
<T extends EndpointReference> T	getEndpointReference(类<T> clazz, Element... referenceParameters) 返回与此相关的 EndpointReference端点。
EndpointReference	getEndpointReference(Element... referenceParameters) 返回此端点的 EndpointReference。
MessageContext	getMessageContext() 返回请求服务时，这种方法被称为 MessageContext。
Principal	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 - String指定角色的名字

结果

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

异常

IllegalStateException这个例外是如果方法没有要求为服务称扔。

getEndpointReference

EndpointReference getEndpointReference(Element... referenceParameters)

返回此端点的 EndpointReference。

如果这bindingProvider的Binding是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(类<T> clazz,
                                                     Element... referenceParameters)

返回与此相关的 EndpointReference端点。

参数

clazz - EndpointReference类型必须返回。

referenceParameters参考参数和返回 EndpointReference实例关联。

结果

对这 WebServiceContext实例关联的端点类型 clazz EndpointReference。如果返回类型是 EndpointReference W3CEndpointReference那么它必须包含指定的 referenceParameters。

异常

IllegalStateException这个例外是如果方法没有要求为服务称扔。

WebServiceException -如果 EndpointReference的 clazz类型不支持。

从以下版本开始：

JAX-WS 2.1