public interface SecurityContext
特に明記されていない限り、この型はすべての Jakarta EE コンテナー、特に Jakarta Servlet および Jakarta Enterprise Beans コンテナーで使用可能でなければなりません。
修飾子と型 | メソッドと説明 |
---|---|
AuthenticationStatus | authenticate(HttpServletRequest request, HttpServletResponse response, AuthenticationParameters parameters) 呼び出し元との Web/HTTP ベースの認証ダイアログを開始または続行する必要があることをコンテナーに通知します(プログラムでトリガーします)。 |
PrincipalSE | getCallerPrincipal() 認証された呼び出し元の名前を表すプラットフォーム固有の java.security.Principal を取得します。現在の呼び出し元が認証されていない場合は null を取得します。 |
<T extends PrincipalSE> | getPrincipalsByType(ClassSE<T> pType) 認証された呼び出し元のサブジェクトから指定された型のすべてのプリンシパルを取得します。現在の呼び出し元が認証されていない場合、または指定された型がサブジェクトに見つからない場合は空のセットを取得します。 |
boolean | hasAccessToWebResource(StringSE resource, StringSE... methods) サーブレット仕様のセクション 13.8 で指定されているように、指定されたメソッドを使用して、呼び出し元が提供された「Web リソース」にアクセスできるかどうかを確認します。 |
boolean | isCallerInRole(StringSE role) 認証された呼び出し元が指定された論理アプリケーション「ロール」に含まれているかどうかを確認します。 |
PrincipalSE getCallerPrincipal()
java.security.Principal
を取得します。現在の呼び出し元が認証されていない場合は null を取得します。<T extends PrincipalSE> SetSE<T> getPrincipalsByType(ClassSE<T> pType)
これは、呼び出し側のプラットフォームの表現が異なるプリンシパル型を使用している場合に、アプリケーション固有のプリンシパルを取得するために使用できます。
返されたセットは、サブジェクトの内部プリンシパルセットによってサポートされていません。メソッドの呼び出しごとに新しいセットが作成されて返されます。返されたセットを変更しても、内部のプリンシパルセットには影響しません。
T
- pType
引数で表される実際の型 pType
- 返すプリンシパルの型を表すクラスオブジェクト。boolean isCallerInRole(StringSE role)
false
を返します。 このメソッドは、特定の名前付き Jakarta Servlets または名前付き Jakarta Enterprise Beans にマップされているロールのテストには使用できません。サーブレットの場合、この例として、web.xml
の servlet
要素にネストされた security-role-ref
要素にネストされた role-name
があります。
そのような Jakarta Servlet または Jakarta Enterprise Bean のいずれかのコードで、このようなマップされた(別名、参照、リンクされた)ロールを考慮に入れたい場合は、その特定のコンテナーの機能を代わりに使用する必要があります。たとえば、HttpServletRequest.isUserInRole(String)
になるサーブレットの場合、EJBContext.isCallerInRole(String)
になる Jakarta Enterprise Beans の場合です。
role
- 論理アプリケーションロールの名前を指定する String
true
、呼び出し元が認証されていないか指定されたロールにない場合は false。boolean hasAccessToWebResource(StringSE resource, StringSE... methods)
Web リソースが保護されていない(制約されている)場合、またはロールによって保護されていて、呼び出し元がそのロールに属している場合、呼び出し元はアクセスできます。
resource
- アクセスをテストする Web リソースの名前。これは、権限が関係するアプリケーション固有の Web リソースを識別する URLPatternSpec
です。このパターンの完全な仕様については、WebResourcePermission.WebResourcePermission(String, String)
を参照してください。methods
- 呼び出し元がこれらのメソッドの 1 つを使用して Web リソースにアクセスできるかどうかを確認する 1 つ以上のメソッド。true
、それ以外の場合は false
。AuthenticationStatus authenticate(HttpServletRequest request, HttpServletResponse response, AuthenticationParameters parameters)
プログラムによるトリガーとは、コンテナーが呼び出し元が制約されたリソースにアクセスしようとしたかのように応答し、構成された認証メカニズム(HttpAuthenticationMechanism
など)を呼び出すことによって動作することを意味します。
認証ダイアログを開始するか続行するかは、認証ダイアログの(論理)状態によって異なります。そのようなダイアログが現在進行中の場合、このメソッドの呼び出しはそれを継続します。そのようなダイアログが進行中でない場合、新しいダイアログが開始されます。この呼び出しで AuthenticationParameters.newAuthentication
パラメーターに true
の値を指定することにより、進行中のダイアログに関係なく、新しいダイアログを強制的に開始できます。
このメソッドでは、HttpServletRequest
および HttpServletResponse
引数を渡す必要があるため、有効なサーブレットコンテキストでのみ使用できます。
request
- 現在の Web リソース呼び出しに関連付けられている HttpServletRequest
。response
- 指定された HttpServletRequest
に関連付けられた HttpServletResponse
。parameters
- 資格情報など、プログラムによる認証リクエストと共に提供されるパラメーター。認証ダイアログを続行するためにアプリケーションによって収集されます。Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.