Package com.sun.identity.entitlement

Class UserSubject

java.lang.Object

com.sun.identity.entitlement.EntitlementSubjectImpl

com.sun.identity.entitlement.UserSubject

All Implemented Interfaces:

EntitlementSubject, SubjectImplementation

Direct Known Subclasses:

OpenSSOUserSubject

@Deprecated
public class UserSubject
extends EntitlementSubjectImpl

Deprecated.

As of ForgeRock OpenAM 12.

EntitlementSubject to represent user identity for membership check

Constructor Summary

Constructors

Constructor	Description
UserSubject()	Deprecated. Constructs an UserSubject
UserSubject(String user)	Deprecated. Constructs UserSubject
UserSubject(String user, String pSubjectName)	Deprecated. Constructs UserSubject

Method Summary

Modifier and Type	Method	Description
SubjectDecision	evaluate(String realm, SubjectAttributesManager mgr, Subject subject, String resourceName, Map<String,Set<String>> environment)	Deprecated. Returns SubjectDecision of EntitlementSubject evaluation
Set<String>	getRequiredAttributeNames()	Deprecated. Returns a set of attribute names that are used for evaluation.
Map<String,Set<String>>	getSearchIndexAttributes()	Deprecated. Returns attribute names and values that could be used for indexing.
boolean	isIdentity()	Deprecated. Returns true is this subject is an identity object.

Methods inherited from class com.sun.identity.entitlement.EntitlementSubjectImpl

equals, getID, getPSubjectName, getState, hashCode, hasPrincipal, isExclusive, setExclusive, setID, setPSubjectName, setState, toJSONObject, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSubject

public UserSubject()

Deprecated.

Constructs an UserSubject

UserSubject

public UserSubject(String user)

Deprecated.

Constructs UserSubject

Parameters:

user - the uuid of the user who is member of the EntitlementSubject

UserSubject

public UserSubject(String user,
                   String pSubjectName)

Deprecated.

Constructs UserSubject

Parameters:

user - the uuid of the user who is member of the EntitlementSubject

pSubjectName - subject name as used in OpenAM policy, this is relevant only when UserSubject was created from OpenAM policy Subject

Method Detail

evaluate

public SubjectDecision evaluate(String realm,
                                SubjectAttributesManager mgr,
                                Subject subject,
                                String resourceName,
                                Map<String,Set<String>> environment)
                         throws EntitlementException

Deprecated.

Returns SubjectDecision of EntitlementSubject evaluation

Parameters:

realm - Realm name.

subject - EntitlementSubject who is under evaluation.

resourceName - Resource name.

environment - Environment parameters.

Returns:

SubjectDecision of EntitlementSubject evaluation

Throws:

EntitlementException - if any errors occur.

getSearchIndexAttributes

public Map<String,Set<String>> getSearchIndexAttributes()

Deprecated.

Description copied from interface: EntitlementSubject

Returns attribute names and values that could be used for indexing. These values will be used by the authorization engine to obtain the applicable policies for a given Subject.

Returns:

a map of key-value pairs that will be used for indexing the entitlements that contain this EntitlementSubject.

getRequiredAttributeNames

public Set<String> getRequiredAttributeNames()

Deprecated.

Description copied from interface: EntitlementSubject

Returns a set of attribute names that are used for evaluation. During evaluation, the Evaluator would try to populate these attributes in the Subject for the EntitlementSubject's consumption.

Returns:

a set of attributes that would be required by the EntitlementSubject's implementation.

isIdentity

public boolean isIdentity()

Deprecated.

Returns true is this subject is an identity object.

Returns:

true is this subject is an identity object.