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

Interface ResourceAttributeDefinitionDelegator<T>

All Superinterfaces:

Cloneable, DebugDumpable, Definition, DefinitionDelegator, Freezable, ItemDefinition<PrismProperty<T>>, ItemDefinitionDelegator<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>, PropertyDefinitionDelegator<T>, ResourceObjectInboundDefinition.ItemInboundDefinition, Revivable, SchemaLookup.Aware, Serializable, ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>, ShadowAttributeUcfDefinition, ShadowItemDefinition, ShadowItemLayeredDefinition, ShadowSimpleAttributeDefinition<T>, ShortDumpable, SmartVisitable<Definition>, Visitable<Definition>

All Known Implementing Classes:

TransformablePropertyDefinition.RefinedAttribute, TransformablePropertyDefinition.ResourceAttribute

public interface ResourceAttributeDefinitionDelegator<T>
extends PropertyDefinitionDelegator<T>, ShadowSimpleAttributeDefinition<T>

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

ShadowAttributeUcfDefinition.Data, ShadowAttributeUcfDefinition.Delegable, ShadowAttributeUcfDefinition.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.
default ShadowSimpleAttributeDefinition<T>	deepClone(@NotNull DeepCloneOperation operation)	TODO document
ShadowSimpleAttributeDefinition<T>	delegate()
default <T extends ItemDefinition<?>> T	findItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz)	Used to find a matching item definition _within_ this definition.
default @NotNull ShadowSimpleAttributeDefinition<T>	forLayer(@NotNull LayerType layer)	Creates a view of the current definition for a given layer.
default @Nullable ItemChangeApplicationModeType	getChangeApplicationMode()	TODO
default ItemCorrelatorDefinitionType	getCorrelatorDefinition()
default @NotNull LayerType	getCurrentLayer()	Gets the current point-of-view: on which layer do we look at the data?
default String	getDescription()	Gets the (configured) attribute description.
default @NotNull AttributeFetchStrategyType	getFetchStrategy()	Returns configured fetch strategy.
default String	getFrameworkAttributeName()	Returns name of the attribute as given in the connector framework.
default String	getHumanReadableDescription()
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 String	getNativeAttributeName()	Returns native attribute name.
default @Nullable MappingType	getOutboundMappingBean()	Gets the outbound mapping, if defined.
default ItemProcessing	getProcessing(LayerType layer)	Gets the level of processing for specified layer.
default Boolean	getReadReplaceMode()	Should be this attribute modified solely in "replace" mode?
default Boolean	getReturnedByDefault()	Is this attribute returned by default? (I.e.
default @NotNull AttributeStorageStrategyType	getStorageStrategy()	Returns configured storage strategy.
default @NotNull List<String>	getTolerantValuePatterns()	Gets patterns for values that are "tolerated" on the resource.
default @NotNull Class<T>	getTypeClass()	Returns a compile-time class that is used to represent items.
default boolean	hasOutboundMapping()
default boolean	hasRefinements()	Returns `true` if there are any refinements (like in `schemaHandling`).
default @NotNull ShadowSimpleAttribute<T>	instantiate()	Create an item instance.
default @NotNull ShadowSimpleAttribute<T>	instantiate(QName name)	Create an item instance.
default Boolean	isCached()	If present, it overrides the inclusion/exclusion of this item in/from the shadow caching.
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	isIgnored(LayerType layer)	Is the attribute ignored (at specified layer)?
default boolean	isIndexOnly()	If true, this item is not stored in XML representation in repo.
default boolean	isMandatory(LayerType layer)
default boolean	isMultiValue(LayerType layer)
default boolean	isOptional(LayerType layer)
default Boolean	isSecondaryIdentifierOverride()	Is this attribute designated as a secondary identifier via `schemaHandling`?
default boolean	isSimulated()	If `true`, the item does not exist on the resource, but is simulated by midPoint.
default boolean	isSingleValue(LayerType layer)
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.
default void	setOverrideCanAdd(Boolean value)	Provides a value that will override ShadowItemLayeredDefinition.canAdd(LayerType) return values (for all layers).
default void	setOverrideCanModify(Boolean value)	Provides a value that will override ShadowItemLayeredDefinition.canModify(LayerType) return values (for all layers).
default void	setOverrideCanRead(Boolean value)	Provides a value that will override ShadowItemLayeredDefinition.canRead(LayerType) return values (for all layers).

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

checkMutableOnExposing

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

accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, getPlannedRemoval, getRemovedSince, getSchemaContextDefinition, getSchemaMigrations, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isOptionalCleanup, isRemoved, isRuntimeSchema

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

checkImmutable, checkMutable, freeze, isImmutable

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

cloneWithNewName, getProcessing, isAlwaysUseForEquals, isIgnored

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

canAdd, canModify, canRead, debugDumpShortToString, getDiagrams, getHelp, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, isDynamic, isHeterogeneousListItem, isIndexed, isInherited, isOperational, isSearchable, isValidFor, structuredType

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

getInfo

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

getTypeName, isMandatory, isMultiValue, isOptional, isSingleValue

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

createEmptyDelta

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

getNormalizer, getStringNormalizerForPolyStringProperty, getStringNormalizerIfApplicable, getTypeName, isCustomPolyString

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

getProcessing

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

getValueEnumerationRef

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

convertStringValueToPolyString, getTypeClassLegacy, isAnyType

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

createEmptyDelta, defaultValue, getAllowedValues, getMatchingRule, getMatchingRuleQName, getSuggestedValues, getTypeName, getValueEnumerationRef

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

revive

Methods inherited from interface com.evolveum.midpoint.prism.schema.SchemaLookup.Aware

schemaLookup

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

createPrismValueFromRealValue, getStandardPath, instantiateFrom, instantiateFromRealValue, instantiateFromRealValues, isEffectivelyCached, isReturnedByDefault, isVisible, isVisible

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

clone, convertPrismValue, createEmptyDelta, mutator, toNormalizationAware

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

shortDump, shortDump, shortDumpLazily

Method Details

delegate

ShadowSimpleAttributeDefinition<T> delegate()

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface ItemDefinitionDelegator<T>

Specified by:

delegate in interface PropertyDefinitionDelegator<T>

getReturnedByDefault

default Boolean getReturnedByDefault()

Description copied from interface: ShadowAttributeUcfDefinition

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

Specified by:

getReturnedByDefault in interface ShadowAttributeUcfDefinition

getNativeAttributeName

default String getNativeAttributeName()

Description copied from interface: ShadowAttributeUcfDefinition

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 ShadowAttributeUcfDefinition

Returns:

native attribute name

getFrameworkAttributeName

default String getFrameworkAttributeName()

Description copied from interface: ShadowAttributeUcfDefinition

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 ShadowAttributeUcfDefinition

Returns:

name of the attribute as given in the connector framework.

instantiate

@NotNull
default @NotNull ShadowSimpleAttribute<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 ItemDefinitionDelegator<T>

Specified by:

instantiate in interface PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>

Specified by:

instantiate in interface PropertyDefinitionDelegator<T>

Specified by:

instantiate in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

instantiate

@NotNull
default @NotNull ShadowSimpleAttribute<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 ItemDefinitionDelegator<T>

Specified by:

instantiate in interface PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>

Specified by:

instantiate in interface PropertyDefinitionDelegator<T>

Specified by:

instantiate in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

debugDump

default String debugDump(int indent,
 LayerType layer)

Description copied from interface: ShadowAttributeDefinition

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

Specified by:

debugDump in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

getLimitations

default PropertyLimitations getLimitations(LayerType layer)

Description copied from interface: ShadowItemLayeredDefinition

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

Specified by:

getLimitations in interface ShadowItemLayeredDefinition

See Also:

• ItemRefinedDefinitionType.getLimitations()

getFetchStrategy

@NotNull
default @NotNull AttributeFetchStrategyType getFetchStrategy()

Description copied from interface: ShadowAttributeDefinition

Returns configured fetch strategy.

Specified by:

getFetchStrategy in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ResourceItemDefinitionType.getFetchStrategy()

getStorageStrategy

@NotNull
default @NotNull AttributeStorageStrategyType getStorageStrategy()

Description copied from interface: ShadowAttributeDefinition

Returns configured storage strategy.

Specified by:

getStorageStrategy in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ResourceItemDefinitionType.getStorageStrategy()

isCached

default Boolean isCached()

Description copied from interface: ShadowAttributeDefinition

If present, it overrides the inclusion/exclusion of this item in/from the shadow caching. Please use the ShadowAttributeDefinition.isEffectivelyCached(ResourceObjectDefinition) method to determine the effective caching status.

Specified by:

isCached in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

isVolatilityTrigger

default boolean isVolatilityTrigger()

Description copied from interface: ShadowAttributeDefinition

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

Specified by:

isVolatilityTrigger in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ResourceItemDefinitionType.isVolatilityTrigger()

getModificationPriority

default Integer getModificationPriority()

Description copied from interface: ShadowAttributeDefinition

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

Specified by:

getModificationPriority in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ResourceItemDefinitionType.getModificationPriority()

getReadReplaceMode

default Boolean getReadReplaceMode()

Description copied from interface: ShadowAttributeDefinition

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

Specified by:

getReadReplaceMode in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ResourceItemDefinitionType.isReadReplaceMode()

isTolerant

default boolean isTolerant()

Description copied from interface: ShadowAttributeDefinition

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

Specified by:

isTolerant in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ItemRefinedDefinitionType.isTolerant()

isSecondaryIdentifierOverride

default Boolean isSecondaryIdentifierOverride()

Description copied from interface: ShadowSimpleAttributeDefinition

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

Specified by:

isSecondaryIdentifierOverride in interface ShadowSimpleAttributeDefinition<T>

See Also:

• ResourceItemDefinitionType.isSecondaryIdentifier()

canAdd

default boolean canAdd(LayerType layer)

Description copied from interface: ShadowItemLayeredDefinition

Is adding allowed (at specified layer)?

Specified by:

canAdd in interface ShadowItemLayeredDefinition

See Also:

• PrismItemAccessDefinition.canAdd()

canRead

default boolean canRead(LayerType layer)

Description copied from interface: ShadowItemLayeredDefinition

Is reading allowed (at specified layer)?

Specified by:

canRead in interface ShadowItemLayeredDefinition

See Also:

• PrismItemAccessDefinition.canRead()

canModify

default boolean canModify(LayerType layer)

Description copied from interface: ShadowItemLayeredDefinition

Is modification allowed (at specified layer)?

Specified by:

canModify in interface ShadowItemLayeredDefinition

See Also:

• PrismItemAccessDefinition.canModify()

isIgnored

default boolean isIgnored(LayerType layer)

Description copied from interface: ShadowItemLayeredDefinition

Is the attribute ignored (at specified layer)?

Specified by:

isIgnored in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

Specified by:

isIgnored in interface ShadowItemLayeredDefinition

getProcessing

default ItemProcessing getProcessing(LayerType layer)

Description copied from interface: ShadowItemLayeredDefinition

Gets the level of processing for specified layer.

Specified by:

getProcessing in interface ShadowItemLayeredDefinition

See Also:

• PrismItemMiscDefinition.getProcessing()

getDescription

default String getDescription()

Description copied from interface: ShadowAttributeDefinition

Gets the (configured) attribute description.

Specified by:

getDescription in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ItemRefinedDefinitionType.getDescription()

getOutboundMappingBean

@Nullable
default @Nullable MappingType getOutboundMappingBean()

Description copied from interface: ShadowAttributeDefinition

Gets the outbound mapping, if defined.

Specified by:

getOutboundMappingBean in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ResourceItemDefinitionType.getOutbound()

hasOutboundMapping

default boolean hasOutboundMapping()

Specified by:

hasOutboundMapping in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

getInboundMappingBeans

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

Description copied from interface: ShadowAttributeDefinition

Gets the inbound mappings (if any).

Specified by:

getInboundMappingBeans in interface ResourceObjectInboundDefinition.ItemInboundDefinition

Specified by:

getInboundMappingBeans in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ResourceItemDefinitionType.getInbound()

getMaxOccurs

default int getMaxOccurs(LayerType layer)

Description copied from interface: ShadowItemLayeredDefinition

Gets `maxOccurs` limitation for given layer.

Specified by:

getMaxOccurs in interface ShadowItemLayeredDefinition

See Also:

• PrismItemBasicDefinition.getMaxOccurs()

getMinOccurs

default int getMinOccurs(LayerType layer)

Description copied from interface: ShadowItemLayeredDefinition

Gets `minOccurs` limitation for given layer.

Specified by:

getMinOccurs in interface ShadowItemLayeredDefinition

isOptional

default boolean isOptional(LayerType layer)

Specified by:

isOptional in interface ShadowItemLayeredDefinition

isMandatory

default boolean isMandatory(LayerType layer)

Specified by:

isMandatory in interface ShadowItemLayeredDefinition

isMultiValue

default boolean isMultiValue(LayerType layer)

Specified by:

isMultiValue in interface ShadowItemLayeredDefinition

isSingleValue

default boolean isSingleValue(LayerType layer)

Specified by:

isSingleValue in interface ShadowItemLayeredDefinition

isExclusiveStrong

default boolean isExclusiveStrong()

Description copied from interface: ShadowAttributeDefinition

Drives behavior of strong and normal mappings for this attribute.

Specified by:

isExclusiveStrong in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ResourceItemDefinitionType.isExclusiveStrong()

getTolerantValuePatterns

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

Description copied from interface: ShadowAttributeDefinition

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

Specified by:

getTolerantValuePatterns in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ShadowAttributeDefinition.isTolerant()
• ItemRefinedDefinitionType.getTolerantValuePattern()

getIntolerantValuePatterns

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

Description copied from interface: ShadowAttributeDefinition

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

Specified by:

getIntolerantValuePatterns in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

See Also:

• ShadowAttributeDefinition.isTolerant()
• ItemRefinedDefinitionType.getIntolerantValuePattern()

isDisplayNameAttribute

default boolean isDisplayNameAttribute()

Description copied from interface: ShadowSimpleAttributeDefinition

Is this attribute configured to serve as a display name?

Specified by:

isDisplayNameAttribute in interface ShadowSimpleAttributeDefinition<T>

See Also:

• ResourceItemDefinitionType.isDisplayNameAttribute()

getCorrelatorDefinition

default ItemCorrelatorDefinitionType getCorrelatorDefinition()

Specified by:

getCorrelatorDefinition in interface ResourceObjectInboundDefinition.ItemInboundDefinition

Specified by:

getCorrelatorDefinition in interface ShadowSimpleAttributeDefinition<T>

See Also:

• ItemRefinedDefinitionType.getCorrelator()

getChangeApplicationMode

@Nullable
default @Nullable ItemChangeApplicationModeType getChangeApplicationMode()

Description copied from interface: ShadowAttributeDefinition

TODO

Specified by:

getChangeApplicationMode in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

getLifecycleState

@Nullable
default @Nullable String getLifecycleState()

Description copied from interface: ShadowAttributeDefinition

TODO

Specified by:

getLifecycleState in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

deepClone

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

Description copied from interface: ItemDefinition

TODO document

Specified by:

deepClone in interface ItemDefinition<T>

Specified by:

deepClone in interface ItemDefinitionDelegator<T>

Specified by:

deepClone in interface ShadowSimpleAttributeDefinition<T>

setOverrideCanRead

default void setOverrideCanRead(Boolean value)

Description copied from interface: ShadowAttributeDefinition

Provides a value that will override ShadowItemLayeredDefinition.canRead(LayerType) return values (for all layers). Used e.g. when applying authorizations on the definition.

Specified by:

setOverrideCanRead in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

setOverrideCanAdd

default void setOverrideCanAdd(Boolean value)

Description copied from interface: ShadowAttributeDefinition

Provides a value that will override ShadowItemLayeredDefinition.canAdd(LayerType) return values (for all layers). Used e.g. when applying authorizations on the definition.

Specified by:

setOverrideCanAdd in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

setOverrideCanModify

default void setOverrideCanModify(Boolean value)

Description copied from interface: ShadowAttributeDefinition

Provides a value that will override ShadowItemLayeredDefinition.canModify(LayerType) return values (for all layers). Used e.g. when applying authorizations on the definition.

Specified by:

setOverrideCanModify in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

forLayer

@NotNull
default @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<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

Specified by:

forLayer in interface ShadowSimpleAttributeDefinition<T>

getCurrentLayer

@NotNull
default @NotNull LayerType getCurrentLayer()

Description copied from interface: LayeredDefinition

Gets the current point-of-view: on which layer do we look at the data?

Specified by:

getCurrentLayer in interface LayeredDefinition

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 DefinitionDelegator

Specified by:

getTypeClass in interface PrismItemMatchingDefinition<T>

Specified by:

getTypeClass in interface PrismPropertyDefinition<T>

Specified by:

getTypeClass in interface PropertyDefinitionDelegator<T>

Specified by:

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

Specified by:

getTypeClass in interface ShadowSimpleAttributeDefinition<T>

hasRefinements

default boolean hasRefinements()

Description copied from interface: ShadowAttributeDefinition

Returns `true` if there are any refinements (like in `schemaHandling`).

Specified by:

hasRefinements in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

isIndexOnly

default boolean isIndexOnly()

Description copied from interface: PrismItemStorageDefinition

If true, this item is not stored in XML representation in repo. TODO better name

Specified by:

isIndexOnly in interface ItemDefinitionDelegator<T>

Specified by:

isIndexOnly in interface PrismItemStorageDefinition

getHumanReadableDescription

default String getHumanReadableDescription()

Specified by:

getHumanReadableDescription in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

isSimulated

default boolean isSimulated()

Description copied from interface: ShadowAttributeDefinition

If `true`, the item does not exist on the resource, but is simulated by midPoint.

Specified by:

isSimulated in interface ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>

findItemDefinition

default <T extends ItemDefinition<?>> T findItemDefinition(@NotNull
 @NotNull ItemPath path,
 @NotNull
 @NotNull Class<T> clazz)

Description copied from interface: LivePrismItemDefinition

Used to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.

Specified by:

findItemDefinition in interface ItemDefinitionDelegator<T>

Specified by:

findItemDefinition in interface LivePrismItemDefinition

Specified by:

findItemDefinition in interface ShadowItemDefinition

Specified by:

findItemDefinition in interface ShadowSimpleAttributeDefinition<T>