Package com.evolveum.midpoint.schema.processor

Class RawResourceAttributeDefinitionImpl<T>

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.DefinitionImpl

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

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

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

All Implemented Interfaces:

Definition, Freezable, ItemDefinition<PrismProperty<T>>, ItemDefinitionTestAccess, MutableDefinition, MutableItemDefinition<PrismProperty<T>>, MutablePrismPropertyDefinition<T>, PrismContextSensitive, PrismItemAccessDefinition, PrismPropertyDefinition<T>, Revivable, SmartVisitable<Definition>, Visitable<Definition>, MutableRawResourceAttributeDefinition<T>, RawResourceAttributeDefinition<T>, DebugDumpable, Serializable, Cloneable

public class RawResourceAttributeDefinitionImpl<T>
extends PrismPropertyDefinitionImpl<T>
implements MutableRawResourceAttributeDefinition<T>

A structure holding "raw" definition of a resource attribute, i.e. definition obtained from the connector. To be used _solely_ within ResourceAttributeDefinitionImpl.

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.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, removed, removedSince, typeName

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
@NotNull RawResourceAttributeDefinitionImpl<T>	clone()
boolean	equals(Object o)
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()	Is this attribute returned by default?
int	hashCode()
@NotNull ResourceAttribute<T>	instantiate()	Create an item instance.
@NotNull ResourceAttribute<T>	instantiate(QName name)	Create an item instance.
void	setFrameworkAttributeName(String frameworkAttributeName)
void	setNativeAttributeName(String nativeAttributeName)
void	setReturnedByDefault(Boolean returnedByDefault)
@NotNull MutableRawResourceAttributeDefinition<T>	toMutable()	Returns an interface to mutate this definition.

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

canBeDefinitionOf, copyDefinitionDataFrom, createEmptyDelta, defaultValue, getAllowedValues, getDocClassName, getMatchingRuleQName, getSuggestedValues, isIndexed, setAllowedValues, setIndexed, setMatchingRuleQName, setSuggestedValues, structuredType

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

adoptElementDefinitionFrom, canAdd, canBeDefinitionOf, canModify, canRead, copyDefinitionDataFrom, debugDisplayOrder, debugDumpShortToString, debugFlags, debugMultiplicity, deepClone, findItemDefinition, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isOperational, isSearchable, isValidFor, replaceName, revive, setCanAdd, setCanModify, setCanRead, setDynamic, setHeterogeneousListItem, setIndexOnly, setInherited, setItemName, setMaxOccurs, setMinOccurs, setOperational, setReadOnly, setSearchable, setSubstitutionHead, setValueEnumerationRef, toString, useSerializationProxy, writeReplace

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

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

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

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable, performFreeze

Methods inherited from class java.lang.Object

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

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

debugDump, 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, getRemovedSince, getSchemaMigrations, getSchemaRegistry, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRemoved, 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, isSearchable, isSingleValue, isValidFor, structuredType

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

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

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

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

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

setAllowedValues, setIndexed, setInherited, setMatchingRuleQName, setSuggestedValues

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

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

Methods inherited from interface com.evolveum.midpoint.schema.processor.RawResourceAttributeDefinition

isReturnedByDefault

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

Method Details

instantiate

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

Specified by:

instantiate in interface PrismPropertyDefinition<T>

Specified by:

instantiate in interface RawResourceAttributeDefinition<T>

Overrides:

instantiate in class PrismPropertyDefinitionImpl<T>

instantiate

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

Specified by:

instantiate in interface PrismPropertyDefinition<T>

Specified by:

instantiate in interface RawResourceAttributeDefinition<T>

Overrides:

instantiate in class PrismPropertyDefinitionImpl<T>

getReturnedByDefault

public Boolean getReturnedByDefault()

Description copied from interface: RawResourceAttributeDefinition

Is this attribute returned by default? (I.e. if no specific options are sent to the connector?)

Specified by:

getReturnedByDefault in interface RawResourceAttributeDefinition<T>

setReturnedByDefault

public void setReturnedByDefault(Boolean returnedByDefault)

Specified by:

setReturnedByDefault in interface MutableRawResourceAttributeDefinition<T>

getNativeAttributeName

public String getNativeAttributeName()

Description copied from interface: RawResourceAttributeDefinition

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 RawResourceAttributeDefinition<T>

Returns:

native attribute name

setNativeAttributeName

public void setNativeAttributeName(String nativeAttributeName)

Specified by:

setNativeAttributeName in interface MutableRawResourceAttributeDefinition<T>

getFrameworkAttributeName

public String getFrameworkAttributeName()

Description copied from interface: RawResourceAttributeDefinition

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 RawResourceAttributeDefinition<T>

Returns:

name of the attribute as given in the connector framework.

setFrameworkAttributeName

public void setFrameworkAttributeName(String frameworkAttributeName)

Specified by:

setFrameworkAttributeName in interface MutableRawResourceAttributeDefinition<T>

clone

@NotNull
public @NotNull RawResourceAttributeDefinitionImpl<T> clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<T>

Specified by:

clone in interface MutablePrismPropertyDefinition<T>

Specified by:

clone in interface PrismPropertyDefinition<T>

Overrides:

clone in class PrismPropertyDefinitionImpl<T>

equals

public boolean equals(Object o)

Overrides:

equals in class PrismPropertyDefinitionImpl<T>

hashCode

public int hashCode()

Overrides:

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

toMutable

@NotNull
public @NotNull MutableRawResourceAttributeDefinition<T> toMutable()

Description copied from interface: Definition

Returns an interface to mutate this definition.

Specified by:

toMutable in interface Definition

Specified by:

toMutable in interface ItemDefinition<T>

Specified by:

toMutable in interface PrismPropertyDefinition<T>

Overrides:

toMutable in class PrismPropertyDefinitionImpl<T>