Package com.sun.identity.policy.plugins

Class AuthenticateToRealmCondition

  • All Implemented Interfaces:
    Condition, Cloneable
    @Deprecated
public class AuthenticateToRealmCondition
extends Object
implements Condition
    Deprecated.
    Use AuthenticateToRealmCondition instead.
    The class AuthenticateToRealmCondition is a plugin implementation of Condition that lets you specify the realm to which user should authenticate for the policy to apply

    • Constructor Detail

      • AuthenticateToRealmCondition

        public AuthenticateToRealmCondition()
        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.
        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 - 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 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 - property name
        Returns:
        Set of valid values for the property.
        Throws:
        PolicyException - if unable to get 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 AUTHENTICATE_TO_REALM. The value should be a Set with only one element. The element should be a String, the realm name for which the user should authenticate for the policy to apply. Please note that properties is not cloned by the method.
        Throws:
        PolicyException - if properties is null or does not contain value for the key AUTHENTICATE_TO_REALM or the value of the key is not a Set with one String element
        See Also:
        Condition.REQUEST_AUTHENTICATED_TO_REALMS

      • getProperties

        public Map getProperties()
        Deprecated.
        Returns 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.
        Returns 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 AuthenticateToRealmCondition looks for value of key REQUEST_AUTHENTICATED_TO_REALMS in the map. The value should be a Set with String elements. If the env parameter is null or does not define the value for REQUEST_AUTHENTICATED_TO_REALMS, value for REQUEST_AUTHENTICATED_TO_REALMS is computed from sso token.
        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_AUTHENTICATED_TO_REALMS could not be determined.
        SSOException - if the token is invalid
        See Also:
        setProperties(Map), Condition.AUTHENTICATE_TO_REALM, Condition.REQUEST_AUTHENTICATED_TO_REALMS, 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