com.sun.identity.policy.plugins

Class ResourceEnvIPCondition

java.lang.Object

com.sun.identity.policy.plugins.ResourceEnvIPCondition

All Implemented Interfaces:

Condition, Cloneable

Deprecated.

Use instead.

@Deprecated
public class ResourceEnvIPCondition
extends Object
implements Condition

The class ResourceEnvIPCondition is a plugin implementation of Condition interface. This condition object 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. For the first drop, we are only supporting IP address.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_CONDITION_VALUE Deprecated.
static String	IP Deprecated.
static String	THEN Deprecated.

Fields inherited from interface com.sun.identity.policy.interfaces.Condition

AM_IDENTITY_NAME, APPLICATION_IDLE_TIMEOUT, APPLICATION_NAME, AUTH_LEVEL, AUTH_LEVEL_CONDITION_ADVICE, AUTH_SCHEME, AUTH_SCHEME_CONDITION_ADVICE, AUTHENTICATE_TO_REALM, AUTHENTICATE_TO_REALM_CONDITION_ADVICE, AUTHENTICATE_TO_SERVICE, AUTHENTICATE_TO_SERVICE_CONDITION_ADVICE, DNS_NAME, END_DATE, END_DAY, END_IP, END_TIME, ENFORCEMENT_TIME_ZONE, INVOCATOR_PRINCIPAL_UUID, LDAP_FILTER, MAX_SESSION_TIME, REQUEST_AUTH_LEVEL, REQUEST_AUTH_SCHEMES, REQUEST_AUTHENTICATED_TO_REALMS, REQUEST_AUTHENTICATED_TO_SERVICES, REQUEST_DNS_NAME, REQUEST_IP, REQUEST_TIME_ZONE, START_DATE, START_DAY, START_IP, START_TIME, TERMINATE_SESSION, VALUE_CASE_INSENSITIVE

Constructor Summary

Constructors

Constructor and Description
ResourceEnvIPCondition() Deprecated. No argument constructor

Method Summary

Modifier and Type	Method and Description
Object	clone() Deprecated. Returns a copy of this object.
ConditionDecision	getConditionDecision(SSOToken token, Map env) Deprecated. Returns the decision computed by ResourceEnvIPCondition object.
String	getDisplayName(String property, Locale locale) Deprecated. Returns the display name for the property name.
Map	getProperties() Deprecated. Returns properties of ResourceEnvIPCondition.
List	getPropertyNames() Deprecated. Returns a list of property names for ResourceEnvIPCondition.
Syntax	getPropertySyntax(String property) Deprecated. Returns the syntax for a property name
Set	getValidValues(String property) Deprecated. Returns a set of valid values given the property name.
void	setProperties(Map properties) Deprecated. Sets the properties of ResourceEnvIPCondition.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENV_CONDITION_VALUE

public static final String ENV_CONDITION_VALUE

Deprecated.

See Also:

Constant Field Values

IP

public static final String IP

Deprecated.

See Also:

Constant Field Values

THEN

public static final String THEN

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ResourceEnvIPCondition

public ResourceEnvIPCondition()

Deprecated.

No argument constructor

Method Detail

getPropertyNames

public List getPropertyNames()

Deprecated.

Returns a list of property names for ResourceEnvIPCondition.

Specified by:

getPropertyNames in interface Condition

Returns:

List of property names

getPropertySyntax

public Syntax getPropertySyntax(String property)

Deprecated.

Returns the syntax for a property name

Specified by:

getPropertySyntax in interface Condition

Parameters:

property - String property name

Returns:

Syntax for the property name

See Also:

Syntax

getDisplayName

public String getDisplayName(String property,
                             Locale locale)
                      throws PolicyException

Deprecated.

Returns the display name for the property name. The locale variable could be used by the plugin to customize the display name for the given locale. The locale variable could be null, in which case the plugin must use the default locale.

Specified by:

getDisplayName in interface Condition

Parameters:

property - String property name

locale - Locale for which the property name must be customized

Returns:

display name for the property name

Throws:

PolicyException

getValidValues

public Set getValidValues(String property)
                   throws PolicyException

Deprecated.

Returns a set of valid values given the property name. This method is called if the property Syntax is either the SINGLE_CHOICE or MULTIPLE_CHOICE.

Specified by:

getValidValues in interface Condition

Parameters:

property - String property name

Returns:

Set of valid values for the property.

Throws:

PolicyException - if unable to get the Syntax.

setProperties

public void setProperties(Map properties)
                   throws PolicyException

Deprecated.

Sets the properties of ResourceEnvIPCondition. Evaluation of ConditionDecision is influenced by these properties.

Specified by:

setProperties in interface Condition

Parameters:

properties - the properties of the condition that governs whether a policy applies. The properties should define value for the key ENV_CONDITION_VALUE. The value should be a Set with multiple elements. Each element should be a String. Please note that properties is not cloned by the method.

Throws:

PolicyException - if properties is null or does not contain value for the key ENV_CONDITION_VALUE or the value of the key is not a Set with one String element that is parsable as an integer.

See Also:

ConditionDecision

getProperties

public Map getProperties()

Deprecated.

Returns properties of ResourceEnvIPCondition.

Specified by:

getProperties in interface Condition

Returns:

properties of the condition

See Also:

Condition.setProperties(java.util.Map<java.lang.String, java.util.Set<java.lang.String>>)

getConditionDecision

public ConditionDecision getConditionDecision(SSOToken token,
                                              Map env)
                                       throws PolicyException,
                                              SSOException

Deprecated.

Returns the decision computed by ResourceEnvIPCondition object.

Specified by:

getConditionDecision in interface Condition

Parameters:

token - single sign on token of the user

env - request specific environment map of key/value pairs ResourceEnvIPCondition looks for values of key REQUEST_IP in the env map. If REQUEST_IP could not be determined from env, it is obtained from single sign on token of the user.

Returns:

the condition decision. The condition decision encapsulates whether a policy applies for the request and advice messages generated by the condition. Policy framework continues evaluating a policy only if it applies to the request as indicated by the ConditionDecision. Otherwise, further evaluation of the policy is skipped. However, the advice messages encapsulated in the ConditionDecision are aggregated and passed up, encapsulated in the policy decision.

Throws:

PolicyException - if the condition has not been initialized with a successful call to setProperties(Map) and/or the value of key REQUEST_IP is not a String.

SSOException - if the token is invalid

See Also:

setProperties(Map), Condition.REQUEST_IP, ConditionDecision

clone

public Object clone()

Deprecated.

Returns a copy of this object.

Specified by:

clone in interface Condition

Overrides:

clone in class Object

Returns:

a copy of this object