クラスSubject
- すべての実装されたインタフェース:
Serializable
Subject
は、個人などの単一エンティティに関する関連情報をグループ化したものです。 この種の情報には、Subjectの識別情報や、セキュリティ関連の属性(パスワードや暗号化キーなど)が含まれます。
Subjectは、複数の識別情報を持つ場合があります。 それぞれの識別情報は、Subject
内のPrincipal
として表されます。 Principalは単に名前をSubject
にバインドしたものです。 たとえば、Aliceという個人のSubject
には、2つのPrincipalがあります。Aliceの運転免許証の名前「Alice Bar」をSubject
にバインドしたPrincipalと、学生番号「999-99-9999」をSubject
にバインドしたPrincipalの2つです。 それぞれのPrincipalは違う名前を持っていますが、両方とも同じSubject
を参照しています。
Subject
は、「資格」と呼ばれるセキュリティ関連の属性も保持できます。 非公開暗号化キーなどの特別な保護が必要な機密の資格は、非公開資格Set
内に格納されます。 公開キー証明書やKerberosサーバー・チケットのように、共有されるべき資格は、公開資格Set
に格納されます。
Subject
に関連付けられたすべてのPrincipalを取得するには、getPrincipals
メソッドを呼び出します。 Subject
に属する公開または非公開の資格をすべて取得するには、それぞれgetPublicCredentials
メソッドまたはgetPrivateCredentials
メソッドを呼び出します。 返されたPrincipalと資格のSet
を変更するには、Set
クラスで定義されているメソッドを使用します。 たとえば、
Subject subject; Principal principal; Object credential; // add a Principal and credential to the Subject subject.getPrincipals().add(principal); subject.getPublicCredentials().add(credential);
このSubject
クラスはSerializable
を実装します。 Subject
に関連付けられたPrincipalは直列化されますが、Subject
に関連付けられた資格は直列化されません。 java.security.Principal
クラスはSerializable
を実装しません。 したがって、サブジェクトに関連付けられているすべての具体的なPrincipal
実装は、Serializable
を実装する必要があります。
非推奨のメソッドおよび置換
セキュリティ・マネージャAPIに依存するユーザー・ベースの認可のこのクラスの次のメソッドは、削除で非推奨になりました:
getSubject(AccessControlContext)
doAs(Subject, PrivilegedAction)
doAs(Subject, PrivilegedExceptionAction)
doAsPrivileged(Subject, PrivilegedAction, AccessControlContext)
doAsPrivileged(Subject, PrivilegedExceptionAction, AccessControlContext)
current()
およびcallAs(Subject, Callable)
は、これらのメソッドの置換です。current
はgetSubject(AccessController.getContext())
(最初に指定どおり)と同等で、callAs
はdoAs
と似ていますが、スローされる入力タイプと例外は若干異なります。
doAs
またはcallAs
コールは、Subject
オブジェクトをアクションの実行期間にバインドし、アクション内のcurrent
メソッドを使用してサブジェクトを取得できます。 このサブジェクトは、子スレッドが開始され、構造化された同時実行性を使用して親スレッドの実行内で終了した場合に、子スレッドによって継承できます。
- 導入されたバージョン:
- 1.4
- 関連項目:
-
コンストラクタのサマリー
コンストラクタ -
メソッドのサマリー
修飾子と型メソッド説明static <T> T
現在のサブジェクトとしてsubject
を指定してCallable
を実行します。static Subject
current()
現在の件名を返します。static <T> T
doAs
(Subject subject, PrivilegedAction<T> action) 削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。static <T> T
doAs
(Subject subject, PrivilegedExceptionAction<T> action) 削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。このメソッドは当初、権限を有効にして、指定されたPrivilegedExceptionAction
を実行しました。static <T> T
doAsPrivileged
(Subject subject, PrivilegedAction<T> action, AccessControlContext acc) 削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。このメソッドは当初、指定されたAccessControlContext
によって有効化および制限された権限で、指定されたPrivilegedAction
を実行しました。static <T> T
doAsPrivileged
(Subject subject, PrivilegedExceptionAction<T> action, AccessControlContext acc) 削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。このメソッドは当初、指定されたAccessControlContext
によって有効化および制限された権限で、指定されたPrivilegedExceptionAction
を実行しました。boolean
指定されたObjectがこのSubject
と同じかどうかを比較します。このSubject
に関連付けられたPrincipalのSet
を返します。getPrincipals
(Class<T> c) 指定したClass
のインスタンスまたはサブクラスである、このSubject
に関連付けられたPrincipalのSet
を返します。このSubject
が保持する非公開資格のSet
を返します。<T> Set
<T> getPrivateCredentials
(Class<T> c) 指定したClass
のインスタンスまたはサブクラスであるこのSubject
に関連付けられた非公開資格のSet
を返します。このSubject
が保持する公開資格のSet
を返します。<T> Set
<T> getPublicCredentials
(Class<T> c) 指定したClass
のインスタンスまたはサブクラスであるこのSubject
に関連付けられた公開資格のSet
を返します。static Subject
削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。このメソッドは、サポートされなくなった「セキュリティ・マネージャ」とともにのみ役立つ、指定されたAccessControlContext
に関連付けられたサブジェクトを取得するために使用されていました。int
hashCode()
このSubject
のハッシュ・コードを返します。boolean
このSubject
が読取り専用であるかどうかを問い合わせます。void
このSubject
を読取り専用に設定します。toString()
このSubject
の文字列表現を返します。
-
コンストラクタの詳細
-
Subject
public Subject()空のPrincipalのSet
と空の公開資格および非公開資格のSetとで、Subject
のインスタンスを作成します。新しく作成されたSetでは、以降の変更を許可する前に、この
Subject
が読取り専用に設定されているかどうかを確認する必要があります。 これらのセットではnull要素も禁止されており、null要素を追加、問合せまたは削除しようとすると、NullPointerException
になります。 -
Subject
public Subject(boolean readOnly, Set<? extends Principal> principals, Set<?> pubCredentials, Set<?> privCredentials) Principalと資格を指定して、Subject
のインスタンスを作成します。Principalと資格は、指定されたSetから新しく作成されたSetへコピーされます。 これらの新しく作成されたSetでは、以降の変更を許可する前に、この
Subject
が読取り専用に設定されているかどうかを確認する必要があります。 これらのセットではnull要素も禁止されており、null要素を追加、問合せまたは削除しようとすると、NullPointerException
になります。- パラメータ:
readOnly
-Subject
が読取り専用の場合はtrue、そうでない場合はfalse。principals
- このSubject
に関連付けるPrincipalのSet
。pubCredentials
- このSubject
に関連付ける公開資格のSet
。privCredentials
- このSubject
に関連付ける非公開資格のSet
。- スロー:
NullPointerException
- 指定されたprincipals
、pubCredentials
またはprivCredentials
がnull
の場合、またはこれらの3つのセットのいずれかにNULL値が存在する場合。
-
-
メソッドの詳細
-
setReadOnly
public void setReadOnly()このSubject
を読取り専用に設定します。このSubjectの
Principal
Set
および資格Setに対する変更(追加や削除)は許可されません。 このSubjectの資格に対するdestroy
操作だけが許可されます。その後、Subjectの
Principal
や資格のSetを変更しようとすると、IllegalStateException
がスローされます。 また、Subject
を読取り専用にしたあとで、再度書込み可能にリセットすることはできません。 -
isReadOnly
public boolean isReadOnly()このSubject
が読取り専用であるかどうかを問い合わせます。- 戻り値:
- この
Subject
が読取り専用である場合はtrue、そうでない場合はfalse。
-
getSubject
@Deprecated(since="17", forRemoval=true) public static Subject getSubject(AccessControlContext acc) 削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。このメソッドは、サポートされなくなった「セキュリティ・マネージャ」とともにのみ役立つ、指定されたAccessControlContext
に関連付けられたサブジェクトを取得するために使用されていました。 このメソッドは、常にUnsupportedOperationException
をスローするように変更されました。current()
という名前の置換APIが追加され、現在のサブジェクトの取得に使用できます。 Security Managerの代替はありません。UnsupportedOperationException
をスローします。current()
という名前の置換APIが追加され、現在のサブジェクトの取得に使用できます。- パラメータ:
acc
- 無視されます- 戻り値:
- 該当なし
- スロー:
UnsupportedOperationException
- 常時- 関連項目:
-
current
public static Subject current()現在の件名を返します。現在のサブジェクトは、
callAs(javax.security.auth.Subject, java.util.concurrent.Callable<T>)
メソッドによってインストールされます。callAs(subject, action)
がコールされると、action
が現在のサブジェクトとして実行され、このメソッドで取得できます。action
が終了すると、現在のサブジェクトは以前の値にリセットされます。 現在のサブジェクトは、callAs()
の最初のコールの前にnull
になります。このメソッドは、現在のスレッドの実行期間にバインドされた
Subject
を返します。- 戻り値:
- 現在のサブジェクト(現在のサブジェクトがインストールされていない場合、または現在のサブジェクトが
null
に設定されている場合)。 - 導入されたバージョン:
- 18
- 関連項目:
-
callAs
public static <T> T callAs(Subject subject, Callable<T> action) throws CompletionException 現在のサブジェクトとしてsubject
を指定してCallable
を実行します。このメソッドは、
action
を起動し、subject
を実行期間にバインドします。- 型パラメータ:
T
-action
のcall
メソッドによって返される値の型- パラメータ:
subject
- 指定したaction
が実行されるときのSubject
。 このパラメータはnull
になる可能性がある。action
- 現在のサブジェクトとしてsubject
で実行するコード。null
にはできません。- 戻り値:
action
のcall
メソッドによって返される値- スロー:
NullPointerException
-action
がnull
の場合CompletionException
-action.call()
が例外をスローした場合。CompletionException
の原因は、action.call()
によってスローされる例外に設定されます。- 導入されたバージョン:
- 18
- 関連項目:
-
doAs
@Deprecated(since="18", forRemoval=true) public static <T> T doAs(Subject subject, PrivilegedAction<T> action) 削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。このメソッドは当初、権限を有効にして、指定されたPrivilegedAction
を実行しました。 特権を有効にしてアクションを実行することは、サポートされなくなった「セキュリティ・マネージャ」と組み合わせてのみ有効でした。 このメソッドは、アクションをそのまま起動し、サブジェクトを実行期間にバインドするように変更されました。callAs(javax.security.auth.Subject, java.util.concurrent.Callable<T>)
という名前の置換APIが追加され、これを使用して同じ作業を実行できます。 Security Managerの代替はありません。特定のSubject
として動作します。このメソッドは、
action
を起動し、subject
を実行期間にバインドします。- 型パラメータ:
T
- PrivilegedActionのrun
メソッドによって返される値の型。- パラメータ:
subject
- 指定したaction
が実行されるときのSubject
。 このパラメータはnull
になる可能性がある。action
- 指定したSubject
として実行されるコード。- 戻り値:
- PrivilegedActionの
run
メソッドによって返される値。 - スロー:
NullPointerException
-PrivilegedAction
がnull
である場合。- 関連項目:
-
doAs
@Deprecated(since="18", forRemoval=true) public static <T> T doAs(Subject subject, PrivilegedExceptionAction<T> action) throws PrivilegedActionException 削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。このメソッドは当初、権限を有効にして、指定されたPrivilegedExceptionAction
を実行しました。 特権を有効にしてアクションを実行することは、サポートされなくなった「セキュリティ・マネージャ」と組み合わせてのみ有効でした。 このメソッドは、アクションをそのまま起動し、サブジェクトを実行期間にバインドするように変更されました。callAs(javax.security.auth.Subject, java.util.concurrent.Callable<T>)
という名前の置換APIが追加され、これを使用して同じ作業を実行できます。 Security Managerの代替はありません。特定のSubject
として動作します。このメソッドは、
action
を起動し、subject
を実行期間にバインドします。- 型パラメータ:
T
- PrivilegedExceptionActionのrun
メソッドによって返される値の型。- パラメータ:
subject
- 指定したaction
が実行されるときのSubject
。 このパラメータはnull
になる可能性がある。action
- 指定したSubject
として実行されるコード。- 戻り値:
- PrivilegedExceptionActionの
run
メソッドによって返される値。 - スロー:
PrivilegedActionException
-PrivilegedExceptionAction.run
メソッドがチェック例外をスローした場合。NullPointerException
- 指定されたPrivilegedExceptionAction
がnull
である場合。- 関連項目:
-
doAsPrivileged
@Deprecated(since="17", forRemoval=true) public static <T> T doAsPrivileged(Subject subject, PrivilegedAction<T> action, AccessControlContext acc) 削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。このメソッドは当初、指定されたAccessControlContext
によって有効化および制限された権限で、指定されたPrivilegedAction
を実行しました。 特権を有効にしてアクションを実行することは、サポートされなくなった「セキュリティ・マネージャ」と組み合わせてのみ有効でした。 このメソッドは、AccessControlContext
を無視してアクションをそのまま起動し、サブジェクトを実行期間にバインドするように変更されました。callAs(javax.security.auth.Subject, java.util.concurrent.Callable<T>)
という名前の置換APIが追加され、これを使用して同じ作業を実行できます。 Security Managerの代替はありません。特定のSubject
として動作します。このメソッドは、
action
を起動し、subject
を実行期間にバインドします。- 型パラメータ:
T
- PrivilegedActionのrun
メソッドによって返される値の型。- パラメータ:
subject
- 指定したaction
が実行されるときのSubject
。 このパラメータはnull
になる可能性がある。action
- 指定したSubject
として実行されるコード。acc
- 無視されます- 戻り値:
- PrivilegedActionの
run
メソッドによって返される値。 - スロー:
NullPointerException
-PrivilegedAction
がnull
である場合。- 関連項目:
-
doAsPrivileged
@Deprecated(since="17", forRemoval=true) public static <T> T doAsPrivileged(Subject subject, PrivilegedExceptionAction<T> action, AccessControlContext acc) throws PrivilegedActionException 削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。このメソッドは当初、指定されたAccessControlContext
によって有効化および制限された権限で、指定されたPrivilegedExceptionAction
を実行しました。 特権を有効にしてアクションを実行することは、サポートされなくなった「セキュリティ・マネージャ」と組み合わせてのみ有効でした。 このメソッドは、AccessControlContext
を無視してアクションをそのまま起動し、サブジェクトを実行期間にバインドするように変更されました。callAs(javax.security.auth.Subject, java.util.concurrent.Callable<T>)
という名前の置換APIが追加され、これを使用して同じ作業を実行できます。 Security Managerの代替はありません。特定のSubject
として動作します。このメソッドは、
action
を起動し、subject
を実行期間にバインドします。- 型パラメータ:
T
- PrivilegedExceptionActionのrun
メソッドによって返される値の型。- パラメータ:
subject
- 指定したaction
が実行されるときのSubject
。 このパラメータはnull
になる可能性がある。action
- 指定したSubject
として実行されるコード。acc
- 無視されます- 戻り値:
- PrivilegedExceptionActionの
run
メソッドによって返される値。 - スロー:
PrivilegedActionException
-PrivilegedExceptionAction.run
メソッドがチェック例外をスローした場合。NullPointerException
- 指定されたPrivilegedExceptionAction
がnull
である場合。- 関連項目:
-
getPrincipals
-
getPrincipals
指定したClass
のインスタンスまたはサブクラスである、このSubject
に関連付けられたPrincipalのSet
を返します。返される
Set
は、このSubjectの内部的なPrincipal
Set
に基づいていません。 各メソッドの呼出しに対して、新しいSet
が作成されて返されます。 返されたSet
に対する変更は、内部的なPrincipal
Set
には反映されません。- 型パラメータ:
T
-c
でモデル化されたクラスのタイプ- パラメータ:
c
- 返されるプリンシパルのSet
はすべて、このクラスのインスタンスになる。- 戻り値:
- 指定した
Class
のインスタンスであるPrincipalのSet
。 - スロー:
NullPointerException
- 指定されたClass
がnull
である場合。
-
getPublicCredentials
-
getPrivateCredentials
-
getPublicCredentials
指定したClass
のインスタンスまたはサブクラスであるこのSubject
に関連付けられた公開資格のSet
を返します。返される
Set
は、このSubjectの内部的な公開資格Set
に基づいていません。 各メソッドの呼出しに対して、新しいSet
が作成されて返されます。 返されたSet
に対する変更は、内部的な公開資格Set
には反映されません。- 型パラメータ:
T
-c
でモデル化されたクラスのタイプ- パラメータ:
c
- 返される公開資格のSet
はすべて、このクラスのインスタンスになる。- 戻り値:
- 指定した
Class
のインスタンスである公開資格のSet
。 - スロー:
NullPointerException
- 指定されたClass
がnull
である場合。
-
getPrivateCredentials
指定したClass
のインスタンスまたはサブクラスであるこのSubject
に関連付けられた非公開資格のSet
を返します。返される
Set
は、このSubjectの内部的な非公開資格Set
に基づいていません。 各メソッドの呼出しに対して、新しいSet
が作成されて返されます。 返されたSet
に対する変更は、内部的な非公開資格Set
には反映されません。- 型パラメータ:
T
-c
でモデル化されたクラスのタイプ- パラメータ:
c
- 返される非公開資格のSet
はすべて、このクラスのインスタンスになる。- 戻り値:
- 指定した
Class
のインスタンスである非公開資格のSet
。 - スロー:
NullPointerException
- 指定されたClass
がnull
である場合。
-
equals
public boolean equals(Object o) 指定されたObjectがこのSubject
と同じかどうかを比較します。 指定されたオブジェクトもSubjectであり、2つのSubject
インスタンスが等価である場合、trueを返します。 より正確には、Principal
のSetとCredential
のSetが等しい場合に、2つのSubject
インスタンスは等しくなります。 -
toString
-
hashCode
-
PrivilegedAction
を実行しました。