Package com.evolveum.midpoint.schema.processor.deleg

Interface RefinedAttributeDefinitionDelegator<T>

All Superinterfaces:

AttributeDefinitionDelegator<T>, Cloneable, DebugDumpable, Definition, DefinitionDelegator, Freezable, ItemDefinition<PrismProperty<T>>, ItemDefinitionDelegator<PrismProperty<T>>, LayeredDefinition, PrismContextSensitive, PrismItemAccessDefinition, PrismPropertyDefinition<T>, PropertyDefinitionDelegator<T>, RawResourceAttributeDefinition<T>, ResourceAttributeDefinition<T>, Revivable, Serializable, SmartVisitable<Definition>, Visitable<Definition>

All Known Implementing Classes:

TransformablePropertyDefinition.RefinedAttribute

public interface RefinedAttributeDefinitionDelegator<T>
extends AttributeDefinitionDelegator<T>, ResourceAttributeDefinition<T>

Nested Class Summary

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

PrismItemAccessDefinition.Mutable

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default boolean	canAdd(LayerType layer)	Is adding allowed (at specified layer)?
default boolean	canModify(LayerType layer)	Is modification allowed (at specified layer)?
default boolean	canRead(LayerType layer)	Is reading allowed (at specified layer)?
default String	debugDump(int indent, LayerType layer)	Provides a debug dump respective to the given layer.
ResourceAttributeDefinition<T>	deepClone(@NotNull DeepCloneOperation operation)	TODO document
ResourceAttributeDefinition<T>	delegate()
default @Nullable ItemChangeApplicationModeType	getChangeApplicationMode()	TODO
default @Nullable ItemCorrelatorDefinitionType	getCorrelatorDefinition()
default String	getDescription()	Gets the (configured) attribute description.
default AttributeFetchStrategyType	getFetchStrategy()	Returns configured fetch strategy.
default @NotNull List<InboundMappingType>	getInboundMappingBeans()	Gets the inbound mappings (if any).
default @NotNull List<String>	getIntolerantValuePatterns()	Gets patterns for values that are not "tolerated" on the resource.
default @Nullable String	getLifecycleState()	TODO
default PropertyLimitations	getLimitations(LayerType layer)	Returns limitations (cardinality, access rights, processing) for given layer.
default int	getMaxOccurs(LayerType layer)	Gets `maxOccurs` limitation for given layer.
default int	getMinOccurs(LayerType layer)	Gets `minOccurs` limitation for given layer.
default Integer	getModificationPriority()	Determines the order in which this attribute should be modified (in very special cases).
default @Nullable MappingType	getOutboundMappingBean()	Gets the outbound mapping, if defined.
default ItemProcessing	getProcessing(LayerType layer)	Gets the level of processing for specified layer.
default RawResourceAttributeDefinition<T>	getRawAttributeDefinition()	Gets the original (raw) attribute definition.
default Boolean	getReadReplaceMode()	Should be this attribute modified solely in "replace" mode?
default @NotNull AttributeStorageStrategyType	getStorageStrategy()	Returns configured storage strategy.
default @NotNull List<String>	getTolerantValuePatterns()	Gets patterns for values that are "tolerated" on the resource.
default boolean	isDisplayNameAttribute()	Is this attribute configured to serve as a display name?
default boolean	isExclusiveStrong()	Drives behavior of strong and normal mappings for this attribute.
default Boolean	isSecondaryIdentifierOverride()	Is this attribute designated as a secondary identifier via `schemaHandling`?
default boolean	isTolerant()	When set to true, allows to preserve attribute values that are set outside midPoint.
default boolean	isVolatilityTrigger()	Is this attribute so-called volatility trigger, i.e.

Methods inherited from interface com.evolveum.midpoint.schema.processor.deleg.AttributeDefinitionDelegator

forLayer, getCurrentLayer, getFrameworkAttributeName, getNativeAttributeName, getReturnedByDefault, hasOutboundMapping, instantiate, instantiate, isIgnored, isMandatory, isMultiValue, isOptional, isSingleValue, setOverrideCanAdd, setOverrideCanModify, setOverrideCanRead

Methods inherited from interface com.evolveum.midpoint.prism.deleg.DefinitionDelegator

accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getPrismContext, getProcessing, getSchemaMigrations, getSchemaRegistry, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRuntimeSchema, setAnnotation

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

checkImmutable, checkMutable, freeze, isImmutable

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

isMandatory, isMultiValue, isOptional, isSingleValue

Methods inherited from interface com.evolveum.midpoint.prism.deleg.ItemDefinitionDelegator

adoptElementDefinitionFrom, canAdd, canBeDefinitionOf, canBeDefinitionOf, canModify, canRead, debugDumpShortToString, findItemDefinition, getDiagrams, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isOperational, isValidFor, structuredType

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

createEmptyDelta, getTypeClass, isAnyType

Methods inherited from interface com.evolveum.midpoint.prism.deleg.PropertyDefinitionDelegator

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

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

isReturnedByDefault

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

clone, instantiate, instantiate, isVisible, spawnModifyingRaw, toMutable

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

revive

Method Detail

delegate

ResourceAttributeDefinition<T> delegate()

Specified by:

delegate in interface AttributeDefinitionDelegator<T>

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface ItemDefinitionDelegator<T>

Specified by:

delegate in interface PropertyDefinitionDelegator<T>

isTolerant

default boolean isTolerant()

Description copied from interface: ResourceAttributeDefinition

When set to true, allows to preserve attribute values that are set outside midPoint.

Specified by:

isTolerant in interface AttributeDefinitionDelegator<T>

Specified by:

isTolerant in interface ResourceAttributeDefinition<T>

See Also:

ItemRefinedDefinitionType.isTolerant()

isSecondaryIdentifierOverride

default Boolean isSecondaryIdentifierOverride()

Description copied from interface: ResourceAttributeDefinition

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

Specified by:

isSecondaryIdentifierOverride in interface AttributeDefinitionDelegator<T>

Specified by:

isSecondaryIdentifierOverride in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.isSecondaryIdentifier()

canAdd

default boolean canAdd(LayerType layer)

Description copied from interface: ResourceAttributeDefinition

Is adding allowed (at specified layer)?

Specified by:

canAdd in interface AttributeDefinitionDelegator<T>

Specified by:

canAdd in interface ResourceAttributeDefinition<T>

See Also:

PrismItemAccessDefinition.canAdd()

canRead

default boolean canRead(LayerType layer)

Description copied from interface: ResourceAttributeDefinition

Is reading allowed (at specified layer)?

Specified by:

canRead in interface AttributeDefinitionDelegator<T>

Specified by:

canRead in interface ResourceAttributeDefinition<T>

See Also:

PrismItemAccessDefinition.canRead()

canModify

default boolean canModify(LayerType layer)

Description copied from interface: ResourceAttributeDefinition

Is modification allowed (at specified layer)?

Specified by:

canModify in interface AttributeDefinitionDelegator<T>

Specified by:

canModify in interface ResourceAttributeDefinition<T>

See Also:

PrismItemAccessDefinition.canModify()

getProcessing

default ItemProcessing getProcessing(LayerType layer)

Description copied from interface: ResourceAttributeDefinition

Gets the level of processing for specified layer.

Specified by:

getProcessing in interface AttributeDefinitionDelegator<T>

Specified by:

getProcessing in interface ResourceAttributeDefinition<T>

See Also:

Definition.getProcessing()

getDescription

default String getDescription()

Description copied from interface: ResourceAttributeDefinition

Gets the (configured) attribute description.

Specified by:

getDescription in interface AttributeDefinitionDelegator<T>

Specified by:

getDescription in interface ResourceAttributeDefinition<T>

See Also:

ItemRefinedDefinitionType.getDescription()

getRawAttributeDefinition

default RawResourceAttributeDefinition<T> getRawAttributeDefinition()

Description copied from interface: ResourceAttributeDefinition

Gets the original (raw) attribute definition.

Specified by:

getRawAttributeDefinition in interface AttributeDefinitionDelegator<T>

Specified by:

getRawAttributeDefinition in interface ResourceAttributeDefinition<T>

getOutboundMappingBean

@Nullable
default @Nullable MappingType getOutboundMappingBean()

Description copied from interface: ResourceAttributeDefinition

Gets the outbound mapping, if defined.

Specified by:

getOutboundMappingBean in interface AttributeDefinitionDelegator<T>

Specified by:

getOutboundMappingBean in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.getOutbound()

getInboundMappingBeans

@NotNull
default @NotNull List<InboundMappingType> getInboundMappingBeans()

Description copied from interface: ResourceAttributeDefinition

Gets the inbound mappings (if any).

Specified by:

getInboundMappingBeans in interface AttributeDefinitionDelegator<T>

Specified by:

getInboundMappingBeans in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.getInbound()

getMaxOccurs

default int getMaxOccurs(LayerType layer)

Description copied from interface: ResourceAttributeDefinition

Gets `maxOccurs` limitation for given layer.

Specified by:

getMaxOccurs in interface AttributeDefinitionDelegator<T>

Specified by:

getMaxOccurs in interface ResourceAttributeDefinition<T>

See Also:

ItemDefinition.getMaxOccurs()

getMinOccurs

default int getMinOccurs(LayerType layer)

Description copied from interface: ResourceAttributeDefinition

Gets `minOccurs` limitation for given layer.

Specified by:

getMinOccurs in interface AttributeDefinitionDelegator<T>

Specified by:

getMinOccurs in interface ResourceAttributeDefinition<T>

isExclusiveStrong

default boolean isExclusiveStrong()

Description copied from interface: ResourceAttributeDefinition

Drives behavior of strong and normal mappings for this attribute.

Specified by:

isExclusiveStrong in interface AttributeDefinitionDelegator<T>

Specified by:

isExclusiveStrong in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.isExclusiveStrong()

getLimitations

default PropertyLimitations getLimitations(LayerType layer)

Description copied from interface: ResourceAttributeDefinition

Returns limitations (cardinality, access rights, processing) for given layer. These are obtained from resource and/or explicitly configured.

Specified by:

getLimitations in interface AttributeDefinitionDelegator<T>

Specified by:

getLimitations in interface ResourceAttributeDefinition<T>

See Also:

ItemRefinedDefinitionType.getLimitations()

getFetchStrategy

default AttributeFetchStrategyType getFetchStrategy()

Description copied from interface: ResourceAttributeDefinition

Returns configured fetch strategy.

Specified by:

getFetchStrategy in interface AttributeDefinitionDelegator<T>

Specified by:

getFetchStrategy in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.getFetchStrategy()

getStorageStrategy

@NotNull
default @NotNull AttributeStorageStrategyType getStorageStrategy()

Description copied from interface: ResourceAttributeDefinition

Returns configured storage strategy.

Specified by:

getStorageStrategy in interface AttributeDefinitionDelegator<T>

Specified by:

getStorageStrategy in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.getStorageStrategy()

getTolerantValuePatterns

@NotNull
default @NotNull List<String> getTolerantValuePatterns()

Description copied from interface: ResourceAttributeDefinition

Gets patterns for values that are "tolerated" on the resource.

Specified by:

getTolerantValuePatterns in interface AttributeDefinitionDelegator<T>

Specified by:

getTolerantValuePatterns in interface ResourceAttributeDefinition<T>

See Also:

ResourceAttributeDefinition.isTolerant(), ItemRefinedDefinitionType.getTolerantValuePattern()

getIntolerantValuePatterns

@NotNull
default @NotNull List<String> getIntolerantValuePatterns()

Description copied from interface: ResourceAttributeDefinition

Gets patterns for values that are not "tolerated" on the resource.

Specified by:

getIntolerantValuePatterns in interface AttributeDefinitionDelegator<T>

Specified by:

getIntolerantValuePatterns in interface ResourceAttributeDefinition<T>

See Also:

ResourceAttributeDefinition.isTolerant(), ItemRefinedDefinitionType.getIntolerantValuePattern()

isVolatilityTrigger

default boolean isVolatilityTrigger()

Description copied from interface: ResourceAttributeDefinition

Is this attribute so-called volatility trigger, i.e. may its changes cause changes in other attributes?

Specified by:

isVolatilityTrigger in interface AttributeDefinitionDelegator<T>

Specified by:

isVolatilityTrigger in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.isVolatilityTrigger()

debugDump

default String debugDump(int indent,
                         LayerType layer)

Description copied from interface: ResourceAttributeDefinition

Provides a debug dump respective to the given layer. TODO reconsider this method

Specified by:

debugDump in interface AttributeDefinitionDelegator<T>

Specified by:

debugDump in interface ResourceAttributeDefinition<T>

getModificationPriority

default Integer getModificationPriority()

Description copied from interface: ResourceAttributeDefinition

Determines the order in which this attribute should be modified (in very special cases).

Specified by:

getModificationPriority in interface AttributeDefinitionDelegator<T>

Specified by:

getModificationPriority in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.getModificationPriority()

getReadReplaceMode

default Boolean getReadReplaceMode()

Description copied from interface: ResourceAttributeDefinition

Should be this attribute modified solely in "replace" mode?

Specified by:

getReadReplaceMode in interface AttributeDefinitionDelegator<T>

Specified by:

getReadReplaceMode in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.isReadReplaceMode()

isDisplayNameAttribute

default boolean isDisplayNameAttribute()

Description copied from interface: ResourceAttributeDefinition

Is this attribute configured to serve as a display name?

Specified by:

isDisplayNameAttribute in interface AttributeDefinitionDelegator<T>

Specified by:

isDisplayNameAttribute in interface ResourceAttributeDefinition<T>

See Also:

ResourceItemDefinitionType.isDisplayNameAttribute()

getCorrelatorDefinition

@Nullable
default @Nullable ItemCorrelatorDefinitionType getCorrelatorDefinition()

Specified by:

getCorrelatorDefinition in interface AttributeDefinitionDelegator<T>

Specified by:

getCorrelatorDefinition in interface ResourceAttributeDefinition<T>

See Also:

ItemRefinedDefinitionType.getCorrelator()

getChangeApplicationMode

@Nullable
default @Nullable ItemChangeApplicationModeType getChangeApplicationMode()

Description copied from interface: ResourceAttributeDefinition

TODO

Specified by:

getChangeApplicationMode in interface AttributeDefinitionDelegator<T>

Specified by:

getChangeApplicationMode in interface ResourceAttributeDefinition<T>

getLifecycleState

@Nullable
default @Nullable String getLifecycleState()

Description copied from interface: ResourceAttributeDefinition

TODO

Specified by:

getLifecycleState in interface AttributeDefinitionDelegator<T>

Specified by:

getLifecycleState in interface ResourceAttributeDefinition<T>

deepClone

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

Description copied from interface: ItemDefinition

TODO document

Specified by:

deepClone in interface AttributeDefinitionDelegator<T>

Specified by:

deepClone in interface ItemDefinition<T>

Specified by:

deepClone in interface ItemDefinitionDelegator<T>

Specified by:

deepClone in interface ResourceAttributeDefinition<T>