Package com.sun.identity.policy.plugins

Class AuthenticatedAgents

  • All Implemented Interfaces:
    Subject, Cloneable
    public class AuthenticatedAgents
extends Object
implements Subject
    This subject applies to all users with valid SSOToken.

    • Constructor Detail

      • AuthenticatedAgents

        public AuthenticatedAgents()

    • Method Detail

      • AuthenticatedAgents

        public void AuthenticatedAgents()
        Default Constructor

      • initialize

        public void initialize​(Map configParams)
        Initialize the subject. No properties are required for this subject.
        Specified by:
        initialize in interface Subject
        Parameters:
        configParams - configurational information

      • getValueSyntax

        public Syntax getValueSyntax​(SSOToken token)
        Returns the syntax of the subject type.
        Specified by:
        getValueSyntax in interface Subject
        Parameters:
        token - the SSOToken. Not used for this subject.
        Returns:
        Syntax for this subject.
        See Also:
        Syntax

      • getValidValues

        public ValidValues getValidValues​(SSOToken token)
        Returns an empty list as possible values.
        Specified by:
        getValidValues in interface Subject
        Parameters:
        token - the SSOToken
        Returns:
        ValidValues object with empty list.

      • getValidValues

        public ValidValues getValidValues​(SSOToken token,
                                  String pattern)
        Returns an empty list as possible values.
        Specified by:
        getValidValues in interface Subject
        Parameters:
        token - the SSOToken
        pattern - the pattern to match in valid values. Ignored for this subject
        Returns:
        ValidValues object with empty list.

      • getDisplayNameForValue

        public String getDisplayNameForValue​(String value,
                                     Locale locale)
        This method does nothing as there are no values to display for this subject.
        Specified by:
        getDisplayNameForValue in interface Subject
        Parameters:
        value - one of the valid value for the plugin
        locale - locale for which the display name must be customized
        Returns:
        the display name for the value for the given locale.

      • getValues

        public Set getValues()
        Returns an empty collection as value.
        Specified by:
        getValues in interface Subject
        Returns:
        an empty set

      • setValues

        public void setValues​(Set names)
        This method does nothing for this subject as there are no values to set for this subject.
        Specified by:
        setValues in interface Subject
        Parameters:
        names - names selected for the instance of the user collection object.

      • isMember

        public boolean isMember​(SSOToken token)
                 throws SSOException
        Determines if the agent belongs to the AuthenticatedAgents object.
        Specified by:
        isMember in interface Subject
        Parameters:
        token - SSOToken of the agent
        Returns:
        true if the agent SSOToken is valid. false otherwise.
        Throws:
        SSOException - if error occurs while validating the token.

      • clone

        public Object clone()
        Creates and returns a copy of this object.
        Specified by:
        clone in interface Subject
        Overrides:
        clone in class Object
        Returns:
        a copy of this object

      • hashCode

        public int hashCode()
        Return a hash code for this AuthenticatedAgents.
        Overrides:
        hashCode in class Object
        Returns:
        a hash code for this AuthenticatedAgents object.

      • isSpecialUser

        protected boolean isSpecialUser​(String dn)
        checks if distinguished user name is a special user (the url access agent, in particular). returns true if so.