Package org.identityconnectors.framework.common.objects

Class ObjectClass

  • public final class ObjectClass
extends java.lang.Object
    An instance of ObjectClass specifies a category or type of ConnectorObject. This class predefines some common object-classes, such as ACCOUNT and GROUP.
    Since:
    1.0

    • Constructor Summary

      Constructors 
      Constructor Description
      ObjectClass​(java.lang.String type)
      Create a custom object class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getDisplayNameKey()
      Convenience method to build the display name key for an object class.
      java.lang.String getObjectClassValue()
      Get the name of the object class.
      int hashCode()  
      boolean is​(java.lang.String name)
      Determines if the 'name' matches this ObjectClass.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • ACCOUNT_NAME

        public static final java.lang.String ACCOUNT_NAME
        This constant defines a specific value of ObjectClass that is reserved for ACCOUNT.

      • GROUP_NAME

        public static final java.lang.String GROUP_NAME
        This constant defines a specific value of ObjectClass that is reserved for GROUP.

      • ALL_NAME

        public static final java.lang.String ALL_NAME
        This constant defines a specific value of ObjectClass that is reserved for ALL.

      • ACCOUNT

        public static final ObjectClass ACCOUNT
        Represents a human being in the context of a specific system or application.

        When an attribute matching this constant is found within a ConnectorObject, this indicates that the ConnectorObject represents a human being (actual or fictional) within the context of a specific system or application.

        Generally, an Account object records characteristics of a human user (such as loginName, password, user preferences or access privileges) that are relevant only to (or primarily to) a specific system or application.

      • GROUP

        public static final ObjectClass GROUP
        Represents a collection that contains an object (such as an account).

        When an attribute matching this constant is found within a ConnectorObject, this indicates that the ConnectorObject represents a group.

    • Constructor Detail

      • ObjectClass

        public ObjectClass​(java.lang.String type)
        Create a custom object class.
        Parameters:
        type - string representation for the name of the object class.

    • Method Detail

      • getObjectClassValue

        public java.lang.String getObjectClassValue()
        Get the name of the object class. (For example, the name of ACCOUNT is the value defined by ACCOUNT_NAME, which is "__ACCOUNT__".)

      • getDisplayNameKey

        public java.lang.String getDisplayNameKey()
        Convenience method to build the display name key for an object class.
        Returns:
        The display name key.

      • is

        public boolean is​(java.lang.String name)
        Determines if the 'name' matches this ObjectClass.
        Parameters:
        name - case-insensitive string representation of the ObjectClass's type.
        Returns:
        true if the case-insensitive name is equal to that of the one in this ObjectClass.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object