Package com.evolveum.midpoint.schema.processor

Interface ShadowSimpleAttributeDefinition<T>

All Superinterfaces:

Cloneable, DebugDumpable, Definition, Freezable, ItemDefinition<PrismProperty<T>>, LayeredDefinition, LivePrismItemDefinition, PrismItemAccessDefinition, PrismItemBasicDefinition, PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>, PrismItemMatchingDefinition<T>, PrismItemMiscDefinition, PrismItemStorageDefinition, PrismItemValuesDefinition<T>, PrismLifecycleDefinition, PrismPresentationDefinition, PrismPropertyDefinition<T>, ResourceObjectInboundDefinition.ItemInboundDefinition, Revivable, Serializable, ShadowAttributeDefinition<ShadowSimpleAttribute<T>,T>, ShadowItemLayeredDefinition, ShadowItemUcfDefinition, ShortDumpable, SmartVisitable<Definition>, Visitable<Definition>

All Known Subinterfaces:

ResourceAttributeDefinitionDelegator<T>, ResourceAttributeWrapper<T>

All Known Implementing Classes:

ResourceAttributeWrapperImpl, ShadowSimpleAttributeDefinitionImpl

public interface ShadowSimpleAttributeDefinition<T>
extends PrismPropertyDefinition<T>, ShadowAttributeDefinition<ShadowSimpleAttribute<T>,T>

Full prism definition of a ShadowSimpleAttribute: has a native part and a refined part from `schemaHandling`. TODO rename to ShadowAttributeDefinition (too many occurrences!)

See Also:

• ShadowSimpleAttribute

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.Definition

Definition.DefinitionBuilder, Definition.DefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.ItemDefinition

ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

PrismItemAccessDefinition.Data, PrismItemAccessDefinition.Delegable, PrismItemAccessDefinition.Info, PrismItemAccessDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition

PrismItemBasicDefinition.Data, PrismItemBasicDefinition.Delegable, PrismItemBasicDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemMatchingDefinition

PrismItemMatchingDefinition.Data<T>, PrismItemMatchingDefinition.Delegable<T>, PrismItemMatchingDefinition.Mutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemMiscDefinition

PrismItemMiscDefinition.Data, PrismItemMiscDefinition.Delegable, PrismItemMiscDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition

PrismItemStorageDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemValuesDefinition

PrismItemValuesDefinition.Data<T>, PrismItemValuesDefinition.Delegable<T>, PrismItemValuesDefinition.Mutator<T>

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition

PrismLifecycleDefinition.Data, PrismLifecycleDefinition.Delegable, PrismLifecycleDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition

PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPropertyDefinition

PrismPropertyDefinition.PrismPropertyDefinitionMutator<T>, PrismPropertyDefinition.PrismPropertyLikeDefinitionBuilder<T>

Nested classes/interfaces inherited from interface com.evolveum.midpoint.schema.processor.ShadowItemUcfDefinition

ShadowItemUcfDefinition.Data, ShadowItemUcfDefinition.Delegable, ShadowItemUcfDefinition.Mutable

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
@NotNull ShadowSimpleAttributeDefinition<T>	clone()
default @NotNull PrismPropertyValue<T>	convertPrismValue(@NotNull PrismPropertyValue<?> srcValue)
default @NotNull PropertyDelta<T>	createEmptyDelta()	Creates an empty delta for this attribute against its standard path.
ShadowSimpleAttributeDefinition<T>	deepClone(@NotNull DeepCloneOperation operation)	TODO document
@NotNull ShadowSimpleAttributeDefinition<T>	forLayer(@NotNull LayerType layer)	Creates a view of the current definition for a given layer.
ItemCorrelatorDefinitionType	getCorrelatorDefinition()
default @NotNull ItemPath	getStandardPath()	Returns the standard path where this attribute can be found in shadows.
default @NotNull Class<T>	getTypeClass()	Returns a compile-time class that is used to represent items.
default @NotNull ShadowSimpleAttribute<T>	instantiateFrom(@NotNull PrismProperty<?> property)	Creates a new ShadowSimpleAttribute from given PrismProperty.
default @NotNull ShadowSimpleAttribute<T>	instantiateFromRealValue(T realValue)
default @NotNull ShadowSimpleAttribute<T>	instantiateFromRealValues(@NotNull Collection<T> realValues)	Creates a new ShadowSimpleAttribute from given real values, converting them if necessary.
default @NotNull ShadowSimpleAttribute<T>	instantiateFromValue(PrismPropertyValue<T> value)
boolean	isDisplayNameAttribute()	Is this attribute configured to serve as a display name?
Boolean	isSecondaryIdentifierOverride()	Is this attribute designated as a secondary identifier via `schemaHandling`?
PrismPropertyDefinition.PrismPropertyDefinitionMutator<T>	mutator()	Returns an interface to mutate this definition.
default <N> @NotNull NormalizationAwareResourceAttributeDefinition<N>	toNormalizationAware()	Creates a normalization-aware version of this definition.

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

checkMutableOnExposing, debugDump, getAnnotation, getAnnotations, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, getSchemaContextDefinition, getTypeName, isAbstract, isElaborate, isOptionalCleanup, isRuntimeSchema

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

checkImmutable, checkMutable, freeze, isImmutable

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

cloneWithNewName, createEmptyDelta, debugDumpShortToString, getProcessing, getSubstitutionHead, getValueEnumerationRef, instantiate, instantiate, isAlwaysUseForEquals, isDynamic, isHeterogeneousListItem, isIgnored, isInherited, isOperational, structuredType

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

getCurrentLayer

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

findItemDefinition, isValidFor

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

canAdd, canModify, canRead, getInfo

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

getItemName, getMaxOccurs, getMinOccurs, getTypeName, isMandatory, isMultiValue, isOptional, isSingleValue

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

createEmptyDelta, instantiate, instantiate

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

getMatchingRule, getMatchingRuleQName, getNormalizer, getStringNormalizerForPolyStringProperty, getTypeName, isCustomPolyString

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

getProcessing

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

isIndexed, isIndexOnly, isSearchable

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

defaultValue, getAllowedValues, getSuggestedValues, getValueEnumerationRef

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

getDeprecatedSince, getPlannedRemoval, getRemovedSince, getSchemaMigrations, isDeprecated, isExperimental, isRemoved

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

getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, isEmphasized

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

adoptRealValues, getTypeClassLegacy, isAnyType

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

revive

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

debugDump, getChangeApplicationMode, getDescription, getFetchStrategy, getHumanReadableDescription, getInboundMappingBeans, getIntolerantValuePatterns, getLifecycleState, getModificationPriority, getOutboundMappingBean, getReadReplaceMode, getRelevantInboundDefinitions, getStorageStrategy, getTolerantValuePatterns, hasInboundMapping, hasOutboundMapping, hasRefinements, instantiate, instantiate, isCached, isEffectivelyCached, isExclusiveStrong, isIgnored, isIndexOnly, isReturnedByDefault, isSimulated, isTolerant, isVisible, isVisible, isVolatilityTrigger, setOverrideCanAdd, setOverrideCanModify, setOverrideCanRead

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

canAdd, canModify, canRead, getLimitations, getMaxOccurs, getMinOccurs, getProcessing, isMandatory, isMultiValue, isOptional, isSingleValue

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

getFrameworkAttributeName, getNativeAttributeName, getReturnedByDefault

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

shortDump, shortDump, shortDumpLazily

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

accept

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

accept

Method Details

getTypeClass

@NotNull
default @NotNull Class<T> getTypeClass()

Description copied from interface: Definition

Returns a compile-time class that is used to represent items. E.g. returns String, Integer, subclasses of Objectable and Containerable and so on.

Specified by:

getTypeClass in interface Definition

Specified by:

getTypeClass in interface PrismItemMatchingDefinition<T>

Specified by:

getTypeClass in interface PrismPropertyDefinition<T>

Specified by:

getTypeClass in interface ShadowAttributeDefinition<ShadowSimpleAttribute<T>,T>

instantiateFrom

@NotNull
default @NotNull ShadowSimpleAttribute<T> instantiateFrom(@NotNull
 @NotNull PrismProperty<?> property)
                                                   throws SchemaException

Creates a new ShadowSimpleAttribute from given PrismProperty. Used in the process of "definition application" in `applyDefinitions` and similar methods. Assumes that the original property is correctly constructed, i.e. it has no duplicate values.

Throws:

SchemaException

instantiateFromValue

@NotNull
default @NotNull ShadowSimpleAttribute<T> instantiateFromValue(PrismPropertyValue<T> value)
                                                        throws SchemaException

Throws:

SchemaException

instantiateFromRealValues

@NotNull
default @NotNull ShadowSimpleAttribute<T> instantiateFromRealValues(@NotNull
 @NotNull Collection<T> realValues)
                                                             throws SchemaException

Creates a new ShadowSimpleAttribute from given real values, converting them if necessary. Assumes that the values contain no duplicates and no nulls.

Throws:

SchemaException

instantiateFromRealValue

@NotNull
default @NotNull ShadowSimpleAttribute<T> instantiateFromRealValue(@NotNull
 T realValue)
                                                            throws SchemaException

Throws:

SchemaException

convertPrismValue

@NotNull
default @NotNull PrismPropertyValue<T> convertPrismValue(@NotNull
 @NotNull PrismPropertyValue<?> srcValue)

clone

@NotNull
@NotNull ShadowSimpleAttributeDefinition<T> clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<T>

Specified by:

clone in interface PrismPropertyDefinition<T>

Specified by:

clone in interface ShadowAttributeDefinition<ShadowSimpleAttribute<T>,T>

deepClone

ShadowSimpleAttributeDefinition<T> deepClone(@NotNull
 @NotNull DeepCloneOperation operation)

Description copied from interface: ItemDefinition

TODO document

Specified by:

deepClone in interface ItemDefinition<T>

mutator

@NotNull
PrismPropertyDefinition.PrismPropertyDefinitionMutator<T> mutator()

Description copied from interface: Definition

Returns an interface to mutate this definition.

Specified by:

mutator in interface Definition

Specified by:

mutator in interface ItemDefinition<T>

Specified by:

mutator in interface PrismPropertyDefinition<T>

isSecondaryIdentifierOverride

Boolean isSecondaryIdentifierOverride()

Is this attribute designated as a secondary identifier via `schemaHandling`?

See Also:

• ResourceItemDefinitionType.isSecondaryIdentifier()

isDisplayNameAttribute

boolean isDisplayNameAttribute()

Is this attribute configured to serve as a display name?

See Also:

• ResourceItemDefinitionType.isDisplayNameAttribute()

getCorrelatorDefinition

ItemCorrelatorDefinitionType getCorrelatorDefinition()

Specified by:

getCorrelatorDefinition in interface ResourceObjectInboundDefinition.ItemInboundDefinition

See Also:

• ItemRefinedDefinitionType.getCorrelator()

toNormalizationAware

@NotNull
default <N>
@NotNull NormalizationAwareResourceAttributeDefinition<N> toNormalizationAware()

Creates a normalization-aware version of this definition.

getStandardPath

@NotNull
default @NotNull ItemPath getStandardPath()

Returns the standard path where this attribute can be found in shadows. E.g. for searching.

Specified by:

getStandardPath in interface ShadowAttributeDefinition<ShadowSimpleAttribute<T>,T>

createEmptyDelta

@NotNull
default @NotNull PropertyDelta<T> createEmptyDelta()

Creates an empty delta for this attribute against its standard path.

forLayer

@NotNull
@NotNull ShadowSimpleAttributeDefinition<T> forLayer(@NotNull
 @NotNull LayerType layer)

Description copied from interface: ShadowAttributeDefinition

Creates a view of the current definition for a given layer. (May return even the original object e.g. if the layer matches the current one.)

Specified by:

forLayer in interface ShadowAttributeDefinition<ShadowSimpleAttribute<T>,T>