Package com.evolveum.midpoint.schema.processor

Interface ResourceAttributeContainerDefinition

All Superinterfaces:
Cloneable, DebugDumpable, Definition, Freezable, ItemDefinition<PrismContainer<ShadowAttributesType>>, LocalItemDefinitionStore, PrismContainerDefinition<ShadowAttributesType>, PrismContextSensitive, PrismItemAccessDefinition, Revivable, Serializable, SmartVisitable<Definition>, Visitable<Definition>
All Known Subinterfaces:
AttributeContainerDefinitionDelegator
All Known Implementing Classes:
ResourceAttributeContainerDefinitionImpl, TransformableContainerDefinition.AttributeContainer
public interface ResourceAttributeContainerDefinition extends PrismContainerDefinition<ShadowAttributesType>
TODO review docs Resource Object Definition (Object Class). Object Class refers to a type of object on the Resource. Unix account, Active Directory group, inetOrgPerson LDAP objectclass or a schema of USERS database table are all Object Classes from the midPoint point of view. Object class defines a set of attribute names, types for each attributes and few additional properties. This class represents schema definition for resource object (object class). See Definition for more details. Resource Object Definition is immutable. TODO: This will probably need to be changed to a mutable object.
Author:
Radovan Semancik

  • Method Details

    • getComplexTypeDefinition

      ResourceObjectDefinition getComplexTypeDefinition()
      Description copied from interface: PrismContainerDefinition
      Definition of the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.) Note that individual values can hold their own (more specific) complex type definitions.
      Specified by:
      getComplexTypeDefinition in interface PrismContainerDefinition<ShadowAttributesType>

    • getPrimaryIdentifiers

      Collection<? extends ResourceAttributeDefinition<?>> getPrimaryIdentifiers()
      TODO review docs Returns the definition of primary identifier attributes of a resource object. May return empty set if there are no identifier attributes. Must not return null. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.
      Returns:
      definition of identifier attributes
      Throws:
      IllegalStateException - if there is no definition for the referenced attributed

    • getSecondaryIdentifiers

      Collection<? extends ResourceAttributeDefinition<?>> getSecondaryIdentifiers()
      TODO review docs Returns the definition of secondary identifier attributes of a resource object. May return empty set if there are no secondary identifier attributes. Must not return null. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.
      Returns:
      definition of secondary identifier attributes
      Throws:
      IllegalStateException - if there is no definition for the referenced attributed

    • getAllIdentifiers

      Collection<? extends ResourceAttributeDefinition<?>> getAllIdentifiers()

    • getDescriptionAttribute

      ResourceAttributeDefinition<?> getDescriptionAttribute()
      TODO review docs Returns the definition of description attribute of a resource object. Returns null if there is no description attribute. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.
      Returns:
      definition of secondary identifier attributes
      Throws:
      IllegalStateException - if there is more than one description attribute. But this should never happen.
      IllegalStateException - if there is no definition for the referenced attributed

    • getNamingAttribute

      ResourceAttributeDefinition<?> getNamingAttribute()
      TODO review docs Specifies which resource attribute should be used as a "technical" name for the account. This name will appear in log files and other troubleshooting tools. The name should be a form of unique identifier that can be used to locate the resource object for diagnostics. It should not contain white chars and special chars if that can be avoided and it should be reasonable short. It is different from a display name attribute. Display name is intended for a common user or non-technical administrator (such as role administrator). The naming attribute is intended for technical IDM administrators and developers.
      Returns:
      resource attribute definition that should be used as a "technical" name for the account.

    • getNativeObjectClass

      String getNativeObjectClass()
      TODO review docs Returns the native object class string for the resource object. Native object class is the name of the Resource Object Definition (Object Class) as it is seen by the resource itself. The name of the Resource Object Definition may be constrained by XSD or other syntax and therefore may be "mangled" to conform to such syntax. The native object class value will contain un-mangled name (if available). Returns null if there is no native object class. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.
      Returns:
      native object class
      Throws:
      IllegalStateException - if there is more than one description attribute.

    • isDefaultAccountDefinition

      boolean isDefaultAccountDefinition()
      TODO review docs Indicates whether definition is should be used as default account type. If true value is returned then the definition should be used as a default account type definition. This is a way how a resource connector may suggest applicable object classes (resource object definitions) for accounts. If no information about account type is present, false should be returned. This method must return true only if isAccountType() returns true. The exception should be never thrown unless there is some bug in the code. The validation of at-most-one value should be done at the time of schema parsing. The exception may not even be thrown at all if the implementation is not able to determine duplicity.
      Returns:
      true if the definition should be used as account type.
      Throws:
      IllegalStateException - if more than one default account is suggested in the schema.

    • getDisplayNameAttribute

      ResourceAttributeDefinition<?> getDisplayNameAttribute()
      TODO review docs Returns the definition of display name attribute. Display name attribute specifies which resource attribute should be used as title when displaying objects of a specific resource object class. It must point to an attribute of String type. If not present, primary identifier should be used instead (but this method does not handle this default behavior). Returns null if there is no display name attribute. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.
      Returns:
      native object class
      Throws:
      IllegalStateException - if there is more than one display name attribute or the definition of the referenced attribute does not exist.

    • instantiate

      @NotNull @NotNull ResourceAttributeContainer instantiate()
      Description copied from interface: ItemDefinition
      Create an item instance. Definition name or default name will be used as an element name for the instance. The instance will otherwise be empty.
      Specified by:
      instantiate in interface ItemDefinition<PrismContainer<ShadowAttributesType>>

    • instantiate

      @NotNull @NotNull ResourceAttributeContainer instantiate(QName name)
      Description copied from interface: ItemDefinition
      Create an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.
      Specified by:
      instantiate in interface ItemDefinition<PrismContainer<ShadowAttributesType>>

    • clone

      @NotNull @NotNull ResourceAttributeContainerDefinition clone()
      Specified by:
      clone in interface Definition
      Specified by:
      clone in interface ItemDefinition<PrismContainer<ShadowAttributesType>>
      Specified by:
      clone in interface PrismContainerDefinition<ShadowAttributesType>

    • findAttributeDefinition

      <T> ResourceAttributeDefinition<T> findAttributeDefinition(QName elementQName, boolean caseInsensitive)

    • findAttributeDefinition

      ResourceAttributeDefinition<?> findAttributeDefinition(ItemPath elementPath)

    • findAttributeDefinition

      ResourceAttributeDefinition<?> findAttributeDefinition(String localName)

    • getAttributeDefinitions

      List<? extends ResourceAttributeDefinition<?>> getAttributeDefinitions()

    • getDefinitions

      @NotNull @NotNull List<? extends ResourceAttributeDefinition<?>> getDefinitions()
      Description copied from interface: PrismContainerDefinition
      Returns a list of item definitions in this container. It is intentionally a List because it is ordered. (To provide standard format for serialization.) Usually obtained from ComplexTypeDefinition. So please do not modify the content of the list!
      Specified by:
      getDefinitions in interface LocalItemDefinitionStore
      Specified by:
      getDefinitions in interface PrismContainerDefinition<ShadowAttributesType>

    • toShadowDefinition

      @NotNull <T extends ShadowType> @NotNull PrismObjectDefinition<T> toShadowDefinition()