javax.security.auth
클래스 Subject

java.lang.Object 
  javax.security.auth.Subject

모든 구현된 인터페이스:

Serializable

public final class Subject
extends Object 
implements Serializable 

Subject는 개인등의 단일 엔티티에 관한 관련 정보를 그룹화 한 것입니다. 이런 종류의 정보에는 Subject 식별 정보나, 시큐러티 관련의 속성 (패스워드나 암호화키등)이 포함됩니다.

Subject는 복수의 식별 정보를 가지는 경우가 있습니다. 각각의 식별 정보는 Subject 내의 Principal로 나타내집니다. Principal는 단지 이름을 Subject에 바인드 하고 있을 뿐입니다. 예를 들어 Alice 라고 하는 개인의 Subject에는 Alice 운전 면허증의 이름 「Alice Bar」가 Subject에 바인드 하고 있는 Principal와 학생 번호 「999-99-9999」이 Subject에 바인드 하고 있는 Principal 2개가 있습니다. 어느 쪽의 Principal 도, 다른 이름이어도 같은 Subject를 참조하고 있습니다.

또, Subject에는 시큐러티 관련의 속성도 있습니다. 이것들은 자격이라고도 불립니다. 비공개의 암호화키 등, 특별한 보호를 필요로 하는 중요한 자격은 비공개 자격 Set 내에 포함됩니다. 공개키 인증서 나 Kerberos 서버 티켓과 같이, 공유되어야 할 자격은 공개 자격 Set에 포함됩니다. 다른 자격 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을 구현하고 있습니다. 그 때문에 Subject에 관련된 구체적인 Principal 구현은 모두, Serializable을 구현할 필요가 있습니다.

관련 항목:

Principal, DomainCombiner, 직렬화 된 형식

생성자 개요

Subject ()
비어있는 Principal Set와 비어있는 공개 자격 및 비공개 자격의 Set 로 Subject 인스턴스를 작성합니다.

Subject (boolean readOnly, Set <? extends Principal > principals, Set <? > pubCredentials, Set <? > privCredentials)
Principal와 자격을 지정해, Subject 인스턴스를 작성합니다.

메서드 개요

static Object	doAs (Subject subject, PrivilegedAction action) 특정의 Subject로 서 동작합니다.
static Object	doAs (Subject subject, PrivilegedExceptionAction action) 특정의 Subject로 서 동작합니다.
static Object	doAsPrivileged (Subject subject, PrivilegedAction action, AccessControlContext acc) 특정의 Subject로 서 특권 첨부로 동작합니다.
static Object	doAsPrivileged (Subject subject, PrivilegedExceptionAction action, AccessControlContext acc) 특정의 Subject로 서 특권 첨부로 동작합니다.
boolean	equals (Object o) 지정한 Object와 이 Subject이 동일한지 어떤지를 비교합니다.
Set <Principal >	getPrincipals () 이 Subject에 관련된 Principal Set를 리턴합니다.
<T extends Principal > Set <T>	getPrincipals (Class <T> c) 지정한 Class 인스턴스 또는 서브 클래스인, 이 Subject에 관련된 Principal Set를 리턴합니다.
Set <Object >	getPrivateCredentials () 이 Subject이 보관 유지하는 비공개 자격의 Set를 리턴합니다.
<T> Set <T>	getPrivateCredentials (Class <T> c) 지정한 Class 인스턴스 또는 서브 클래스인 이 Subject에 관련한 비공개 자격의 Set를 리턴합니다.
Set <Object >	getPublicCredentials () 이 Subject이 보관 유지하는 공개 자격의 Set를 리턴합니다.
<T> Set <T>	getPublicCredentials (Class <T> c) 지정한 Class 인스턴스 또는 서브 클래스인 이 Subject에 관련한 공개 자격의 Set를 리턴합니다.
static Subject	getSubject (AccessControlContext acc) 지정한 AccessControlContext에 관련된 Subject를 취득합니다.
int	hashCode () 이 Subject 해시 코드를 리턴합니다.
boolean	isReadOnly () 이 Subject이 읽기 전용 일지 어떨지를 문의합니다.
void	setReadOnly () 이 Subject를 읽기 전용 으로 설정합니다.
String	toString () 이 Subject String 표현을 리턴합니다.

클래스 java.lang. Object 로부터 상속된 메서드

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

생성자 상세

Subject

public Subject()

비어있는 Principal Set와 비어있는 공개 자격 및 비공개 자격의 Set 로 Subject 인스턴스를 작성합니다.

새롭게 작성된 Set 에서는 이후의 변경을 허가하기 전에 이 Subject이 읽기 전용 으로 설정되어 있는지를 확인할 필요가 있습니다. 새롭게 작성된 Set는 호출 측에 충분한 접근 권한이 있는 것을 보증하는 것으로 부정한 변경을 예방합니다.

Principals Set를 변경하려면, 호출 측에 AuthPermission("modifyPrincipals")가 필요합니다. 공개 자격 Set를 변경하려면, 호출 측에 AuthPermission("modifyPublicCredentials")가 필요합니다. 비공개 자격 Set를 변경하려면, 호출 측에 AuthPermission("modifyPrivateCredentials")가 필요합니다.

Subject

public Subject(boolean readOnly,
               Set <?  extends Principal > principals,
               Set <? > pubCredentials,
               Set <? > privCredentials)

Principal와 자격을 지정해, Subject 인스턴스를 작성합니다.

Principal와 자격은 지정된 Set 로부터 새롭게 작성된 Set에 복사됩니다. 이러한 새롭게 작성된 Set 에서는 이후의 변경을 허가하기 전에 이 Subject이 읽기 전용 으로 설정되어 있는지를 확인할 필요가 있습니다. 새롭게 작성된 Set는 호출 측에 충분한 접근 권한이 있는 것을 확인하는 것에의해 부정한 변경을 예방합니다.

Principals Set를 변경하려면, 호출 측에 AuthPermission("modifyPrincipals")가 필요합니다. 공개 자격 Set를 변경하려면, 호출 측에 AuthPermission("modifyPublicCredentials")가 필요합니다. 비공개 자격 Set를 변경하려면, 호출 측에 AuthPermission("modifyPrivateCredentials")가 필요합니다.

파라미터:

readOnly - Subject이 읽기 전용 의 경우는 true, 그렇지 않은 경우는 false

principals - 이 Subject에 관련짓는 Principal Set

pubCredentials - 이 Subject에 관련짓는 공개 자격의 Set

privCredentials - 이 Subject에 관련짓는 비공개 자격의 Set

예외:

NullPointerException - 지정한 principals, pubCredentials, privCredentials 어떤 것인가가 null인 경우

메서드의 상세

setReadOnly

public void setReadOnly()

이 Subject를 읽기 전용 으로 설정합니다.

이 Subject Principal Set 나 자격 Set에 대한 변경 (추가나 삭제)은 허가되지 않습니다. 이 Subject 자격에 대한 destroy 조작만이 허가됩니다.

그 후, Subject Principal 나 자격의 Set를 변경하려고 하면, IllegalStateException가 발생 됩니다. 또, Subject를 읽기 전용 으로 한 후에 한번 더 출력할 수 있도록 리셋 할 수 없습니다.

예외:

SecurityException - 호출 측에 이 Subject를 읽기 전용 으로 설정하는 접근 권한이 없는 경우

isReadOnly

public boolean isReadOnly()

이 Subject이 읽기 전용 일지 어떨지를 문의합니다.

반환값:

이 Subject이 읽기 전용 인 경우는 true, 그렇지 않은 경우는 false

getSubject

public static Subject  getSubject(AccessControlContext  acc)

지정한 AccessControlContext에 관련된 Subject를 취득합니다.

AccessControlContext에 많은 Subject가 포함되는 경우가 있습니다 (상자로 된 doAs 호출에 한다). 이 경우 AccessControlContext에 관련된 최신의 Subject이 리턴됩니다 .

파라미터:

acc - Subject를 얻는 AccessControlContext

반환값:

이 AccessControlContext에 관련된 Subject. 이 AccessControlContext에 관련된 Subject이 없는 경우는 null

예외:

SecurityException - 호출 측에 이 Subject를 얻는 접근 권한이 없는 경우

NullPointerException - 지정한 AccessControlContext이 null인 경우

doAs

public static Object  doAs(Subject  subject,
                          PrivilegedAction  action)

특정의 Subject로 서 동작합니다.

이 메서드에서는 최초로 현재의 Thread AccessControlContext를 AccessController.getContext로 취득해, 취득한 컨텍스트과 (지정한 Subject로 구축한) 새로운 SubjectDomainCombiner를 사용해 새로운 AccessControlContext를 인스턴스화합니다. 마지막으로AccessController.doPrivileged를 호출해, 지정한 PrivilegedAction 과 새롭게 구축한 AccessControlContext를 건네줍니다.

파라미터:

subject - 지정한 action가 실행될 때의 Subject. null도 가능

action - 지정한 Subject로 서 실행되는 코드

반환값:

PrivilegedAction run 메서드에 의해 리턴된 Object

예외:

NullPointerException - PrivilegedAction가 null인 경우

SecurityException - 호출 측에 이 메서드를 호출하는 접근 권한이 없는 경우

doAs

public static Object  doAs(Subject  subject,
                          PrivilegedExceptionAction  action)
                   throws PrivilegedActionException 

특정의 Subject로 서 동작합니다.

이 메서드에서는 최초로 현재의 Thread AccessControlContext를 AccessController.getContext로 취득해, 취득한 컨텍스트과 (지정한 Subject로 구축한) 새로운 SubjectDomainCombiner를 사용해 새로운 AccessControlContext를 인스턴스화합니다. 마지막으로AccessController.doPrivileged를 호출해, 지정한 PrivilegedExceptionAction와 새롭게 구축한 AccessControlContext를 건네줍니다.

파라미터:

subject - 지정한 action가 실행될 때의 Subject. null도 가능

action - 지정한 Subject로 서 실행되는 코드

반환값:

PrivilegedExceptionAction run 메서드에 의해 리턴된 Object

예외:

PrivilegedActionException - PrivilegedExceptionAction.run 메서드가 확인 끝난 예외를 Throw 했을 경우

NullPointerException - 지정한 PrivilegedExceptionAction가 null인 경우

SecurityException - 호출 측에 이 메서드를 호출하는 접근 권한이 없는 경우

doAsPrivileged

public static Object  doAsPrivileged(Subject  subject,
                                    PrivilegedAction  action,
                                    AccessControlContext  acc)

특정의 Subject로 서 특권 첨부로 동작합니다.

이 메서드의 동작은 현재의 Thread AccessControlContext를 얻는 대신에 지정한 AccessControlContext을 사용하는 점을 제외해, Subject.doAs와 같게 됩니다. 지정한 AccessControlContext이 null인 경우, 이 메서드는 새로운 AccessControlContext를 비어있는 ProtectionDomain 컬렉션으로 인스턴스화합니다.

파라미터:

subject - 지정한 action가 실행될 때의 Subject. null도 가능

action - 지정한 Subject로 서 실행되는 코드

acc - 지정한 subject와 action를 묶을 수 있는 AccessControlContext

반환값:

PrivilegedAction run 메서드에 의해 리턴된 Object

예외:

NullPointerException - PrivilegedAction가 null인 경우

SecurityException - 호출 측에 이 메서드를 호출하는 접근 권한이 없는 경우

doAsPrivileged

public static Object  doAsPrivileged(Subject  subject,
                                    PrivilegedExceptionAction  action,
                                    AccessControlContext  acc)
                             throws PrivilegedActionException 

특정의 Subject로 서 특권 첨부로 동작합니다.

이 메서드의 동작은 현재의 Thread AccessControlContext를 얻는 대신에 지정한 AccessControlContext을 사용하는 점을 제외해, Subject.doAs와 같게 됩니다. 지정한 AccessControlContext이 null인 경우, 이 메서드는 새로운 AccessControlContext를 비어있는 ProtectionDomain 컬렉션으로 인스턴스화합니다.

파라미터:

subject - 지정한 action가 실행될 때의 Subject. null도 가능

action - 지정한 Subject로 서 실행되는 코드

acc - 지정한 subject와 action를 묶을 수 있는 AccessControlContext

반환값:

PrivilegedExceptionAction run 메서드에 의해 리턴된 Object

예외:

PrivilegedActionException - PrivilegedExceptionAction.run 메서드가 확인 끝난 예외를 Throw 했을 경우

NullPointerException - 지정한 PrivilegedExceptionAction가 null인 경우

SecurityException - 호출 측에 이 메서드를 호출하는 접근 권한이 없는 경우

getPrincipals

public Set <Principal > getPrincipals()

이 Subject에 관련된 Principal Set를 리턴합니다. 각 Principal는 이 Subject 식별 정보를 나타냅니다.

리턴된 Set는 이 Subject 내부적인 Principal Set와 결부되고 있습니다. 리턴된 Set에 대한 변경은 내부의 Principal Set에 도 영향을 줍니다.

반환값:

이 Subject에 관련된 Principal Set

getPrincipals

public <T extends Principal > Set <T> getPrincipals(Class <T> c)

지정한 Class 인스턴스 또는 서브 클래스인, 이 Subject에 관련된 Principal Set를 리턴합니다.

리턴된 Set는 이 Subject 내부적인 Principal Set와 결부되지 않습니다. 메서드 호출할 것에 새로운 Set이 작성되어 리턴됩니다 . 리턴된 Set에 대한 변경은 내부적인 Principal Set에 영향을 주지 않습니다.

파라미터:

c - 리턴된 Principal Set는 모두 이 클래스의 인스턴스가 된다

반환값:

지정한 Class 인스턴스인 Principal Set

예외:

NullPointerException - 지정한 Class가 null인 경우

getPublicCredentials

public Set <Object > getPublicCredentials()

이 Subject이 보관 유지하는 공개 자격의 Set를 리턴합니다.

리턴된 Set는 이 Subject 내부적인 공개 Credential Set와 결부되고 있습니다. 리턴된 Set에 대한 변경은 내부적인 공개 Credential Set에 도 영향을 줍니다.

반환값:

이 Subject이 보관 유지하는 공개 자격의 Set

getPrivateCredentials

public Set <Object > getPrivateCredentials()

이 Subject이 보관 유지하는 비공개 자격의 Set를 리턴합니다.

리턴된 Set는 이 Subject 내부적인 비공개 Credential Set와 결부되고 있습니다. 리턴된 Set에 대한 변경은 내부적인 비공개 Credential Set에 도 영향을 줍니다.

호출측에서는 리턴된 Set Credential에 액세스하기 위한 권한, 또는 Set 자체를 변경하기 위한 접근 권한이 필요합니다. 호출 측에 적절한 접근 권한이 없는 경우는 SecurityException가 발생 됩니다.

Set를 반복 처리 할 때, 호출 측에 특정의 Credential에 대한 접근 권한이 없는 경우는 SecurityException가 발생 됩니다. 그 경우에서도, Iterator는 Set 다음의 요소에 처리를 진행시킵니다.

반환값:

이 Subject이 보관 유지하는 비공개 자격의 Set

getPublicCredentials

public <T> Set <T> getPublicCredentials(Class <T> c)

지정한 Class 인스턴스 또는 서브 클래스인 이 Subject에 관련한 공개 자격의 Set를 리턴합니다.

리턴된 Set는 이 Subject 내부적인 공개 Credential Set와 결부되지 않습니다. 각 메서드의 호출에 대해서 새로운 Set이 작성되어 리턴됩니다 . 리턴된 Set에 대한 변경은 내부적인 공개 Credential Set에 영향을 주지 않습니다.

파라미터:

c - 리턴된 공개 자격의 Set는 모두 이 클래스의 인스턴스가 된다

반환값:

지정한 Class 인스턴스인 공개 자격의 Set

예외:

NullPointerException - 지정한 Class가 null인 경우

getPrivateCredentials

public <T> Set <T> getPrivateCredentials(Class <T> c)

지정한 Class 인스턴스 또는 서브 클래스인 이 Subject에 관련한 비공개 자격의 Set를 리턴합니다.

호출 측에는 요구한 Credential 모두에 대한 접근 권한이 없으면 안됩니다. 그렇지 않은 경우는 SecurityException가 발생 됩니다.

리턴된 Set는 이 Subject 내부적인 비공개 Credential Set와 결부되지 않습니다. 각 메서드의 호출에 대해서 새로운 Set이 작성되어 리턴됩니다 . 리턴된 Set에 대한 변경은 내부적인 비공개 Credential Set에 영향을 주지 않습니다.

파라미터:

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인스턴스는 동일해집니다.

오버라이드(override):

클래스 Object 내의 equals

파라미터:

o - 이 Subject와 동일한지 어떤지를 비교하는 Object

반환값:

지정된 Object가 이 Subject와 동일한 경우는 true

예외:

SecurityException - 호출 측에 이 Subject 비공개 자격에의 접근 권한이 없는 경우, 혹은 호출 측에 지정한 Subject 비공개 자격에의 접근 권한이 없는 경우

관련 항목:

Object.hashCode(), Hashtable

toString

public String  toString()

이 Subject String 표현을 리턴합니다.

오버라이드(override):

클래스 Object 내의 toString

반환값:

이 Subject String 표현

hashCode

public int hashCode()

이 Subject 해시 코드를 리턴합니다.

오버라이드(override):

클래스 Object 내의 hashCode

반환값:

이 Subject 해시 코드

예외:

SecurityException - 호출 측에 이 Subject 비공개 자격에의 접근 권한이 없는 경우

관련 항목:

Object.equals(java.lang.Object), Hashtable