org.forgerock.openam.entitlement.conditions.environment

Class ResourceEnvIPCondition

java.lang.Object

com.sun.identity.entitlement.EntitlementConditionAdaptor

org.forgerock.openam.entitlement.conditions.environment.ResourceEnvIPCondition

All Implemented Interfaces:

EntitlementCondition

public class ResourceEnvIPCondition
extends EntitlementConditionAdaptor

This condition provides the policy framework with the condition decision and advices based on the client's environment or resource such as IP address, DNS host name, location, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_CONDITION_VALUE

Constructor Summary

Constructors

Constructor and Description
ResourceEnvIPCondition() No argument constructor
ResourceEnvIPCondition(Debug debug)

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>> env) Returns condition decision.
Set<String>	getResourceEnvIPConditionValue()
String	getState() Returns state of the object encoded as a JSON string.
int	hashCode() Returns hash code of the object.
void	setResourceEnvIPConditionValue(Set<String> resourceEnvIPConditionValue)
void	setState(String state) Sets state of this object from a JSON string.
String	toString()
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

ENV_CONDITION_VALUE

public static final String ENV_CONDITION_VALUE

See Also:

Constant Field Values

Constructor Detail

ResourceEnvIPCondition

public ResourceEnvIPCondition()

No argument constructor

ResourceEnvIPCondition

public ResourceEnvIPCondition(Debug debug)

Method Detail

evaluate

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

Returns condition decision.

Parameters:

realm - Realm Name.

subject - Subject who is under evaluation.

resourceName - Resource name.

env - Environment parameters.

Returns:

resulting condition decision.

Throws:

EntitlementException - if cannot get condition decision.

setState

public void setState(String state)

Description copied from interface: EntitlementCondition

Sets state of this object from a JSON string.

Parameters:

state - State of the object encoded as a JSON string

getState

public String getState()

Description copied from interface: EntitlementCondition

Returns state of the object encoded as a JSON string.

Returns:

state of the object encoded as a JSON string.

toString

public String toString()

Overrides:

toString in class Object

getResourceEnvIPConditionValue

public Set<String> getResourceEnvIPConditionValue()

setResourceEnvIPConditionValue

public void setResourceEnvIPConditionValue(Set<String> resourceEnvIPConditionValue)

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.

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

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.