com.evolveum.midpoint.schema.processor

Class ResourceAttributeContainer

java.lang.Object

com.evolveum.midpoint.prism.Item<PrismContainerValue<C>,PrismContainerDefinition<C>>

com.evolveum.midpoint.prism.PrismContainer

com.evolveum.midpoint.schema.processor.ResourceAttributeContainer

All Implemented Interfaces:

Itemable, PathVisitable, PrismContainerable, Revivable, Visitable, DebugDumpable, Serializable

public final class ResourceAttributeContainer
extends PrismContainer

Resource Object. Resource Object understands resource-specific annotations, such as identifiers, native object class, etc. Object class can be determined by using the definition (inherited from PropertyContainer)

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

Fields inherited from class com.evolveum.midpoint.prism.PrismContainer

compileTimeClass

Fields inherited from class com.evolveum.midpoint.prism.Item

definition, elementName, parent, prismContext

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

INDENT_STRING

Constructor Summary

Constructors

Constructor and Description
ResourceAttributeContainer(QName name, ResourceAttributeContainerDefinition definition, PrismContext prismContext) The constructors should be used only occasionally (if used at all).

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ResourceAttribute<?> attribute)
void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
ResourceAttributeContainer	clone()
<T> boolean	contains(ResourceAttribute<T> attr)
static ResourceAttributeContainer	convertFromContainer(PrismContainer<?> origAttrContainer, ObjectClassComplexTypeDefinition objectClassDefinition)
protected void	copyValues(ResourceAttributeContainer clone)
static ResourceAttributeContainer	createEmptyContainer(QName elementName, ObjectClassComplexTypeDefinition objectClassDefinition)
<X> ResourceAttribute<X>	findAttribute(QName attributeQName) Finds a specific attribute in the resource object by name.
<X> ResourceAttribute<X>	findAttribute(ResourceAttributeDefinition attributeDefinition) Finds a specific attribute in the resource object by definition.
<X> ResourceAttribute<X>	findOrCreateAttribute(QName attributeName)
<X> ResourceAttribute<X>	findOrCreateAttribute(ResourceAttributeDefinition attributeDefinition)
Collection<ResourceAttribute<?>>	getAllIdentifiers()
Collection<ResourceAttribute<?>>	getAttributes() Returns set of resource object attributes.
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
ResourceAttributeContainerDefinition	getDefinition() Returns applicable property container definition.
ResourceAttribute	getDescriptionAttribute() Returns description attribute of a resource object.
ResourceAttribute	getDisplayNameAttribute() Returns display name attribute of a resource object.
com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowKindType	getKind()
ResourceAttribute<String>	getNamingAttribute() Specifies which resource attribute should be used as a "technical" name for the account.
String	getNativeObjectClass() Returns the native object class string for the resource object.
PrismProperty<?>	getPrimaryIdentifier() Returns a (single) primary identifier.
Collection<ResourceAttribute<?>>	getPrimaryIdentifiers() Returns primary identifiers.
PrismProperty	getSecondaryIdentifier() Returns a (single) secondary identifier.
Collection<ResourceAttribute<?>>	getSecondaryIdentifiers() Returns secondary identifiers.
boolean	isDefaultInAKind() Indicates whether definition is should be used as default account type.

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

accept, add, add, additionalDumpDescription, applyDefinition, assertDefinitions, canRepresent, checkDefinition, containsEquivalentValue, copyValues, createDelta, createDelta, createNewValue, debugDump, deepCloneDefinition, diff, diff, diffModifications, diffModifications, equals, equivalent, find, findContainer, findContainer, findItem, findItem, findItem, findItem, findOrCreateContainer, findOrCreateContainer, findOrCreateItem, findOrCreateItem, findOrCreateProperty, findOrCreateProperty, findOrCreateReference, findOrCreateReference, findPartial, findProperty, findProperty, findReference, findReference, findReferenceByCompositeObjectElementName, findValue, getCompileTimeClass, getNextValue, getPreviousValue, getPropertyRealValue, getPropertyRealValue, getValue, getValue, getValues, hasCompleteDefinition, hashCode, isEmpty, mergeValue, mergeValues, mergeValues, newInstance, propagateDeepCloneDefinition, remove, removeContainer, removeContainer, removeItem, removeProperty, removeProperty, removeReference, removeReference, setDefinition, setPropertyRealValue, setValue, toString, trim

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

accept, add, addAll, applyDefinition, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, clear, cloneCollection, contains, contains, contains, containsRealValue, copyValues, createNewDefinitionlessItem, debugDump, diff, diff, diffInternal, equalsRealValue, findValue, fixupDelta, getClonedValues, getDisplayName, getElementName, getHelp, getParent, getPath, getPrismContext, getUserData, getUserData, getValue, hasRaw, hasRealValue, hasValue, hasValue, isRaw, isSingleValue, match, merge, normalize, remove, remove, removeAll, replace, replaceAll, resetParentCollection, revive, setElementName, setParent, setPrismContext, setUserData, size

Methods inherited from class java.lang.Object

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

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

getElementName, getPath, getPrismContext

Constructor Detail

ResourceAttributeContainer

public ResourceAttributeContainer(QName name,
                          ResourceAttributeContainerDefinition definition,
                          PrismContext prismContext)

The constructors should be used only occasionally (if used at all). Use the factory methods in the ResourceObjectDefintion instead.

Method Detail

getDefinition

public ResourceAttributeContainerDefinition getDefinition()

Description copied from class: PrismContainer

Returns applicable property container definition.

May return null if no definition is applicable or the definition is not know.

Specified by:

getDefinition in interface Itemable

Specified by:

getDefinition in interface PrismContainerable

Overrides:

getDefinition in class PrismContainer

Returns:

applicable property container definition

getAttributes

public Collection<ResourceAttribute<?>> getAttributes()

Returns set of resource object attributes. The order of attributes is insignificant. The returned set is imutable! Any change to it will be ignored.

Returns:

set of resource object attributes.

add

public void add(ResourceAttribute<?> attribute)
         throws SchemaException

Throws:

SchemaException

getPrimaryIdentifier

public PrismProperty<?> getPrimaryIdentifier()

Returns a (single) primary identifier. This method returns a property that acts as an (primary) identifier for the resource object. Primary identifiers are used to access the resource objects, retrieve them from resource, identify objects for modifications, etc. Returns null if no identifier is defined. Resource objects may have multiple (composite) identifiers, but this method assumes that there is only a single identifier. The method will throw exception if that assumption is not satisfied.

Returns:

identifier property

Throws:

IllegalStateException - if resource object has multiple identifiers

getPrimaryIdentifiers

public Collection<ResourceAttribute<?>> getPrimaryIdentifiers()

Returns primary identifiers. This method returns properties that act as (primary) identifiers for the resource object. Primary identifiers are used to access the resource objects, retrieve them from resource, identify objects for modifications, etc. Returns empty set if no identifier is defined. Must not return null. Resource objects may have multiple (composite) identifiers, all of them are returned. The returned set it immutable! Any modifications will be lost.

Returns:

set of identifier properties

getSecondaryIdentifier

public PrismProperty getSecondaryIdentifier()

Returns a (single) secondary identifier. This method returns a property that acts as an secondary identifier for the resource object. Secondary identifiers are used to confirm primary identification of resource object. Returns null if no secondary identifier is defined. Resource objects may have multiple (composite) identifiers, but this method assumes that there is only a single identifier. The method will throw exception if that assumption is not satisfied.

Returns:

secondary identifier property

Throws:

IllegalStateException - if resource object has multiple secondary identifiers

getSecondaryIdentifiers

public Collection<ResourceAttribute<?>> getSecondaryIdentifiers()

Returns secondary identifiers. This method returns properties that act as secondary identifiers for the resource object. Secondary identifiers are used to confirm primary identification of resource object. Returns empty set if no identifier is defined. Must not return null. Resource objects may have multiple (composite) identifiers, all of them are returned.

Returns:

set of secondary identifier properties

getAllIdentifiers

public Collection<ResourceAttribute<?>> getAllIdentifiers()

getDescriptionAttribute

public ResourceAttribute getDescriptionAttribute()

Returns description attribute of a resource object. Returns null if there is no description attribute or the attribute is not known. 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:

description attribute of a resource object.

Throws:

IllegalStateException - if there is no definition for the referenced attributed

getNamingAttribute

public ResourceAttribute<String> getNamingAttribute()

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:

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

getDisplayNameAttribute

public ResourceAttribute getDisplayNameAttribute()

Returns display name attribute of a resource object. Returns null if there is no display name attribute or the attribute is not known. 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:

display name attribute of a resource object.

Throws:

IllegalStateException - if there is no definition for the referenced attributed

getNativeObjectClass

public String getNativeObjectClass()

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 unmangled name (if available). Returns null if there is no native object class or the native object class is not known. 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.

getKind

public com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowKindType getKind()

isDefaultInAKind

public boolean isDefaultInAKind()

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.

findAttribute

public <X> ResourceAttribute<X> findAttribute(QName attributeQName)

Finds a specific attribute in the resource object by name. Returns null if nothing is found.

Parameters:

attributeQName - attribute name to find.

Returns:

found attribute or null

findAttribute

public <X> ResourceAttribute<X> findAttribute(ResourceAttributeDefinition attributeDefinition)

Finds a specific attribute in the resource object by definition. Returns null if nothing is found.

Parameters:

attributeDefinition - attribute definition to find.

Returns:

found attribute or null

findOrCreateAttribute

public <X> ResourceAttribute<X> findOrCreateAttribute(ResourceAttributeDefinition attributeDefinition)
                                           throws SchemaException

Throws:

SchemaException

findOrCreateAttribute

public <X> ResourceAttribute<X> findOrCreateAttribute(QName attributeName)
                                           throws SchemaException

Throws:

SchemaException

contains

public <T> boolean contains(ResourceAttribute<T> attr)

convertFromContainer

public static ResourceAttributeContainer convertFromContainer(PrismContainer<?> origAttrContainer,
                                              ObjectClassComplexTypeDefinition objectClassDefinition)
                                                       throws SchemaException

Throws:

SchemaException

createEmptyContainer

public static ResourceAttributeContainer createEmptyContainer(QName elementName,
                                              ObjectClassComplexTypeDefinition objectClassDefinition)

clone

public ResourceAttributeContainer clone()

Overrides:

clone in class PrismContainer

copyValues

protected void copyValues(ResourceAttributeContainer clone)

checkConsistenceInternal

public void checkConsistenceInternal(Itemable rootItem,
                            boolean requireDefinitions,
                            boolean prohibitRaw,
                            ConsistencyCheckScope scope)

Overrides:

checkConsistenceInternal in class PrismContainer

getDebugDumpClassName

protected String getDebugDumpClassName()

Return a human readable name of this class suitable for logs.

Overrides:

getDebugDumpClassName in class PrismContainer