パッケージ jakarta.ws.rs.core

インターフェース SecurityContext

public interface SecurityContext
セキュリティ関連情報へのアクセスを提供する注入可能なインターフェース。
導入:
1.0
作成者:
Paul Sandoz, Marc Hadley
関連事項:

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final StringSE
    BASIC_AUTH
    基本認証の文字列識別子。
    static final StringSE
    CLIENT_CERT_AUTH
    クライアント証明書認証の文字列識別子。
    static final StringSE
    DIGEST_AUTH
    ダイジェスト認証の文字列識別子。
    static final StringSE
    FORM_AUTH
    フォーム認証の文字列識別子。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    StringSE
    getAuthenticationScheme()
    リソースを保護するために使用される認証スキームの文字列値を返します。
    PrincipalSE
    getUserPrincipal()
    現在の認証済みユーザーの名前を含む java.security.Principal オブジェクトを返します。
    boolean
    isSecure()
    このリクエストが HTTPS などの安全なチャネルを使用して行われたかどうかを示すブール値を返します。
    boolean
    isUserInRole(StringSE role)
    認証されたユーザーが指定された論理的な「ロール」に含まれているかどうかを示すブール値を返します。

  • フィールドの詳細

  • メソッドの詳細

    • getUserPrincipal

      PrincipalSE getUserPrincipal()
      現在認証されているユーザーの名前を含む java.security.Principal オブジェクトを返します。ユーザーが認証されていない場合、メソッドは null を返します。
      戻り値:
      このリクエストを行ったユーザーの名前を含む java.security.Principal。ユーザーが認証されていない場合は null
      例外:
      IllegalStateExceptionSE - リクエストの範囲外で呼び出された場合

    • isUserInRole

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

    • isSecure

      boolean isSecure()
      このリクエストが HTTPS などの安全なチャネルを使用して行われたかどうかを示すブール値を返します。
      戻り値:
      リクエストがセキュリティで保護されたチャネルを使用して行われた場合は true、それ以外の場合は false 
      例外:
      IllegalStateExceptionSE - リクエストの範囲外で呼び出された場合

    • getAuthenticationScheme

      StringSE getAuthenticationScheme()
      リソースを保護するために使用される認証スキームの文字列値を返します。リソースが認証されていない場合、null が返されます。値は CGI 変数 AUTH_TYPE と同じです
      戻り値:
      静的メンバー BASIC_AUTH、FORM_AUTH、CLIENT_CERT_AUTH、DIGEST_AUTH（== 比較に適しています）または認証スキームを示すコンテナー固有の文字列の 1 つ、またはリクエストが認証されなかった場合は null。
      例外:
      IllegalStateExceptionSE - リクエストの範囲外で呼び出された場合