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