com.sun.identity.policy.plugins

Class LDAPFilterCondition

java.lang.Object

com.sun.identity.policy.plugins.LDAPFilterCondition

All Implemented Interfaces:

Condition, Cloneable

Deprecated.

Use LDAPFilterCondition instead.

@Deprecated
public class LDAPFilterCondition
extends Object
implements Condition

The class LDAPFilterCondition is a plugin implementation of Condition interface. This condition checks whether the ldap entry of the user identified by sso token, in the directory specified in policy configuration service, satisfiies the ldap filter specified in the condition

Field Summary

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
LDAPFilterCondition() 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 this condition object.
String	getDisplayName(String property, Locale locale) Deprecated. Returns the display name for the property name.
Map	getProperties() Deprecated. Returns properties of this condition.
List	getPropertyNames() Deprecated. Returns the List of property names for the condition.
Syntax	getPropertySyntax(String property) Deprecated. Returns the syntax for a property name
Set	getValidValues(String property) Deprecated. Returns the set of valid values given the property name.
void	setProperties(Map properties) Deprecated. Sets the properties of the condition.
void	validate() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPFilterCondition

public LDAPFilterCondition()

Deprecated.

No argument constructor

Method Detail

getPropertyNames

public List getPropertyNames()

Deprecated.

Returns the List of property names for the condition.

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 - name of property for which to get Syntax

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 - name of property for which to get the display name

locale - locale for which to get the display name

Returns:

display name for the property name

Throws:

PolicyException

getValidValues

public Set getValidValues(String property)
                   throws PolicyException

Deprecated.

Returns the 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 - name of property for which to find valid values

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 the condition. 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 keys in properties should be String objects. Value corresponding to each key should be a Set of String(s). Please note that properties is not cloned by the method. This condition requires value for key LDAP_FILTER to be defined. The value corresponding to the key should be a Set with only one element. The element should be a String.

Throws:

PolicyException - if properties is null or empty or does not contain value for key LDAP_FILTER or contains values for other keys

See Also:

Condition.LDAP_FILTER

getProperties

public Map getProperties()

Deprecated.

Returns properties of this condition.

Specified by:

getProperties in interface Condition

Returns:

properties of the condition as an unmodifiable Map.

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

Returns:

the condition decision. The ConditionDecision encapsulates whether a policy applies for the request. The condition decision would imply true, if the ldap entry of the user, in the directory specified by policy configuration service, satifies the ldap filter, specified by LDAP_FILTER property of this condition. Otherwise, it would imply false Policy framework continues evaluating a policy only if it applies to the request as indicated by the CondtionDecision. Otherwise, further evaluation of the policy is skipped.

Throws:

SSOException - if the token is invalid

PolicyException - if the decision could not be computed

See Also:

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

validate

public void validate()
              throws PolicyException

Deprecated.

Throws:

PolicyException