Package com.sun.identity.policy.plugins

Class AuthRoleCondition

  • All Implemented Interfaces:
    Condition, Cloneable
    @Deprecated
public class AuthRoleCondition
extends Object
implements Condition
    Deprecated.
    Not used internally and not exposed externally so being deprecated and not migrated to entitlements framework.
    The class AuthRoleCondition is a plugin implementation of Condition interface. This condition object provides the policy framework with the condition decision based on the user's authenticated role name.

    • Field Detail

      • ROLE_NAME

        public static final String ROLE_NAME
        Deprecated.
        Key that is used to define the authenticated role name for which the policy would apply. The value should be a Set with only one element. The element should be a String, the full DN of the role.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AuthRoleCondition

        public AuthRoleCondition()
        Deprecated.
        No argument constructor

    • Method Detail

      • getPropertyNames

        public List getPropertyNames()
        Deprecated.
        Returns a set of property names for the condition.
        Specified by:
        getPropertyNames in interface Condition
        Returns:
        set 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 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 properties should define value for the key ROLE_NAME. The value should be a Set with only one element. The element should be a String, the full DN of the role. Please note that properties is not cloned by the method.
        Throws:
        PolicyException - if properties is null or does not contain value for the key ROLE_NAME or the value of the key is not a Set with one String element.
        See Also:
        ConditionDecision

      • getConditionDecision

        public ConditionDecision getConditionDecision​(SSOToken token,
                                              Map env)
                                       throws SSOException,
                                              PolicyException
        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. AuthRoleCondition does not use this parameter.
        Returns:
        the condition decision. The condition decision encapsulates whether a policy applies for the request. User's roles are fetched from the SSOToken and if the role ROLE_NAME is one of the user roles in the token this condition returns true, false otherwise. 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.
        Throws:
        SSOException - if the token is invalid
        PolicyException - for any other abnormal condition
        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