com.sun.identity.entitlement.opensso

Class PolicyCondition

java.lang.Object

com.sun.identity.entitlement.EntitlementConditionAdaptor

com.sun.identity.entitlement.opensso.PolicyCondition

All Implemented Interfaces:

EntitlementCondition

public class PolicyCondition
extends EntitlementConditionAdaptor

This condition wraps all OpenAM policy conditions.

Constructor Summary

Constructors

Constructor and Description
PolicyCondition()
PolicyCondition(String name, String className, Map<String,Set<String>> properties) 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
ConditionDecision	evaluate(String realm, Subject subject, String resourceName, Map<String,Set<String>> environment) Returns condition decision.
String	getClassName() Returns class name.
String	getDisplayType() Returns display type.
String	getName() Returns name.
Condition	getPolicyCondition() Constructs a legacy policy Condition object based on the information contained in this adapter.
Map<String,Set<String>>	getProperties() Returns properties.
String	getState() Returns state of this condition.
int	hashCode() Returns hash code of the object.
void	setState(String state) Sets the state of this condition.
void	validate() Checks that this condition is configured correctly.

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

init, setDisplayType, setState, toJSONObject

Methods inherited from class java.lang.Object

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

Constructor Detail

PolicyCondition

public PolicyCondition()

PolicyCondition

public PolicyCondition(String name,
                       String className,
                       Map<String,Set<String>> properties)

Constructor.

Parameters:

name - Name of condition.

className - Implementation class name.

properties - Properties of the condition.

Method Detail

getClassName

public String getClassName()

Returns class name.

Returns:

class name.

getName

public String getName()

Returns name.

Returns:

name.

getProperties

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

Returns properties.

Returns:

properties.

setState

public void setState(String state)

Sets the state of this condition.

Parameters:

state - State of this condition.

getState

public String getState()

Returns state of this condition.

Returns:

state of this condition.

evaluate

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

Returns condition decision.

Parameters:

realm - Realm name.

subject - Subject to be evaluated.

resourceName - Resource name.

environment - Environment map.

Returns:

condition decision.

Throws:

EntitlementException - if error occur.

equals

public boolean equals(Object obj)

Description copied from class: EntitlementConditionAdaptor

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

getDisplayType

public String getDisplayType()

Description copied from class: EntitlementConditionAdaptor

Returns display type.

Specified by:

getDisplayType in interface EntitlementCondition

Overrides:

getDisplayType in class EntitlementConditionAdaptor

Returns:

Display Type.

getPolicyCondition

public Condition getPolicyCondition()
                             throws EntitlementException

Constructs a legacy policy Condition object based on the information contained in this adapter.

Returns:

the legacy policy condition.

Throws:

EntitlementException - if an error occurs constructing the condition.

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.

hashCode

public int hashCode()

Description copied from class: EntitlementConditionAdaptor

Returns hash code of the object.

Overrides:

hashCode in class EntitlementConditionAdaptor

Returns:

hash code of the object.