com.sun.identity.entitlement

Class LogicalCondition

java.lang.Object

com.sun.identity.entitlement.EntitlementConditionAdaptor

com.sun.identity.entitlement.LogicalCondition

All Implemented Interfaces:

EntitlementCondition

Direct Known Subclasses:

AndCondition, NotCondition, OrCondition

public abstract class LogicalCondition
extends EntitlementConditionAdaptor

Constructor Summary

Constructors

Constructor and Description
LogicalCondition() Constructor.
LogicalCondition(Set<EntitlementCondition> eConditions) Constructor.
LogicalCondition(Set<EntitlementCondition> eConditions, String pConditionName) 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
abstract ConditionDecision	evaluate(String realm, Subject subject, String resourceName, Map<String,Set<String>> environment) Returns ConditionDecision of EntitlementCondition evaluation
Set<EntitlementCondition>	getEConditions() Returns the nested EntitlementCondition(s).
String	getPConditionName() Returns OpenAM policy Condition name
String	getState() Returns state of the object.
int	hashCode() Returns hash code of the object
void	setEConditions(Set<EntitlementCondition> eConditions) Sets the nested EntitlementCondition(s).
void	setPConditionName(String pConditionName) Sets OpenAM policy Condition 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
void	validate() Checks that this condition is configured correctly.

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

getDisplayType, init, setDisplayType, setState, toJSONObject

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicalCondition

public LogicalCondition()

Constructor.

LogicalCondition

public LogicalCondition(Set<EntitlementCondition> eConditions)

Constructor.

Parameters:

eConditions - wrapped EntitlementCondition(s)

LogicalCondition

public LogicalCondition(Set<EntitlementCondition> eConditions,
                        String pConditionName)

Constructor.

Parameters:

eConditions - wrapped EntitlementCondition(s)

pConditionName - subject name as used in OpenAM policy, this is relevant only when UserECondition was created from OpenAM policy Condition

Method Detail

setState

public void setState(String state)

Sets state of the object

Parameters:

state - State of the object encoded as string

getState

public String getState()

Returns state of the object.

Returns:

state of the object encoded as string.

evaluate

public abstract ConditionDecision evaluate(String realm,
                                           Subject subject,
                                           String resourceName,
                                           Map<String,Set<String>> environment)
                                    throws EntitlementException

Returns ConditionDecision of EntitlementCondition evaluation

Parameters:

realm - Realm name.

subject - EntitlementCondition who is under evaluation.

resourceName - Resource name.

environment - Environment parameters.

Returns:

ConditionDecision of EntitlementCondition evaluation

Throws:

EntitlementException - if error occurs.

setEConditions

public void setEConditions(Set<EntitlementCondition> eConditions)

Sets the nested EntitlementCondition(s).

Parameters:

eConditions - the nested EntitlementCondition(s)

getEConditions

public Set<EntitlementCondition> getEConditions()

Returns the nested EntitlementCondition(s).

Returns:

the nested EntitlementCondition(s).

setPConditionName

public void setPConditionName(String pConditionName)

Sets OpenAM policy Condition name

Parameters:

pConditionName - subject name as used in OpenAM policy, this is relevant only when UserECondition was created from OpenAM policy Condition

getPConditionName

public String getPConditionName()

Returns OpenAM policy Condition name

Returns:

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

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 EntitlementConditionAdaptor

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 EntitlementConditionAdaptor

Returns:

hash code of the object

validate

public void validate()
              throws EntitlementException

Description copied from interface: EntitlementCondition

Checks that this condition is configured correctly. Throws EntitlementException if not with an informative message to display to the user creating/updating the policy.

Throws:

EntitlementException - if the configuration state is not valid.