com.evolveum.midpoint.schema.processor

Class ObjectClassComplexTypeDefinition

java.lang.Object

com.evolveum.midpoint.prism.Definition

com.evolveum.midpoint.prism.ComplexTypeDefinition

com.evolveum.midpoint.schema.processor.ObjectClassComplexTypeDefinition

All Implemented Interfaces:

Revivable, DebugDumpable, Serializable

Direct Known Subclasses:

RefinedObjectClassDefinition

public class ObjectClassComplexTypeDefinition
extends ComplexTypeDefinition

Author:

semancik

See Also:

Serialized Form

Field Summary

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
ObjectClassComplexTypeDefinition(QName typeName, PrismContext prismContext)

Method Summary

Methods

Modifier and Type	Method and Description
ObjectClassComplexTypeDefinition	clone() Shallow clone.
protected void	copyDefinitionData(ObjectClassComplexTypeDefinition clone)
<X> ResourceAttributeDefinition<X>	createAttributeDefinition(QName name, QName typeName)
<X> ResourceAttributeDefinition<X>	createAttributeDefinition(String localName, QName typeName)
<X> ResourceAttributeDefinition<X>	createAttributeDefinition(String localName, String localTypeName)
ObjectQuery	createShadowSearchQuery(String resourceOid)
boolean	equals(Object obj)
protected void	extendDumpDefinition(StringBuilder sb, ItemDefinition def)
protected void	extendDumpHeader(StringBuilder sb)
<X> ResourceAttributeDefinition<X>	findAttributeDefinition(QName name) Finds a attribute definition by looking at the property name.
<X> ResourceAttributeDefinition<X>	findAttributeDefinition(QName name, boolean caseInsensitive)
<X> ResourceAttributeDefinition<X>	findAttributeDefinition(String name)
Collection<? extends ResourceAttributeDefinition>	getAllIdentifiers()
Collection<? extends ResourceAttributeDefinition>	getAttributeDefinitions()
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
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.
int	hashCode()
ResourceAttributeContainer	instantiate(QName elementName) This may not be really "clean" as it actually does two steps instead of one.
boolean	isAuxiliary()
boolean	isDefaultInAKind() Indicates whether definition is should be used as default definition in ist kind.
boolean	isPrimaryIdentifier(QName attrName)
boolean	isSecondaryIdentifier(QName attrName)
void	setAuxiliary(boolean auxiliary)
void	setDefaultInAKind(boolean defaultAccountType)
void	setDescriptionAttribute(ResourceAttributeDefinition<?> descriptionAttribute)
void	setDisplayNameAttribute(QName displayName) TODO Convenience method.
void	setDisplayNameAttribute(ResourceAttributeDefinition<?> displayName)
void	setIntent(String intent)
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)
ResourceAttributeContainerDefinition	toResourceAttributeContainerDefinition()
ResourceAttributeContainerDefinition	toResourceAttributeContainerDefinition(QName elementName)

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

add, addDefinition, copyDefinitionData, createPropertyDefinifion, createPropertyDefinifion, createPropertyDefinifion, createPropertyDefinition, debugDump, deepClone, findContainerDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findItemDefinition, findItemDefinition, findPropertyDefinition, findPropertyDefinition, getCompileTimeClass, getDefinitions, getDocClassName, getExtensionForType, getSchemaNamespace, getSuperType, isContainerMarker, isEmpty, isObjectMarker, isXsdAnyMarker, merge, replaceDefinition, revive, setCompileTimeClass, setContainerMarker, setExtensionForType, setObjectMarker, setSuperType, setXsdAnyMarker

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectClassComplexTypeDefinition

public ObjectClassComplexTypeDefinition(QName typeName,
                                PrismContext prismContext)

Method Detail

getAttributeDefinitions

public Collection<? extends ResourceAttributeDefinition> getAttributeDefinitions()

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

isPrimaryIdentifier

public boolean isPrimaryIdentifier(QName attrName)

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

isSecondaryIdentifier

public boolean isSecondaryIdentifier(QName attrName)

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)

isAuxiliary

public boolean isAuxiliary()

setAuxiliary

public void setAuxiliary(boolean auxiliary)

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)

isDefaultInAKind

public boolean isDefaultInAKind()

Indicates whether definition is should be used as default definition in ist kind. E.g. if used in an "account" kind it indicates default account definition. If true value is returned then the definition should be used as a default definition for the kind. This is a way how a resource connector may suggest applicable object classes (resource object definitions) for individual shadow kinds (e.g. accounts).

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

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 -

findAttributeDefinition

public <X> ResourceAttributeDefinition<X> findAttributeDefinition(QName name)

Finds a attribute definition by looking at the property name.

Returns null if nothing is found.

Parameters:

name - property definition name

Returns:

found property definition or null

findAttributeDefinition

public <X> ResourceAttributeDefinition<X> findAttributeDefinition(QName name,
                                                         boolean caseInsensitive)

findAttributeDefinition

public <X> ResourceAttributeDefinition<X> findAttributeDefinition(String name)

createAttributeDefinition

public <X> ResourceAttributeDefinition<X> createAttributeDefinition(QName name,
                                                           QName typeName)

createAttributeDefinition

public <X> ResourceAttributeDefinition<X> createAttributeDefinition(String localName,
                                                           QName typeName)

createAttributeDefinition

public <X> ResourceAttributeDefinition<X> createAttributeDefinition(String localName,
                                                           String localTypeName)

toResourceAttributeContainerDefinition

public ResourceAttributeContainerDefinition toResourceAttributeContainerDefinition()

toResourceAttributeContainerDefinition

public ResourceAttributeContainerDefinition toResourceAttributeContainerDefinition(QName elementName)

createShadowSearchQuery

public ObjectQuery createShadowSearchQuery(String resourceOid)
                                    throws SchemaException

Throws:

SchemaException

instantiate

public ResourceAttributeContainer instantiate(QName elementName)

This may not be really "clean" as it actually does two steps instead of one. But it is useful.

clone

public ObjectClassComplexTypeDefinition clone()

Description copied from class: ComplexTypeDefinition

Shallow clone.

Overrides:

clone in class ComplexTypeDefinition

copyDefinitionData

protected void copyDefinitionData(ObjectClassComplexTypeDefinition clone)

hashCode

public int hashCode()

Overrides:

hashCode in class ComplexTypeDefinition

equals

public boolean equals(Object obj)

Overrides:

equals in class ComplexTypeDefinition

getDebugDumpClassName

protected String getDebugDumpClassName()

Description copied from class: ComplexTypeDefinition

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

Overrides:

getDebugDumpClassName in class ComplexTypeDefinition

extendDumpHeader

protected void extendDumpHeader(StringBuilder sb)

Overrides:

extendDumpHeader in class ComplexTypeDefinition

extendDumpDefinition

protected void extendDumpDefinition(StringBuilder sb,
                        ItemDefinition def)

Overrides:

extendDumpDefinition in class ComplexTypeDefinition