Package com.sun.identity.policy.plugins

Class SessionPropertyCondition

  • All Implemented Interfaces:
    Condition, Cloneable
    @Deprecated
public class SessionPropertyCondition
extends Object
implements Condition
    Deprecated.
    Use SessionPropertyCondition instead.
    The class SessionPropertyCondition is a plugin implementation of Condition interface. This condition checks whether session properties contain at least one value of the each property listed in the Condition

    • Constructor Detail

      • SessionPropertyCondition

        public SessionPropertyCondition()
        Deprecated.
        No argument constructor

    • Method Detail

      • getPropertyNames

        public List getPropertyNames()
        Deprecated.
        Returns a 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 - String representing property name
        Returns:
        Syntax for the property name
        See Also:
        Syntax

      • getDisplayName

        public String getDisplayName​(String property,
                             Locale locale)
                      throws PolicyException
        Deprecated.
        Gets 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 representing property name
        locale - Locale for which the property name must be customized.
        Returns:
        display name for the property name
        Throws:
        PolicyException - if unable to get the display name.

      • 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 representing property name
        Returns:
        Set of valid values for the property.
        Throws:
        PolicyException - if unable to get the Set of valid values.

      • 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.
        Throws:
        PolicyException - if properties is null or empty
        See Also:
        ConditionDecision

      • getConditionDecision

        public ConditionDecision getConditionDecision​(SSOToken token,
                                              Map env)
                                       throws PolicyException,
                                              SSOException
        Deprecated.
        Gets 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. Not used by this Condition implementation.
        Returns:
        the condition decision. The condition decision encapsulates whether a policy applies for the request. The condition decision would imply true, if the session properties contain at least one value of the each property listed in the 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 - in unable to get the condition decision..
        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