Package com.sun.identity.idm

Class IdType

  • All Implemented Interfaces:
    Serializable
    @SupportedAll
public class IdType
extends Object
implements Serializable
    The class IdType defines the types of supported identities, and provides static constants for these identities. Currently defined identities are IdType.USER, IdType.ROLE, IdType.GROUP and IdType.AGENT. The usage of the respective types are defined along with their declaration.

    An IdType can also have a 3 character shortened name of the type. This is used for encoding the type when sent to the client in limited length fields. Each short name must be unique.

    See Also:
    Serialized Form

    • Field Detail

      • USER

        public static final IdType USER
        Identity type of USER

      • ROLE

        public static final IdType ROLE
        Identity type of ROLE

      • GROUP

        public static final IdType GROUP
        Identity type of GROUP

      • AGENT

        public static final IdType AGENT
        Identity type of AGENT Also from OpenSSO 8.0 onwards, this is the Identity type of the union of agents and those under the agent groups.

      • FILTEREDROLE

        public static final IdType FILTEREDROLE
        Identity type of filter role.

      • REALM

        public static final IdType REALM

      • AGENTONLY

        public static final IdType AGENTONLY
        Identity type of OpenAM agent only.

      • AGENTGROUP

        public static final IdType AGENTGROUP
        Identity type of OpenAM agents under the OpenAM agent groups.

      • OAUTH2_DYNAMIC_CLIENT

        public static final IdType OAUTH2_DYNAMIC_CLIENT
        Identity type for an OAuth 2.0 dynamic client agent. The attributes of this type will exclude the agent group attributes.

      • OAUTH2_DYNAMIC_CLIENT_GROUP_UNION

        public static final IdType OAUTH2_DYNAMIC_CLIENT_GROUP_UNION
        Identity type for an OAuth 2.0 dynamic client agent and agent group union. The attributes of this type will be the union of a client and its associated group (if applicable), with agent attributes taking precedence.

    • Method Detail

      • getType

        public static IdType getType​(String type)
        Get the IdType.

        For the given string, search for a matching existing IdType or create a new one and keep a reference to it for subsequent calls.

        Parameters:
        type - Non null type to use for the IdType.
        Returns:
        The non null IdType for the given string.

      • hashCode

        public int hashCode()
        Returns the hash code of the object
        Overrides:
        hashCode in class Object

      • getName

        public String getName()
        Returns the name of this type, for example user for type User.
        Returns:
        Name of the this type.

      • canHaveMembers

        public Set canHaveMembers()
        Returns a set of types of identities this type can hav as its' members.
        Returns:
        Set of IdType which can be members of this identity type.

      • canBeMemberOf

        public Set canBeMemberOf()
        Returns a set of types of identities that this type can be a member of.
        Returns:
        Set of IdType.

      • canAddMembers

        public Set canAddMembers()
        Returns a set of types of identities that this type can add as members.
        Returns:
        Set of IdType.