com.evolveum.midpoint.schema.processor

Class ResourceAttributeDefinitionImpl<T>

java.lang.Object

com.evolveum.midpoint.prism.DefinitionImpl

com.evolveum.midpoint.prism.ItemDefinitionImpl<PrismProperty<T>>

com.evolveum.midpoint.prism.PrismPropertyDefinitionImpl<T>

com.evolveum.midpoint.schema.processor.ResourceAttributeDefinitionImpl<T>

All Implemented Interfaces:

Definition, ItemDefinition<PrismProperty<T>>, PrismPropertyDefinition<T>, Revivable, Visitable, ResourceAttributeDefinition<T>, DebugDumpable, Serializable

Direct Known Subclasses:

RefinedAttributeDefinitionImpl

public class ResourceAttributeDefinitionImpl<T>
extends PrismPropertyDefinitionImpl<T>
implements ResourceAttributeDefinition<T>

Resource Object Attribute Definition. Resource Object Attribute is a Property of Resource Object. All that applies to property applies also to attribute, e.g. only a whole attributes can be changed, they may be simple or complex types, they should be representable in XML, etc. In addition, attribute definition may have some annotations that suggest its purpose and use on the Resource. Resource Object Attribute understands resource-specific annotations such as native attribute name. This class represents schema definition for resource object attribute. See Definition for more details.

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

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

heterogeneousListItem, name, substitutionHead

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

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

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

INDENT_STRING

Constructor Summary

Constructors

Constructor and Description
ResourceAttributeDefinitionImpl(QName elementName, QName typeName, PrismContext prismContext)

Method Summary

Modifier and Type	Method and Description
ResourceAttributeDefinition<T>	clone()
protected void	copyDefinitionData(ResourceAttributeDefinitionImpl<T> clone)
boolean	equals(Object obj)
protected void	extendToString(StringBuilder sb)
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
String	getFrameworkAttributeName() Returns name of the attribute as given in the connector framework.
String	getNativeAttributeName() Returns native attribute name.
Boolean	getReturnedByDefault()
int	hashCode()
ResourceAttribute<T>	instantiate() Create an item instance.
ResourceAttribute<T>	instantiate(QName name) Create an item instance.
boolean	isIdentifier(ObjectClassComplexTypeDefinition objectDefinition)
boolean	isIdentifier(ResourceAttributeContainerDefinition objectDefinition) Returns true if the attribute is a (primary) identifier.
boolean	isReturnedByDefault()
boolean	isSecondaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)
void	setFrameworkAttributeName(String frameworkAttributeName)
void	setNativeAttributeName(String nativeAttributeName)
void	setReturnedByDefault(Boolean returnedByDefault)

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

canBeDefinitionOf, copyDefinitionData, createEmptyDelta, defaultValue, getAllowedValues, getDocClassName, getMatchingRuleQName, getValueType, isIndexed, setIndexed, setMatchingRuleQName

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

accept, addNamespaceIfApplicable, adoptElementDefinitionFrom, canAdd, canBeDefinitionOf, canModify, canRead, copyDefinitionData, debugDumpShortToString, debugFlags, debugMultiplicity, deepClone, deepClone, findItemDefinition, getMaxOccurs, getMinOccurs, getName, getNamespace, getSubstitutionHead, getValueEnumerationRef, isDynamic, isHeterogeneousListItem, isInherited, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, isValidFor, isValidFor, revive, setCanAdd, setCanModify, setCanRead, setDynamic, setHeterogeneousListItem, setInherited, setMaxOccurs, setMinOccurs, setName, setOperational, setReadOnly, setSubstitutionHead, setValueEnumerationRef, toString

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

copyDefinitionData, debugDump, getAnnotation, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getPlannedRemoval, getPrismContext, getProcessing, getTypeClass, getTypeClassIfKnown, getTypeName, isAbstract, 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 java.lang.Object

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

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

createEmptyDelta, defaultValue, getAllowedValues, getMatchingRuleQName, getTypeClass, getValueType, isAnyType, isIndexed

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

adoptElementDefinitionFrom, canAdd, canBeDefinitionOf, canBeDefinitionOf, canModify, canRead, debugDumpShortToString, deepClone, deepClone, findItemDefinition, getMaxOccurs, getMinOccurs, getName, getNamespace, getSubstitutionHead, getValueEnumerationRef, isDynamic, isHeterogeneousListItem, isInherited, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, isValidFor, isValidFor, revive, setCanAdd, setCanModify, setCanRead, setMaxOccurs

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

debugDump, getAnnotation, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getPlannedRemoval, getPrismContext, getProcessing, getSchemaRegistry, getTypeClassIfKnown, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRuntimeSchema, setAnnotation

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

accept

Constructor Detail

ResourceAttributeDefinitionImpl

public ResourceAttributeDefinitionImpl(QName elementName,
                                       QName typeName,
                                       PrismContext prismContext)

Method Detail

instantiate

@NotNull
public ResourceAttribute<T> instantiate()

Description copied from interface: ItemDefinition

Create an item instance. Definition name or default name will used as an element name for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<PrismProperty<T>>

Specified by:

instantiate in interface PrismPropertyDefinition<T>

Specified by:

instantiate in interface ResourceAttributeDefinition<T>

Overrides:

instantiate in class PrismPropertyDefinitionImpl<T>

Returns:

created item instance

instantiate

@NotNull
public ResourceAttribute<T> 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<PrismProperty<T>>

Specified by:

instantiate in interface PrismPropertyDefinition<T>

Specified by:

instantiate in interface ResourceAttributeDefinition<T>

Overrides:

instantiate in class PrismPropertyDefinitionImpl<T>

Returns:

created item instance

getReturnedByDefault

public Boolean getReturnedByDefault()

Specified by:

getReturnedByDefault in interface ResourceAttributeDefinition<T>

isReturnedByDefault

public boolean isReturnedByDefault()

Specified by:

isReturnedByDefault in interface ResourceAttributeDefinition<T>

setReturnedByDefault

public void setReturnedByDefault(Boolean returnedByDefault)

isIdentifier

public boolean isIdentifier(ResourceAttributeContainerDefinition objectDefinition)

Returns true if the attribute is a (primary) identifier. Convenience method.

Specified by:

isIdentifier in interface ResourceAttributeDefinition<T>

Returns:

true if the attribute is a (primary) identifier.

isIdentifier

public boolean isIdentifier(ObjectClassComplexTypeDefinition objectDefinition)

Specified by:

isIdentifier in interface ResourceAttributeDefinition<T>

isSecondaryIdentifier

public boolean isSecondaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)

Specified by:

isSecondaryIdentifier in interface ResourceAttributeDefinition<T>

getNativeAttributeName

public String getNativeAttributeName()

Returns native attribute name. Native name of the attribute is a name as it is used on the resource or as seen by the connector. It is used for diagnostics purposes and may be used by the connector itself. As the attribute names in XSD have to comply with XML element name limitations, this may be the only way how to determine original attribute name. Returns null if native attribute name is not set or unknown. The name should be the same as the one used by the resource, if the resource supports naming of attributes. E.g. in case of LDAP this annotation should contain "cn", "givenName", etc. If the resource is not that flexible, the native attribute names may be hardcoded (e.g. "username", "homeDirectory") or may not be present at all.

Specified by:

getNativeAttributeName in interface ResourceAttributeDefinition<T>

Returns:

native attribute name

setNativeAttributeName

public void setNativeAttributeName(String nativeAttributeName)

getFrameworkAttributeName

public String getFrameworkAttributeName()

Returns name of the attribute as given in the connector framework. This is not used for any significant logic. It is mostly for diagnostics.

Specified by:

getFrameworkAttributeName in interface ResourceAttributeDefinition<T>

Returns:

name of the attribute as given in the connector framework.

setFrameworkAttributeName

public void setFrameworkAttributeName(String frameworkAttributeName)

clone

@NotNull
public ResourceAttributeDefinition<T> clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<PrismProperty<T>>

Specified by:

clone in interface PrismPropertyDefinition<T>

Specified by:

clone in interface ResourceAttributeDefinition<T>

Overrides:

clone in class PrismPropertyDefinitionImpl<T>

copyDefinitionData

protected void copyDefinitionData(ResourceAttributeDefinitionImpl<T> clone)

hashCode

public int hashCode()

Overrides:

hashCode in class PrismPropertyDefinitionImpl<T>

equals

public boolean equals(Object obj)

Overrides:

equals in class PrismPropertyDefinitionImpl<T>

extendToString

protected void extendToString(StringBuilder sb)

Overrides:

extendToString in class PrismPropertyDefinitionImpl<T>

getDebugDumpClassName

protected String getDebugDumpClassName()

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

Overrides:

getDebugDumpClassName in class PrismPropertyDefinitionImpl<T>