com.sun.identity.entitlement

Class LogicalSubject

java.lang.Object

com.sun.identity.entitlement.LogicalSubject

All Implemented Interfaces:

EntitlementSubject

Direct Known Subclasses:

AndSubject, NotSubject, OrSubject

public abstract class LogicalSubject
extends Object
implements EntitlementSubject

Base class for OrSubejct and AndSubejct.

Constructor Summary

Constructors

Constructor and Description
LogicalSubject() Constructor.
LogicalSubject(Set<EntitlementSubject> eSubjects) Constructor.
LogicalSubject(Set<EntitlementSubject> eSubjects, String pSubjectName) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Returns true if the passed in object is equal to this object
Set<EntitlementSubject>	getESubjects() Returns the nested EntitlementSubject(s)
String	getPSubjectName() Returns OpenAM policy Subject name
Set<String>	getRequiredAttributeNames() Returns the required attribute names.
Map<String,Set<String>>	getSearchIndexAttributes() Returns the search index attributes.
String	getState() Returns state of the object
int	hashCode() Returns hash code of the object
boolean	isIdentity() Returns true is this subject is an identity object.
void	setESubjects(Set<EntitlementSubject> eSubjects) Sets the nested EntitlementSubject(s)
void	setPSubjectName(String pSubjectName) Sets OpenAM policy Subject name
void	setState(String state) Sets state of the object
org.json.JSONObject	toJSONObject() Returns JSONObject mapping of the object
String	toString() Returns string representation of the object

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.identity.entitlement.EntitlementSubject

evaluate

Constructor Detail

LogicalSubject

public LogicalSubject()

Constructor.

LogicalSubject

public LogicalSubject(Set<EntitlementSubject> eSubjects)

Constructor.

Parameters:

eSubjects - wrapped EntitlementSubject(s)

LogicalSubject

public LogicalSubject(Set<EntitlementSubject> eSubjects,
                      String pSubjectName)

Constructor.

Parameters:

eSubjects - wrapped EntitlementSubject(s)

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

Method Detail

setState

public void setState(String state)

Sets state of the object

Specified by:

setState in interface EntitlementSubject

Parameters:

state - State of the object encoded as string

getState

public String getState()

Returns state of the object

Specified by:

getState in interface EntitlementSubject

Returns:

state of the object encoded as string

setESubjects

public void setESubjects(Set<EntitlementSubject> eSubjects)

Sets the nested EntitlementSubject(s)

Parameters:

eSubjects - the nested EntitlementSubject(s)

getESubjects

public Set<EntitlementSubject> getESubjects()

Returns the nested EntitlementSubject(s)

Returns:

the nested EntitlementSubject(s)

setPSubjectName

public void setPSubjectName(String pSubjectName)

Sets OpenAM policy Subject name

Parameters:

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

getPSubjectName

public String getPSubjectName()

Returns OpenAM policy Subject name

Returns:

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

toJSONObject

public org.json.JSONObject toJSONObject()
                                 throws org.json.JSONException

Returns JSONObject mapping of the object

Returns:

JSONObject mapping of the object

Throws:

org.json.JSONException - if can not map to JSONObject

toString

public String toString()

Returns string representation of the object

Overrides:

toString in class Object

Returns:

string representation of the object

equals

public boolean equals(Object obj)

Returns true if the passed in object is equal to this object

Overrides:

equals in class Object

Parameters:

obj - object to check for equality

Returns:

true if the passed in object is equal to this object

hashCode

public int hashCode()

Returns hash code of the object

Overrides:

hashCode in class Object

Returns:

hash code of the object

getSearchIndexAttributes

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

Returns the search index attributes.

Specified by:

getSearchIndexAttributes in interface EntitlementSubject

Returns:

the search index attributes.

getRequiredAttributeNames

public Set<String> getRequiredAttributeNames()

Returns the required attribute names.

Specified by:

getRequiredAttributeNames in interface EntitlementSubject

Returns:

the required attribute names.

isIdentity

public boolean isIdentity()

Returns true is this subject is an identity object.

Specified by:

isIdentity in interface EntitlementSubject

Returns:

true is this subject is an identity object.