Package com.evolveum.midpoint.schema.processor

Class ResourceAttributeContainerDefinitionImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.schema.SchemaRegistryStateAware

com.evolveum.midpoint.prism.impl.DefinitionImpl

com.evolveum.midpoint.prism.impl.ItemDefinitionImpl<PrismContainer<C>>

com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<ShadowAttributesType>

com.evolveum.midpoint.schema.processor.ResourceAttributeContainerDefinitionImpl

All Implemented Interfaces:

Definition, Definition.DefinitionBuilder, Definition.DefinitionMutator, DefinitionFragmentBuilder, Freezable, ItemDefinition<PrismContainer<ShadowAttributesType>>, ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutator, LivePrismItemDefinition, LocalItemDefinitionStore, PrismContainerDefinition<ShadowAttributesType>, PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAttributesType>, PrismItemAccessDefinition, PrismItemAccessDefinition.Mutable, PrismItemBasicDefinition, PrismItemBasicDefinition.Mutable, PrismItemStorageDefinition, PrismItemStorageDefinition.Mutable, PrismLifecycleDefinition, PrismLifecycleDefinition.Mutable, PrismPresentationDefinition, PrismPresentationDefinition.Mutable, Revivable, SerializableContainerDefinition, SerializableDefinition, SerializableItemDefinition, SmartVisitable<Definition>, Visitable<Definition>, ResourceAttributeContainerDefinition, DebugDumpable, Serializable, Cloneable

public class ResourceAttributeContainerDefinitionImpl
extends com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<ShadowAttributesType>
implements ResourceAttributeContainerDefinition

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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.Definition

Definition.DefinitionBuilder, Definition.DefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.ItemDefinition

ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition

PrismContainerDefinition.PrismContainerDefinitionMutator<C extends Containerable>

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

PrismItemAccessDefinition.Data, PrismItemAccessDefinition.Delegable, PrismItemAccessDefinition.Info, PrismItemAccessDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable

PrismItemAccessDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition

PrismItemBasicDefinition.Data, PrismItemBasicDefinition.Delegable, PrismItemBasicDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition.Mutable

PrismItemBasicDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition

PrismItemStorageDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition

PrismLifecycleDefinition.Data, PrismLifecycleDefinition.Delegable, PrismLifecycleDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition.Mutable

PrismLifecycleDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition

PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable

PrismPresentationDefinition.Mutable.Delegable

Field Summary

Fields inherited from class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl

compileTimeClass, complexTypeDefinition

Fields inherited from class com.evolveum.midpoint.prism.impl.ItemDefinitionImpl

heterogeneousListItem, itemName, processing, substitutionHead

Fields inherited from class com.evolveum.midpoint.prism.impl.DefinitionImpl

deprecated, deprecatedSince, displayHint, displayName, displayOrder, documentation, elaborate, emphasized, experimental, help, isAbstract, isRuntimeSchema, plannedRemoval, removed, removedSince, typeName

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
@NotNull ResourceAttributeContainerDefinitionImpl	clone()
protected void	copyDefinitionDataFrom(ResourceAttributeContainerDefinition source)
String	debugDump(int indent)
<T> ShadowSimpleAttributeDefinition<T>	findAttributeDefinition(ItemPath elementPath)
Collection<? extends ShadowSimpleAttributeDefinition<?>>	getAllIdentifiers()
ShadowAttributesComplexTypeDefinition	getComplexTypeDefinition()	Definition of the container values.
SerializableComplexTypeDefinition	getComplexTypeDefinitionToSerialize()
@NotNull List<? extends ShadowSimpleAttributeDefinition<?>>	getDefinitions()	Returns a list of item definitions in this container.
Collection<? extends ShadowSimpleAttributeDefinition<?>>	getPrimaryIdentifiers()	TODO review docs Returns the definition of primary identifier attributes of a resource object.
@NotNull ResourceObjectDefinition	getResourceObjectDefinition()
Collection<? extends ShadowSimpleAttributeDefinition<?>>	getSecondaryIdentifiers()	TODO review docs Returns the definition of secondary identifier attributes of a resource object.
@NotNull ShadowAttributesContainer	instantiate()	Create an item instance.
@NotNull ShadowAttributesContainer	instantiate(QName name)	Create an item instance.
String	toString()

Methods inherited from class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl

accept, canRepresent, checkMutable, cloneWithNewDefinition, cloneWithNewName, cloneWithNewType, copyDefinitionDataFrom, createContainerDefinition, createContainerDefinition, createContainerDefinition, createEmptyDelta, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createValue, debugDump, deepClone, findItemDefinition, getAlwaysUseForEquals, getCompileTimeClass, getDebugDumpClassName, getDiagrams, getDocClassName, getPropertyDefinitions, getSchemaNamespace, getTypeClass, isAbstract, isEmpty, mutator, performFreeze, replaceDefinition, setAlwaysUseForEquals, setCompileTimeClass, setComplexTypeDefinition

Methods inherited from class com.evolveum.midpoint.prism.impl.ItemDefinitionImpl

canAdd, canModify, canRead, copyDefinitionDataFrom, debugDumpShortToString, debugFlags, debugMultiplicity, equals, extendToString, getItemName, getMaxOccurs, getMergerInstance, getMinOccurs, getObjectBuilt, getProcessing, getSubstitutionHead, getValueEnumerationRef, hashCode, isAlwaysUseForEquals, isDynamic, isHeterogeneousListItem, isIndexed, isIndexOnly, isInherited, isOperational, isSearchable, isValidFor, revive, setAlwaysUseForEquals, setCanAdd, setCanModify, setCanRead, setDynamic, setHeterogeneousListItem, setIndexed, setIndexOnly, setInherited, setMaxOccurs, setMinOccurs, setOperational, setProcessing, setReadOnly, setSearchable, setSubstitutionHead, setValueEnumerationRef, useSerializationProxy, writeReplace

Methods inherited from class com.evolveum.midpoint.prism.impl.DefinitionImpl

accept, addSchemaMigration, copyDefinitionDataFrom, extendDumpHeader, getAnnotation, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMergerIdentifier, getNaturalKeyConstituents, getNaturalKeyInstance, getPlannedRemoval, getRemovedSince, getSchemaMigrations, getTypeName, isDeprecated, isElaborate, isEmphasized, isExperimental, isOptionalCleanup, isRemoved, isRuntimeSchema, setAbstract, setAnnotation, setDeprecated, setDeprecatedSince, setDiagrams, setDisplayHint, setDisplayName, setDisplayOrder, setDocumentation, setElaborate, setEmphasized, setExperimental, setHelp, setMergerIdentifier, setNaturalKeyConstituents, setOptionalCleanup, setPlannedRemoval, setRemoved, setRemovedSince, setRuntimeSchema, setSchemaMigrations

Methods inherited from class com.evolveum.midpoint.prism.impl.schema.SchemaRegistryStateAware

getSchemaLookup, getSchemaRegistryState, setSchemaRegistryState

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.prism.Definition

checkMutableOnExposing, debugDump, getAnnotation, getAnnotations, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, getTypeName, isAbstract, isElaborate, isOptionalCleanup, isRuntimeSchema

Methods inherited from interface com.evolveum.midpoint.prism.Definition.DefinitionMutator

setAnnotation, setMergerIdentifier, setNaturalKeyConstituents, setOptionalCleanup, setRuntimeSchema

Methods inherited from interface com.evolveum.midpoint.prism.Freezable

checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition

cloneWithNewName, debugDumpShortToString, deepClone, getProcessing, getSubstitutionHead, getValueEnumerationRef, isAlwaysUseForEquals, isDynamic, isHeterogeneousListItem, isIgnored, isInherited, isOperational

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition.ItemDefinitionLikeBuilder

getExtraFeaturesToParse

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition.ItemDefinitionMutator

setAlwaysUseForEquals, setDeprecatedSince, setDynamic, setElaborate, setHeterogeneousListItem, setIgnored, setIndexOnly, setInherited, setOperational, setPlannedRemoval, setProcessing, setReadOnly, setSearchable, setSubstitutionHead, setValueEnumerationRef

Methods inherited from interface com.evolveum.midpoint.prism.LivePrismItemDefinition

findItemDefinition, isValidFor

Methods inherited from interface com.evolveum.midpoint.prism.LocalItemDefinitionStore

containsItemDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition

Methods inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition

canRepresent, cloneWithNewDefinition, cloneWithNewType, createEmptyDelta, createValue, getAlwaysUseForEquals, getCompileTimeClass, getItemNames, getPropertyDefinitions, getTypeClass, isAlwaysUseForEquals, isCompletelyDefined, isEmpty, mutator, replaceDefinition, structuredType

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

canAdd, canModify, canRead, getInfo

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable

setCanAdd, setCanModify, setCanRead, setInfo

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition

getItemName, getMaxOccurs, getMinOccurs, getTypeName, isMandatory, isMultiValue, isOptional, isSingleValue

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition.Mutable

setMaxOccurs, setMinOccurs

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition

isIndexed, isIndexOnly, isSearchable

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition.Mutable

setIndexed

Methods inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition

getDeprecatedSince, getPlannedRemoval, getRemovedSince, getSchemaMigrations, isDeprecated, isExperimental, isRemoved

Methods inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition.Mutable

addSchemaMigration, setDeprecated, setExperimental, setRemoved, setRemovedSince, setSchemaMigrations

Methods inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition

getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, isEmphasized

Methods inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable

setDiagrams, setDisplayHint, setDisplayName, setDisplayOrder, setDocumentation, setEmphasized, setHelp

Methods inherited from interface com.evolveum.midpoint.prism.Revivable

revive

Methods inherited from interface com.evolveum.midpoint.prism.schema.SerializableDefinition

getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getExtraFeaturesToSerialize, getHelp, isEmphasized

Methods inherited from interface com.evolveum.midpoint.prism.schema.SerializableItemDefinition

getItemName, getMaxOccurs, getMinOccurs, getProcessing, getTypeName, isIndexed, isOperational

Methods inherited from interface com.evolveum.midpoint.prism.SmartVisitable

accept

Methods inherited from interface com.evolveum.midpoint.prism.Visitable

accept

Method Details

getComplexTypeDefinition

public ShadowAttributesComplexTypeDefinition 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>

Specified by:

getComplexTypeDefinition in interface ResourceAttributeContainerDefinition

Overrides:

getComplexTypeDefinition in class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<ShadowAttributesType>

getComplexTypeDefinitionToSerialize

public SerializableComplexTypeDefinition getComplexTypeDefinitionToSerialize()

Specified by:

getComplexTypeDefinitionToSerialize in interface SerializableContainerDefinition

Overrides:

getComplexTypeDefinitionToSerialize in class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<ShadowAttributesType>

getPrimaryIdentifiers

public Collection<? extends ShadowSimpleAttributeDefinition<?>> getPrimaryIdentifiers()

Description copied from interface: ResourceAttributeContainerDefinition

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.

Specified by:

getPrimaryIdentifiers in interface ResourceAttributeContainerDefinition

Returns:

definition of identifier attributes

getSecondaryIdentifiers

public Collection<? extends ShadowSimpleAttributeDefinition<?>> getSecondaryIdentifiers()

Description copied from interface: ResourceAttributeContainerDefinition

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.

Specified by:

getSecondaryIdentifiers in interface ResourceAttributeContainerDefinition

Returns:

definition of secondary identifier attributes

getAllIdentifiers

public Collection<? extends ShadowSimpleAttributeDefinition<?>> getAllIdentifiers()

Specified by:

getAllIdentifiers in interface ResourceAttributeContainerDefinition

instantiate

@NotNull
public @NotNull ShadowAttributesContainer 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>>

Specified by:

instantiate in interface ResourceAttributeContainerDefinition

Overrides:

instantiate in class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<ShadowAttributesType>

instantiate

@NotNull
public @NotNull ShadowAttributesContainer 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>>

Specified by:

instantiate in interface ResourceAttributeContainerDefinition

Overrides:

instantiate in class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<ShadowAttributesType>

clone

@NotNull
public @NotNull ResourceAttributeContainerDefinitionImpl clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<PrismContainer<ShadowAttributesType>>

Specified by:

clone in interface PrismContainerDefinition<ShadowAttributesType>

Specified by:

clone in interface ResourceAttributeContainerDefinition

Overrides:

clone in class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<ShadowAttributesType>

copyDefinitionDataFrom

protected void copyDefinitionDataFrom(ResourceAttributeContainerDefinition source)

findAttributeDefinition

public <T> ShadowSimpleAttributeDefinition<T> findAttributeDefinition(ItemPath elementPath)

Specified by:

findAttributeDefinition in interface ResourceAttributeContainerDefinition

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<ShadowAttributesType>

toString

public String toString()

Overrides:

toString in class com.evolveum.midpoint.prism.impl.ItemDefinitionImpl<PrismContainer<ShadowAttributesType>>

getDefinitions

@NotNull
public @NotNull List<? extends ShadowSimpleAttributeDefinition<?>> 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>

Specified by:

getDefinitions in interface ResourceAttributeContainerDefinition

Overrides:

getDefinitions in class com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl<ShadowAttributesType>

getResourceObjectDefinition

@NotNull
public @NotNull ResourceObjectDefinition getResourceObjectDefinition()

Specified by:

getResourceObjectDefinition in interface ResourceAttributeContainerDefinition