Package org.identityconnectors.framework.common.objects

Class AttributeInfo

java.lang.Object
org.identityconnectors.framework.common.objects.AttributeInfo
public final class AttributeInfo extends Object
AttributeInfo is meta data responsible for describing an Attribute. It can be programmatically determined at runtime or statically constructed. The class determines if an Attribute is required, readable, writable, or nullable. In also includes the native type and name. It is recommended that date fields be represented as a long with time zone UTC. It should be up to the display or separate attributes if the time zone is necessary.

  • Method Details

    • getName

      public String getName()
      The native name of the attribute.
      Returns:
      the native name of the attribute its describing.

    • getType

      public Class<?> getType()
      The basic type associated with this attribute. All primitives are supported.
      Returns:
      the native type if uses.

    • getFlags

      public Set<AttributeInfo.Flags> getFlags()
      Returns the set of flags associated with the attribute.
      Returns:
      the set of flags associated with the attribute

    • isReadable

      public boolean isReadable()
      Determines if the attribute is readable.
      Returns:
      true if the attribute is readable else false.

    • isCreateable

      public boolean isCreateable()
      Determines if the attribute is writable on create.
      Returns:
      true if the attribute is writable on create else false.

    • isUpdateable

      public boolean isUpdateable()
      Determines if the attribute is writable on update.
      Returns:
      true if the attribute is writable on update else false.

    • isRequired

      public boolean isRequired()
      Determines whether this attribute is required for creates.
      Returns:
      true if the attribute is required for an object else false.

    • isMultiValued

      public boolean isMultiValued()
      Determines if this attribute can handle multiple values. There is a special case with byte[] since in most instances this denotes a single object.
      Returns:
      true if the attribute is multi-value otherwise false.

    • isReturnedByDefault

      public boolean isReturnedByDefault()
      Determines if the attribute is returned by default. Indicates if an Attribute will be returned during SearchApiOp, SyncApiOp or GetApiOp inside a ConnectorObject by default. The default value is true.
      Returns:
      false if the attribute should not be returned by default.

    • is

      public boolean is(String name)
      Determines if the name parameter matches this AttributeInfo.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object