javax.xml.ws
インタフェース WebServiceContext

public interface WebServiceContext

WebServiceContext は、処理する要求に対して相対的なメッセージコンテキストおよびセキュリティー情報に、Web サービス端点実装クラスがアクセスできるようにします。 通常、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 を返します。
Principal	getUserPrincipal() 現在処理されている要求の送信者を識別する Principal を返します。
boolean	isUserInRole(String role) 認証されたユーザーが指定された論理ロールに含まれるかどうかを示す、boolean を返します。

メソッドの詳細

getMessageContext

MessageContext getMessageContext()

このメソッドが呼び出されたときに処理されている要求の MessageContext を返します。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 - ロールの名前を指定する String

戻り値:

要求の送信者が与えられたロールに属するかどうかを示す boolean

例外:

IllegalStateException - 要求が処理されていないときにこのメソッドが呼び出された場合、この例外がスローされる

getEndpointReference

EndpointReference getEndpointReference(Element... referenceParameters)

この端点の EndpointReference を返します。

この bindingProvider の Binding が SOAP1.1/HTTP または SOAP1.2/HTTP の場合は、W3CEndpointReference を返す必要があります。

パラメータ:

referenceParameters - 返される EndpointReference インスタンスに関連付けられる参照パラメータ

戻り値:

この WebServiceContext に関連した端点の EndpointReference。返される 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 インスタンスに関連付けられる参照パラメータ

戻り値:

この WebServiceContext インスタンスに関連付けられた端点の clazz 型の EndpointReference。返される EndpointReference が W3CEndpointReference 型の場合は、指定された referenceParameters を含む必要がある

例外:

IllegalStateException - 要求が処理されていないときにこのメソッドが呼び出された場合、この例外がスローされる

WebServiceException - clazz 型の EndpointReference がサポートされていない場合

導入されたバージョン:

JAX-WS 2.1