Package com.evolveum.midpoint.schema.processor

Interface ResourceAttribute<T>

All Superinterfaces:

DebugDumpable, Freezable, Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>, Itemable, ParentVisitable, PathVisitable, PrismContextSensitive, PrismProperty<T>, Revivable, Serializable, Visitable

All Known Implementing Classes:

ResourceAttributeImpl

public interface ResourceAttribute<T>
extends PrismProperty<T>

/** 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. Resource Object Attribute is mutable.

Author:

Radovan Semancik

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
ResourceAttribute<T>	clone()	Literal clone.
ResourceAttributeDefinition<T>	getDefinition()	Returns applicable definition.
default String	getNativeAttributeName()	Returns native attribute name.

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

checkImmutable, checkMutable, freeze, isImmutable

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

acceptParentVisitor, add, add, addAll, addAll, addIgnoringEquivalents, addRespectingMetadataAndCloning, applyDefinition, applyDefinition, assertDefinitions, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistenceInternal, clear, contains, contains, copy, diff, diff, equals, equals, equals, filterValues, filterYields, find, findValue, findValue, getAllItems, getAllValues, getAnyValue, getAnyValue, getClonedValues, getDisplayName, getElementName, getHelp, getHighestId, getParent, getPath, getPrismContextLocal, getRealValue, getRealValuesArray, getRealValuesOrRawTypes, getUserData, getUserData, getValue, getValues, hasAnyValue, hasCompleteDefinition, hashCode, hashCode, hashCode, hasNoValues, hasRaw, isEmpty, isIncomplete, isOperational, isRaw, isSingleValue, isSingleValueByDefinition, merge, normalize, recomputeAllValues, remove, remove, removeAll, removeIf, removeRespectingMetadata, replace, replaceAll, setDefinition, setElementName, setIncomplete, setParent, setPrismContext, setUserData, size, valuesStream

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

accept

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

getPrismContext

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

addRealValue, addRealValues, addRealValueSkipUniquenessCheck, addValue, addValues, cloneComplex, createDelta, createDelta, createImmutableClone, deleteValue, deleteValues, diff, diff, findPartial, getAnyRealValue, getRealValue, getRealValues, getRealValues, getValue, getValueClass, getValues, hasRealValue, replaceValues, setRealValue, setRealValues, setValue, toHumanReadableString

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

revive

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

accept

Method Detail

getDefinition

ResourceAttributeDefinition<T> getDefinition()

Description copied from interface: Item

Returns applicable definition.

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

Specified by:

getDefinition in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

getDefinition in interface Itemable

Returns:

applicable definition

getNativeAttributeName

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

Returns:

native attribute name

clone

ResourceAttribute<T> clone()

Description copied from interface: Item

Literal clone.

Specified by:

clone in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

clone in interface PrismProperty<T>