Package com.sun.identity.entitlement

Class AttributeLookupCondition

java.lang.Object

com.sun.identity.entitlement.EntitlementConditionAdaptor

com.sun.identity.entitlement.AttributeLookupCondition

All Implemented Interfaces:

EntitlementCondition

public class AttributeLookupCondition
extends EntitlementConditionAdaptor

This condition evaluates if a given attribute from subject matches with the one in resource.

Field Summary

Fields

Modifier and Type	Field	Description
static String	MACRO_RESOURCE	Resource Macro
static String	MACRO_USER	User Macro

Constructor Summary

Constructors

Constructor	Description
AttributeLookupCondition()	Constructor.
AttributeLookupCondition(String key, String value)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Returns true if the passed in object is equal to this object
ConditionDecision	evaluate(String realm, Subject subject, String resourceName, Map<String,Set<String>> environment)	Returns ConditionDecision of EntitlementCondition evaluation.
String	getKey()	Returns matching key.
String	getPConditionName()	Returns OpenAM policy Condition name.
String	getState()	Returns state of the object.
String	getValue()	Returns matching value.
int	hashCode()	Returns hash code of the object.
void	setKey(String key)	Sets matching key.
void	setPConditionName(String pConditionName)	Sets OpenAM policy Condition name
void	setState(String state)	Sets state of the object
void	setValue(String value)	Set matching value.
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

Field Detail

MACRO_USER

public static final String MACRO_USER

User Macro

See Also:

Constant Field Values

MACRO_RESOURCE

public static final String MACRO_RESOURCE

Resource Macro

See Also:

Constant Field Values

Constructor Detail

AttributeLookupCondition

public AttributeLookupCondition()

Constructor.

AttributeLookupCondition

public AttributeLookupCondition(String key,
                                String value)

Constructor.

Parameters:

key - Matching key.

value - Matching value.

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 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.

getKey

public String getKey()

Returns matching key.

Returns:

matching key.

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.

getValue

public String getValue()

Returns matching value.

Returns:

matching value.

setKey

public void setKey(String key)

Sets matching key.

Parameters:

key - Matching key.

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.

setValue

public void setValue(String value)

Set matching value.

Parameters:

value - Matching value.

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

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.

toString

public String toString()

Returns string representation of the object.

Overrides:

toString in class Object

Returns:

string representation 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.