Package com.sun.identity.policy.plugins

Class AuthSchemeCondition

  • All Implemented Interfaces:
    Condition, Cloneable
    @Deprecated
public class AuthSchemeCondition
extends Object
implements Condition
    Deprecated.
    Use AuthSchemeCondition instead.
    The class AuthSchemeCondition is a plugin implementation of Condition that lets you define authentication module instances for which a Policy applies.

    • Field Detail

      • APPLICATION_IDLE_TIMESOUT_AT_PREFIX

        public static final String APPLICATION_IDLE_TIMESOUT_AT_PREFIX
        Deprecated.
        Prefix for key that is used to set session property to track application based session idle timeout
        See Also:
        Constant Field Values

      • FORCE_AUTH_ADVICE

        public static final String FORCE_AUTH_ADVICE
        Deprecated.
        Key name that is used to communicate ForceAuth advice. This indicates to authentication service that user needs to authenticate again even if he has already authenticated to required module instance, chain, level or realm.
        See Also:
        Constant Field Values

      • MODULE_INSTANCE

        public static final String MODULE_INSTANCE
        Deprecated.
        Constant for representing authn type of module_intance
        See Also:
        Constant Field Values

    • Constructor Detail

      • AuthSchemeCondition

        public AuthSchemeCondition()
        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 - 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 - 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 - 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 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 properties should define value for the key AUTH_SCHEME. The value should be a Set with only one element. The element should be a String, the authentication module instance name. Please note that properties is not cloned by the method.
        Throws:
        PolicyException - if properties is null or does not contain value for the key AUTH_SCHEME or the value of the key is not a Set with one String element
        See Also:
        Condition.REQUEST_AUTH_SCHEMES

      • getProperties

        public Map getProperties()
        Deprecated.
        Gets the properties of the condition.
        Specified by:
        getProperties in interface Condition
        Returns:
        unmodifiable map view of properties that govern the evaluation of the condition. Please note that properties is not cloned before returning
        See Also:
        setProperties(Map)

      • getConditionDecision

        public ConditionDecision getConditionDecision​(SSOToken token,
                                              Map env)
                                       throws PolicyException,
                                              SSOException
        Deprecated.
        Gets the decision computed by this condition object, based on the map of environment parameters
        Specified by:
        getConditionDecision in interface Condition
        Parameters:
        token - single sign on token of the user
        env - request specific environment map of key/value pairs AuthSchemeCondition looks for value of key REQUEST_AUTH_SCHEHMES in the map. The value should be a String. If the env parameter is null or does not define the value for , value for REQUEST_AUTH_SCHEMES is computed using AuthMethod 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 REQUEST_AUTH_SCHEMES could not be determined.
        SSOException - if the token is invalid
        See Also:
        setProperties(Map), Condition.AUTH_SCHEME, Condition.REQUEST_AUTH_SCHEMES, 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