Package com.evolveum.midpoint.schema.processor

Class ResourceAttributeContainerDefinitionImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

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, Freezable, ItemDefinition<PrismContainer<ShadowAttributesType>>, ItemDefinitionTestAccess, LocalItemDefinitionStore, MutableDefinition, MutableItemDefinition<PrismContainer<ShadowAttributesType>>, MutablePrismContainerDefinition<ShadowAttributesType>, PrismContainerDefinition<ShadowAttributesType>, PrismContextSensitive, PrismItemAccessDefinition, Revivable, SmartVisitable<Definition>, Visitable<Definition>, ResourceAttributeContainerDefinition, DebugDumpable, Serializable, Cloneable

public class ResourceAttributeContainerDefinitionImpl
extends 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.PrismItemAccessDefinition

PrismItemAccessDefinition.Mutable

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, substitutionHead

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

deprecated, deprecatedSince, displayName, displayOrder, documentation, elaborate, emphasized, experimental, help, isAbstract, isRuntimeSchema, plannedRemoval, processing, typeName

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
ResourceAttributeContainerDefinitionImpl(QName name, ComplexTypeDefinition complexTypeDefinition)

Method Summary

Modifier and Type	Method	Description
@NotNull ResourceAttributeContainerDefinitionImpl	clone()	Shallow clone
protected void	copyDefinitionDataFrom(ResourceAttributeContainerDefinition source)
String	debugDump(int indent)
ResourceAttributeDefinition<?>	findAttributeDefinition(ItemPath elementPath)
ResourceAttributeDefinition<?>	findAttributeDefinition(String localName)
<T> ResourceAttributeDefinition<T>	findAttributeDefinition(QName elementQName, boolean caseInsensitive)
Collection<? extends ResourceAttributeDefinition<?>>	getAllIdentifiers()
List<? extends ResourceAttributeDefinition<?>>	getAttributeDefinitions()
ResourceObjectDefinition	getComplexTypeDefinition()	Definition of the container values.
@NotNull List<? extends ResourceAttributeDefinition<?>>	getDefinitions()	FIXME this looks like outdated description Returns set of property definitions.
ResourceAttributeDefinition<?>	getDescriptionAttribute()	TODO review docs Returns the definition of description attribute of a resource object.
ResourceAttributeDefinition<?>	getDisplayNameAttribute()	TODO review docs Returns the definition of display name attribute.
ResourceAttributeDefinition<?>	getNamingAttribute()	TODO review docs Specifies which resource attribute should be used as a "technical" name for the account.
String	getNativeObjectClass()	TODO review docs Returns the native object class string for the resource object.
Collection<? extends ResourceAttributeDefinition<?>>	getPrimaryIdentifiers()	TODO review docs Returns the definition of primary identifier attributes of a resource object.
Collection<? extends ResourceAttributeDefinition<?>>	getSecondaryIdentifiers()	TODO review docs Returns the definition of secondary identifier attributes of a resource object.
@NotNull ResourceAttributeContainer	instantiate()	Create an item instance.
@NotNull ResourceAttributeContainer	instantiate(QName name)	Create an item instance.
boolean	isDefaultAccountDefinition()	TODO review docs Indicates whether definition is should be used as default account type.
void	setDescriptionAttribute(QName name)
void	setDisplayNameAttribute(ResourceAttributeDefinition<?> displayName)
void	setDisplayNameAttribute(QName displayName)	TODO Convenience method.
void	setNamingAttribute(ResourceAttributeDefinition<?> namingAttribute)
void	setNamingAttribute(QName namingAttribute)
void	setNativeObjectClass(String nativeObjectClass)
<T extends ShadowType> @NotNull PrismObjectDefinition<T>	toShadowDefinition()
String	toString()

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

accept, canBeDefinitionOf, canRepresent, checkMutable, cloneWithReplacedDefinition, copyDefinitionDataFrom, createContainerDefinition, createContainerDefinition, createContainerDefinition, createEmptyDelta, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createValue, debugDump, deepClone, findItemDefinition, getCompileTimeClass, getDebugDumpClassName, getDiagrams, getDocClassName, getPropertyDefinitions, getSchemaNamespace, getTypeClass, isAbstract, isEmpty, performFreeze, replaceDefinition, revive, setCompileTimeClass, setComplexTypeDefinition, toMutable

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

adoptElementDefinitionFrom, canAdd, canBeDefinitionOf, canModify, canRead, copyDefinitionDataFrom, debugDumpShortToString, debugFlags, debugMultiplicity, equals, extendToString, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, hashCode, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isOperational, isValidFor, replaceName, setCanAdd, setCanModify, setCanRead, setDynamic, setHeterogeneousListItem, setIndexOnly, setInherited, setItemName, setMaxOccurs, setMinOccurs, setOperational, setReadOnly, setSubstitutionHead, setValueEnumerationRef, useSerializationProxy, writeReplace

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

accept, addDiagram, addSchemaMigration, checkMutableOnExposing, copyDefinitionDataFrom, extendDumpHeader, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getPlannedRemoval, getPrismContext, getProcessing, getSchemaMigrations, getTypeName, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRuntimeSchema, setAbstract, setAnnotation, setDeprecated, setDeprecatedSince, setDisplayName, setDisplayOrder, setDocumentation, setElaborate, setEmphasized, setExperimental, setHelp, setPlannedRemoval, setProcessing, setRuntimeSchema, setTypeName

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

debugDump, getAnnotation, getAnnotations, getDeprecatedSince, getDiagrams, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getProcessing, getSchemaMigrations, getSchemaRegistry, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRuntimeSchema, setAnnotation

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

checkImmutable, checkMutable, freeze, isImmutable

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

adoptElementDefinitionFrom, canBeDefinitionOf, canBeDefinitionOf, debugDumpShortToString, deepClone, findItemDefinition, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, 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.MutableDefinition

addDiagram, addSchemaMigration, setDeprecated, setDisplayName, setDisplayOrder, setDocumentation, setEmphasized, setExperimental, setHelp, setProcessing, setRuntimeSchema, setTypeName

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

setCanAdd, setCanModify, setCanRead, setDeprecatedSince, setDynamic, setElaborate, setHeterogeneousListItem, setIndexOnly, setInherited, setItemName, setMaxOccurs, setMinOccurs, setOperational, setPlannedRemoval, setReadOnly, setSubstitutionHead, setValueEnumerationRef

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

canRepresent, cloneWithReplacedDefinition, createEmptyDelta, createValue, getCompileTimeClass, getItemNames, getPropertyDefinitions, getTypeClass, isCompletelyDefined, isEmpty, replaceDefinition, structuredType, toMutable

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

getPrismContext

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

canAdd, canModify, canRead

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

revive

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

accept

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

accept

Constructor Detail

ResourceAttributeContainerDefinitionImpl

public ResourceAttributeContainerDefinitionImpl(QName name,
                                                ComplexTypeDefinition complexTypeDefinition)

Method Detail

getComplexTypeDefinition

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

Specified by:

getComplexTypeDefinition in interface ResourceAttributeContainerDefinition

Overrides:

getComplexTypeDefinition in class PrismContainerDefinitionImpl<ShadowAttributesType>

getPrimaryIdentifiers

public Collection<? extends ResourceAttributeDefinition<?>> 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 ResourceAttributeDefinition<?>> 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 ResourceAttributeDefinition<?>> getAllIdentifiers()

Specified by:

getAllIdentifiers in interface ResourceAttributeContainerDefinition

getDescriptionAttribute

public ResourceAttributeDefinition<?> getDescriptionAttribute()

Description copied from interface: ResourceAttributeContainerDefinition

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.

Specified by:

getDescriptionAttribute in interface ResourceAttributeContainerDefinition

Returns:

definition of secondary identifier attributes

setDescriptionAttribute

public void setDescriptionAttribute(QName name)

getNamingAttribute

public ResourceAttributeDefinition<?> getNamingAttribute()

Description copied from interface: ResourceAttributeContainerDefinition

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.

Specified by:

getNamingAttribute in interface ResourceAttributeContainerDefinition

Returns:

resource attribute definition that should be used as a "technical" name for the account.

setNamingAttribute

public void setNamingAttribute(ResourceAttributeDefinition<?> namingAttribute)

setNamingAttribute

public void setNamingAttribute(QName namingAttribute)

getNativeObjectClass

public String getNativeObjectClass()

Description copied from interface: ResourceAttributeContainerDefinition

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.

Specified by:

getNativeObjectClass in interface ResourceAttributeContainerDefinition

Returns:

native object class

setNativeObjectClass

public void setNativeObjectClass(String nativeObjectClass)

isDefaultAccountDefinition

public boolean isDefaultAccountDefinition()

Description copied from interface: ResourceAttributeContainerDefinition

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.

Specified by:

isDefaultAccountDefinition in interface ResourceAttributeContainerDefinition

Returns:

true if the definition should be used as account type.

getDisplayNameAttribute

public ResourceAttributeDefinition<?> getDisplayNameAttribute()

Description copied from interface: ResourceAttributeContainerDefinition

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.

Specified by:

getDisplayNameAttribute in interface ResourceAttributeContainerDefinition

Returns:

native object class

setDisplayNameAttribute

public void setDisplayNameAttribute(ResourceAttributeDefinition<?> displayName)

setDisplayNameAttribute

public void setDisplayNameAttribute(QName displayName)

TODO Convenience method. It will internally look up the correct definition.

instantiate

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

Specified by:

instantiate in interface ResourceAttributeContainerDefinition

Overrides:

instantiate in class PrismContainerDefinitionImpl<ShadowAttributesType>

instantiate

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

Specified by:

instantiate in interface ResourceAttributeContainerDefinition

Overrides:

instantiate in class PrismContainerDefinitionImpl<ShadowAttributesType>

clone

@NotNull
public @NotNull ResourceAttributeContainerDefinitionImpl clone()

Description copied from class: PrismContainerDefinitionImpl

Shallow 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 PrismContainerDefinitionImpl<ShadowAttributesType>

copyDefinitionDataFrom

protected void copyDefinitionDataFrom(ResourceAttributeContainerDefinition source)

findAttributeDefinition

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

Specified by:

findAttributeDefinition in interface ResourceAttributeContainerDefinition

findAttributeDefinition

public ResourceAttributeDefinition<?> findAttributeDefinition(ItemPath elementPath)

Specified by:

findAttributeDefinition in interface ResourceAttributeContainerDefinition

findAttributeDefinition

public ResourceAttributeDefinition<?> findAttributeDefinition(String localName)

Specified by:

findAttributeDefinition in interface ResourceAttributeContainerDefinition

getAttributeDefinitions

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

Specified by:

getAttributeDefinitions in interface ResourceAttributeContainerDefinition

toShadowDefinition

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

Specified by:

toShadowDefinition in interface ResourceAttributeContainerDefinition

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class PrismContainerDefinitionImpl<ShadowAttributesType>

toString

public String toString()

Overrides:

toString in class ItemDefinitionImpl<PrismContainer<ShadowAttributesType>>

getDefinitions

@NotNull
public @NotNull List<? extends ResourceAttributeDefinition<?>> getDefinitions()

Description copied from class: PrismContainerDefinitionImpl

FIXME this looks like outdated description Returns set of property definitions.

WARNING: This may return definitions from the associated complex type. Therefore changing the returned set may influence also the complex type definition.

The set contains all property definitions of all types that were parsed. Order of definitions is insignificant.

Specified by:

getDefinitions in interface LocalItemDefinitionStore

Specified by:

getDefinitions in interface PrismContainerDefinition<ShadowAttributesType>

Specified by:

getDefinitions in interface ResourceAttributeContainerDefinition

Overrides:

getDefinitions in class PrismContainerDefinitionImpl<ShadowAttributesType>

Returns:

set of definitions