com.evolveum.midpoint.schema.processor

Class ResourceAttributeContainerDefinition

java.lang.Object

com.evolveum.midpoint.prism.Definition

com.evolveum.midpoint.prism.ItemDefinition<PrismContainer<C>>

com.evolveum.midpoint.prism.PrismContainerDefinition<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowAttributesType>

com.evolveum.midpoint.schema.processor.ResourceAttributeContainerDefinition

All Implemented Interfaces:

Revivable, DebugDumpable, Serializable

public class ResourceAttributeContainerDefinition
extends PrismContainerDefinition<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowAttributesType>

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

Field Summary

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

compileTimeClass, complexTypeDefinition

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

name

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

deprecated, displayName, displayOrder, documentation, emphasized, help, ignored, inherited, isAbstract, isRuntimeSchema, prismContext, typeName

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

INDENT_STRING

Constructor Summary

Constructors

Constructor and Description
ResourceAttributeContainerDefinition(QName name, ObjectClassComplexTypeDefinition complexTypeDefinition, PrismContext prismContext)

Method Summary

Methods

Modifier and Type	Method and Description
ResourceAttributeContainerDefinition	clone() Shallow clone
protected void	copyDefinitionData(ResourceAttributeContainerDefinition clone)
String	debugDump(int indent)
ResourceAttributeDefinition	findAttributeDefinition(ItemPath elementPath)
ResourceAttributeDefinition	findAttributeDefinition(QName elementQName)
ResourceAttributeDefinition	findAttributeDefinition(QName elementQName, boolean caseInsensitive)
ResourceAttributeDefinition	findAttributeDefinition(String elementLocalname)
Collection<? extends ResourceAttributeDefinition>	getAllIdentifiers()
List<? extends ResourceAttributeDefinition>	getAttributeDefinitions()
ObjectClassComplexTypeDefinition	getComplexTypeDefinition()
List<? extends ResourceAttributeDefinition>	getDefinitions() Returns set of property definitions.
ResourceAttributeDefinition	getDescriptionAttribute() Returns the definition of description attribute of a resource object.
ResourceAttributeDefinition	getDisplayNameAttribute() Returns the definition of display name attribute.
String	getIntent()
com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowKindType	getKind()
ResourceAttributeDefinition	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.
Collection<? extends ResourceAttributeDefinition>	getPrimaryIdentifiers() Returns the definition of primary identifier attributes of a resource object.
Collection<? extends ResourceAttributeDefinition>	getSecondaryIdentifiers() Returns the definition of secondary identifier attributes of a resource object.
ResourceAttributeContainer	instantiate() Create property container instance with a default name.
ResourceAttributeContainer	instantiate(QName name) Create property container instance with a specified name and element.
boolean	isDefaultInAKind() Indicates whether definition is should be used as default account type.
void	setDefaultInAKind(boolean defaultAccountType)
void	setDescriptionAttribute(ResourceAttributeDefinition descriptionAttribute)
void	setDisplayNameAttribute(QName displayName) TODO Convenience method.
void	setDisplayNameAttribute(ResourceAttributeDefinition displayName)
void	setIntent(String accountTypeName)
void	setKind(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowKindType kind)
void	setNamingAttribute(QName namingAttribute)
void	setNamingAttribute(ResourceAttributeDefinition namingAttribute)
void	setNativeObjectClass(String nativeObjectClass)
<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> PrismObjectDefinition<T>	toShadowDefinition()
String	toString()

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

cloneWithReplacedDefinition, copyDefinitionData, createContainerDefinition, createContainerDefinition, createContainerDefinition, createEmptyDelta, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createValue, findContainerDefinition, findContainerDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findItemDefinition, findItemDefinition, findItemDefinition, findNamedItemDefinition, findPropertyDefinition, findPropertyDefinition, findReferenceDefinition, findReferenceDefinition, getCompileTimeClass, getDebugDumpClassName, getDocClassName, getPropertyDefinitions, getSchemaNamespace, isAbstract, isEmpty, isWildcard, revive, setCompileTimeClass, setComplexTypeDefinition

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

addNamespaceIfApplicable, adoptElementDefinitionFrom, canAdd, canModify, canRead, copyDefinitionData, debugFlags, debugMultiplicity, deepClone, equals, extendToString, getMaxOccurs, getMinOccurs, getName, getNamespace, getValueEnumerationRef, hashCode, isDynamic, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, isValidFor, isValidFor, setCanAdd, setCanModify, setCanRead, setDynamic, setMaxOccurs, setMinOccurs, setName, setOperational, setReadOnly, setValueEnumerationRef

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

copyDefinitionData, debugDump, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getPrismContext, getSchemaRegistry, getTypeClass, getTypeClassIfKnown, getTypeName, isDeprecated, isEmphasized, isIgnored, isInherited, isRuntimeSchema, setAbstract, setDeprecated, setDisplayName, setDisplayOrder, setDocumentation, setEmphasized, setHelp, setIgnored, setInherited, setRuntimeSchema, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceAttributeContainerDefinition

public ResourceAttributeContainerDefinition(QName name,
                                    ObjectClassComplexTypeDefinition complexTypeDefinition,
                                    PrismContext prismContext)

Method Detail

getComplexTypeDefinition

public ObjectClassComplexTypeDefinition getComplexTypeDefinition()

Overrides:

getComplexTypeDefinition in class PrismContainerDefinition<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowAttributesType>

getPrimaryIdentifiers

public Collection<? extends ResourceAttributeDefinition> getPrimaryIdentifiers()

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

public Collection<? extends ResourceAttributeDefinition> getSecondaryIdentifiers()

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

public Collection<? extends ResourceAttributeDefinition> getAllIdentifiers()

getDescriptionAttribute

public ResourceAttributeDefinition getDescriptionAttribute()

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

setDescriptionAttribute

public void setDescriptionAttribute(ResourceAttributeDefinition descriptionAttribute)

getNamingAttribute

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

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()

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

setNativeObjectClass

public void setNativeObjectClass(String nativeObjectClass)

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.

setDefaultInAKind

public void setDefaultInAKind(boolean defaultAccountType)

getIntent

public String getIntent()

setIntent

public void setIntent(String accountTypeName)

getKind

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

setKind

public void setKind(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowKindType kind)

getDisplayNameAttribute

public ResourceAttributeDefinition getDisplayNameAttribute()

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.

setDisplayNameAttribute

public void setDisplayNameAttribute(ResourceAttributeDefinition displayName)

setDisplayNameAttribute

public void setDisplayNameAttribute(QName displayName)

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

Parameters:

displayName -

instantiate

public ResourceAttributeContainer instantiate()

Description copied from class: PrismContainerDefinition

Create property container instance with a default name.

This is a preferred way how to create property container.

Overrides:

instantiate in class PrismContainerDefinition<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowAttributesType>

Returns:

created item instance

instantiate

public ResourceAttributeContainer instantiate(QName name)

Description copied from class: PrismContainerDefinition

Create property container instance with a specified name and element.

This is a preferred way how to create property container.

Overrides:

instantiate in class PrismContainerDefinition<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowAttributesType>

Returns:

created item instance

clone

public ResourceAttributeContainerDefinition clone()

Description copied from class: PrismContainerDefinition

Shallow clone

Overrides:

clone in class PrismContainerDefinition<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowAttributesType>

copyDefinitionData

protected void copyDefinitionData(ResourceAttributeContainerDefinition clone)

findAttributeDefinition

public ResourceAttributeDefinition findAttributeDefinition(QName elementQName)

findAttributeDefinition

public ResourceAttributeDefinition findAttributeDefinition(QName elementQName,
                                                  boolean caseInsensitive)

findAttributeDefinition

public ResourceAttributeDefinition findAttributeDefinition(ItemPath elementPath)

findAttributeDefinition

public ResourceAttributeDefinition findAttributeDefinition(String elementLocalname)

getAttributeDefinitions

public List<? extends ResourceAttributeDefinition> getAttributeDefinitions()

getDefinitions

public List<? extends ResourceAttributeDefinition> getDefinitions()

Description copied from class: PrismContainerDefinition

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.

Overrides:

getDefinitions in class PrismContainerDefinition<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowAttributesType>

Returns:

set of definitions

toShadowDefinition

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> PrismObjectDefinition<T> toShadowDefinition()

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class PrismContainerDefinition<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowAttributesType>

toString

public String toString()

Overrides:

toString in class ItemDefinition<PrismContainer<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowAttributesType>>