パッケージ jakarta.xml.ws

インターフェース WebServiceContext

  • public interface WebServiceContext
    WebServiceContext を使用すると、Web サービスエンドポイント実装クラスは、処理されているリクエストに関連するメッセージコンテキストとセキュリティ情報にアクセスできます。通常、WebServiceContext は、Resource アノテーションを使用してエンドポイント実装クラスに挿入されます。
    導入:
    1.6、JAX-WS 2.0
    関連事項:
    "jakarta.annotation.Resource"

    • メソッドの詳細

      • getMessageContext

        MessageContext getMessageContext()
        このメソッドが呼び出されたときに処理されているリクエストの MessageContext を返します。APPLICATION スコープを持つプロパティのみがアプリケーションに表示されます。
        戻り値:
        MessageContext メッセージコンテキスト。
        例外:
        IllegalStateExceptionSE - この例外は、リクエストが処理されていないときにメソッドが呼び出された場合にスローされます。
        関連事項:
        MessageContext, MessageContext.Scope, IllegalStateExceptionSE

      • getUserPrincipal

        PrincipalSE getUserPrincipal()
        現在処理されているリクエストの送信者を識別するプリンシパルを返します。送信者が認証されていない場合、メソッドは null を返します。
        戻り値:
        プリンシパルプリンシパルオブジェクト。
        例外:
        IllegalStateExceptionSE - この例外は、リクエストが処理されていないときにメソッドが呼び出された場合にスローされます。
        関連事項:
        PrincipalSE, IllegalStateExceptionSE

      • isUserInRole

        boolean isUserInRole​(StringSE role)
        認証されたユーザーが指定された論理ロールに含まれているかどうかを示すブール値を返します。ユーザーが認証されていない場合、メソッドは false を返します。
        パラメーター:
        role - ロールの名前を指定する String 
        戻り値:
        リクエストの送信者が特定のロールに属しているかどうかを示す boolean 
        例外:
        IllegalStateExceptionSE - この例外は、リクエストが処理されていないときにメソッドが呼び出された場合にスローされます。

      • getEndpointReference

        EndpointReference getEndpointReference​(ElementSE... referenceParameters)
        このエンドポイントの EndpointReference を返します。

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

        パラメーター:
        referenceParameters - 返された EndpointReference インスタンスに関連付けられる参照パラメーター。
        戻り値:
        この WebServiceContext に関連付けられたエンドポイントの EndpointReference。返された EndpointReference の型が W3CEndpointReference の場合、指定された referenceParameters が含まれている必要があります。
        例外:
        IllegalStateExceptionSE - この例外は、リクエストが処理されていないときにメソッドが呼び出された場合にスローされます。
        導入:
        1.6、JAX-WS 2.1
        関連事項:
        W3CEndpointReference

      • getEndpointReference

        <T extends EndpointReference> T getEndpointReference​(ClassSE<T> clazz,
                                                     ElementSE... referenceParameters)
        このエンドポイントに関連付けられている EndpointReference を返します。
        型パラメーター:
        T - EndpointReference の型。
        パラメーター:
        clazz - 返さなければならない EndpointReference の型。
        referenceParameters - 返された EndpointReference インスタンスに関連付けられる参照パラメーター。
        戻り値:
        この WebServiceContext インスタンスに関連付けられたエンドポイントの型 clazz の EndpointReference。返された EndpointReference の型が W3CEndpointReference の場合、指定された referenceParameters が含まれている必要があります。
        例外:
        IllegalStateExceptionSE - この例外は、リクエストが処理されていないときにメソッドが呼び出された場合にスローされます。
        WebServiceException - EndpointReference の clazz 型がサポートされていない場合。
        導入:
        1.6、JAX-WS 2.1