Package com.evolveum.midpoint.gui.impl.prism.wrapper

Class ResourceAttributeWrapperImpl<T>

java.lang.Object

com.evolveum.midpoint.gui.impl.prism.wrapper.ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

com.evolveum.midpoint.gui.impl.prism.wrapper.PrismPropertyWrapperImpl<T>

com.evolveum.midpoint.gui.impl.prism.wrapper.ResourceAttributeWrapperImpl<T>

All Implemented Interfaces:

ItemWrapper<PrismProperty<T>,PrismPropertyValueWrapper<T>>, PrismPropertyWrapper<T>, ResourceAttributeWrapper<T>, Definition, Freezable, ItemDefinition<PrismProperty<T>>, LivePrismItemDefinition, PrismItemAccessDefinition, PrismItemBasicDefinition, PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>, PrismItemMatchingDefinition<T>, PrismItemMiscDefinition, PrismItemStorageDefinition, PrismItemValuesDefinition<T>, PrismLifecycleDefinition, PrismPresentationDefinition, PrismPropertyDefinition<T>, Revivable, SchemaLookup.Aware, SmartVisitable<Definition>, Visitable<Definition>, LayeredDefinition, ResourceObjectInboundProcessingDefinition.ItemInboundProcessingDefinition, ShadowAttributeDefinition<PrismPropertyValue<T>,ShadowSimpleAttributeDefinition<T>,T,ShadowSimpleAttribute<T>>, ShadowAttributeUcfDefinition, ShadowItemDefinition, ShadowItemLayeredDefinition, ShadowSimpleAttributeDefinition<T>, DebugDumpable, ShortDumpable, Serializable, Cloneable

public class ResourceAttributeWrapperImpl<T>
extends PrismPropertyWrapperImpl<T>
implements ResourceAttributeWrapper<T>

Author:

skublik

See Also:

• Serialized Form

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

Constructor Summary

Constructors

Constructor	Description
ResourceAttributeWrapperImpl(PrismContainerValueWrapper<?> parent, ShadowSimpleAttribute<T> item, ItemStatus status)

Method Summary

Modifier and Type	Method	Description
boolean	canAdd()	Returns true if this item can be added: it can be part of an object that is created.
boolean	canAdd(LayerType layer)	Is adding allowed (at specified layer)?
boolean	canModify()	Returns true if this item can be modified (updated).
boolean	canModify(LayerType layer)	Is modification allowed (at specified layer)?
boolean	canRead()	Returns true if this item can be read (displayed).
boolean	canRead(LayerType layer)	Is reading allowed (at specified layer)?
@NotNull ShadowSimpleAttributeDefinition<T>	clone()
PrismPropertyValue<T>	createPrismValueFromRealValue(@NotNull Object realValue)
String	debugDump(int indent)
String	debugDump(int indent, LayerType layer)	Provides a debug dump respective to the given layer.
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.
@Nullable ItemChangeApplicationModeType	getChangeApplicationMode()
ItemCorrelatorDefinitionType	getCorrelatorDefinition()
@NotNull LayerType	getCurrentLayer()	Gets the current point-of-view: on which layer do we look at the data?
String	getDescription()	Gets the (configured) attribute description.
@NotNull AttributeFetchStrategyType	getFetchStrategy()	Returns configured fetch strategy.
String	getFrameworkAttributeName()	Returns name of the attribute as given in the connector framework.
String	getHumanReadableDescription()
@NotNull List<InboundMappingType>	getInboundMappingBeans()	Gets the inbound mappings (if any).
@NotNull List<String>	getIntolerantValuePatterns()	Gets patterns for values that are not "tolerated" on the resource.
@Nullable String	getLifecycleState()
PropertyLimitations	getLimitations(LayerType layer)	Returns limitations (cardinality, access rights, processing) for given layer.
int	getMaxOccurs()	Returns the number of maximal value occurrences.
int	getMaxOccurs(LayerType layer)	Gets `maxOccurs` limitation for given layer.
int	getMinOccurs()	Returns the number of minimal value occurrences.
int	getMinOccurs(LayerType layer)	Gets `minOccurs` limitation for given layer.
Integer	getModificationPriority()	Determines the order in which this attribute should be modified (in very special cases).
String	getNativeAttributeName()	Returns native attribute name.
@Nullable MappingType	getOutboundMappingBean()	Gets the outbound mapping, if defined.
ItemProcessing	getProcessing()	Level of processing (ignore, minimal, auto, full) for this item/type.
ItemProcessing	getProcessing(LayerType layer)	Gets the level of processing for specified layer.
Boolean	getReadReplaceMode()	Should be this attribute modified solely in "replace" mode?
@Nullable Boolean	getReturnedByDefault()	Is this attribute returned by default?
@Nullable SchemaContextDefinition	getSchemaContextDefinition()
@NotNull AttributeStorageStrategyType	getStorageStrategy()	Returns configured storage strategy.
@NotNull List<String>	getTolerantValuePatterns()	Gets patterns for values that are "tolerated" on the resource.
boolean	hasRefinements()	Returns `true` if there are any refinements (like in `schemaHandling`).
@NotNull ShadowSimpleAttribute<T>	instantiate()	Create an item instance.
@NotNull ShadowSimpleAttribute<T>	instantiate(QName name)	Create an item instance.
Boolean	isCached()	If present, it overrides the inclusion/exclusion of this item in/from the shadow caching.
boolean	isDisplayNameAttribute()	Is this attribute configured to serve as a display name?
boolean	isExclusiveStrong()	Drives behavior of strong and normal mappings for this attribute.
boolean	isIgnored()
Boolean	isSecondaryIdentifierOverride()	Is this attribute designated as a secondary identifier via `schemaHandling`?
boolean	isSimulated()	If `true`, the item does not exist on the resource, but is simulated by midPoint.
boolean	isTolerant()	When set to true, allows to preserve attribute values that are set outside midPoint.
boolean	isVolatileOnAddOperation()	This attribute may get unexpected values when the object is created on the resource.
boolean	isVolatileOnModifyOperation()	This attribute may get unexpected values when the object is updated on the resource, regardless of what attributes are modified and in what way.
boolean	isVolatilityTrigger()	Is this attribute so-called volatility trigger, i.e. may its changes cause changes in other attributes?
void	setOverrideCanAdd(Boolean value)	Provides a value that will override ShadowItemLayeredDefinition.canAdd(LayerType) return values (for all layers).
void	setOverrideCanModify(Boolean value)	Provides a value that will override ShadowItemLayeredDefinition.canModify(LayerType) return values (for all layers).
void	setOverrideCanRead(Boolean value)	Provides a value that will override ShadowItemLayeredDefinition.canRead(LayerType) return values (for all layers).
void	shortDump(StringBuilder sb)	Show the content of the object intended for diagnostics.
Optional<ComplexTypeDefinition>	structuredType()	Returns complex type definition of item, if underlying value is possible structured.

Methods inherited from class com.evolveum.midpoint.gui.impl.prism.wrapper.PrismPropertyWrapperImpl

accept, accept, cloneWithNewName, createEmptyDelta, createNewEmptyValue, defaultValue, freeze, getAllowedValues, getDelta, getItemDefinition, getMatchingRule, getMatchingRuleQName, getPredefinedValuesOid, getSuggestedValues, getTypeClass, isEmpty, isImmutable, isIndexed, mutator, removeNotChangedStatusValue, setMuteDeltaCreate, setPredefinedValuesOid

Methods inherited from class com.evolveum.midpoint.gui.impl.prism.wrapper.ItemWrapperImpl

add, addValueToDelta, checkRequired, computeDeltaInternal, debugDumpShortToString, findItemDefinition, findObjectStatus, findObjectWrapper, getAnnotation, getAnnotations, getDeprecatedSince, getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getFormComponentValidator, getHelp, getItem, getItemName, getMergerIdentifier, getMergerInstance, getNaturalKeyConstituents, getNaturalKeyInstance, getOldItem, getParent, getParentContainerValue, getPath, getPlannedRemoval, getPreconditionDeltas, getRemovedSince, getSchemaMigrations, getStatus, getSubstitutionHead, getTypeName, getValue, getValueEnumerationRef, getValues, getVisibleOverwrite, isAbstract, isAlwaysUseForEquals, isColumn, isDeprecated, isDynamic, isElaborate, isEmphasized, isExperimental, isHeterogeneousListItem, isIndexOnly, isInherited, isMetadata, isOperational, isOptionalCleanup, isProcessProvenanceMetadata, isReadOnly, isRemoved, isRuntimeSchema, isShowEmpty, isShowInVirtualContainer, isShowMetadataDetails, isValidated, isValidFor, isVisible, isVisibleByVisibilityHandler, remove, removeAll, revive, setColumn, setDisplayName, setDisplayOrder, setHelp, setMetadata, setProcessProvenanceMetadata, setReadOnly, setShowEmpty, setShowInVirtualContainer, setShowMetadataDetails, setValidated, setVisibleOverwrite, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

debugDump, debugDumpLazily, debugDumpLazily

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

checkMutableOnExposing, debugDump, getAnnotation, getAnnotations, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, 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, getSubstitutionHead, getValueEnumerationRef, isAlwaysUseForEquals, isDynamic, isHeterogeneousListItem, isInherited, isOperational

Methods inherited from interface com.evolveum.midpoint.gui.api.prism.wrapper.ItemWrapper

add, checkRequired, findObjectStatus, findObjectWrapper, getDelta, getFormComponentValidator, getItem, getParent, getParentContainerValue, getPath, getPreconditionDeltas, getStatus, getValue, getValues, getVisibleOverwrite, isColumn, isEmpty, isMetadata, isProcessProvenanceMetadata, isReadOnly, isShowEmpty, isShowInVirtualContainer, isShowMetadataDetails, isValidated, isVisible, remove, removeAll, setColumn, setMetadata, setProcessProvenanceMetadata, setReadOnly, setShowEmpty, setShowInVirtualContainer, setShowMetadataDetails, setValidated, setVisibleOverwrite

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

isValidFor

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

getInfo

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

getItemName, getTypeName, isMandatory, isMultiValue, isOptional, isSingleValue

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

createEmptyDelta

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

getMatchingRule, getMatchingRuleQName, getNormalizer, getStringNormalizerForPolyStringProperty, getStringNormalizerIfApplicable, getTypeName, isCustomPolyString

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

convertStringValueToPolyString, getTypeClassLegacy, isAnyType

Methods inherited from interface com.evolveum.midpoint.gui.api.prism.wrapper.PrismPropertyWrapper

getPredefinedValuesOid, setPredefinedValuesOid

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

getStandardPath, hasOutboundMapping, instantiateFrom, instantiateFromRealValue, instantiateFromRealValues, isEffectivelyCached, isIgnored, isReturnedByDefault, isVisible

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

isVisible

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

isMandatory, isMultiValue, isOptional, isSingleValue

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

convertPrismValue, createEmptyDelta, findItemDefinition, getTypeClass, mutator, toNormalizationAware

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

shortDump, shortDumpLazily

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

accept

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

accept

Constructor Details

ResourceAttributeWrapperImpl

public ResourceAttributeWrapperImpl(PrismContainerValueWrapper<?> parent,
 ShadowSimpleAttribute<T> item,
 ItemStatus status)

Method Details

isTolerant

public 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

public 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

public boolean canAdd()

Description copied from interface: PrismItemAccessDefinition

Returns true if this item can be added: it can be part of an object that is created. In case of containers this means that the container itself should be displayed in creation forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one createable item. This does NOT mean that also all the container items can be created. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

Specified by:

canAdd in interface PrismItemAccessDefinition

Overrides:

canAdd in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

canAdd

public 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

public boolean canRead()

Description copied from interface: PrismItemAccessDefinition

Returns true if this item can be read (displayed). In case of containers this flag is, strictly speaking, not applicable. Container is an empty shell. What matters is access to individual sub-item. However, for containers this value has a "hint" meaning. It means that the container itself contains something that is readable. Which can be used as a hint by the presentation to display container label or block. This usually happens if the container contains at least one readable item. This does NOT mean that also all the container items can be displayed. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container. Note: It was considered to use a different meaning for this flag - a meaning that would allow canRead()=false containers to have readable items. However, this was found not to be very useful. Therefore the "something readable inside" meaning was confirmed instead.

Specified by:

canRead in interface PrismItemAccessDefinition

Overrides:

canRead in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

canRead

public 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

public boolean canModify()

Description copied from interface: PrismItemAccessDefinition

Returns true if this item can be modified (updated). In case of containers this means that the container itself should be displayed in modification forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one modifiable item. This does NOT mean that also all the container items can be modified. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

Specified by:

canModify in interface PrismItemAccessDefinition

Overrides:

canModify in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

canModify

public 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

public boolean isIgnored()

Specified by:

isIgnored in interface ItemDefinition<T>

Overrides:

isIgnored in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

getProcessing

public ItemProcessing getProcessing()

Description copied from interface: PrismItemMiscDefinition

Level of processing (ignore, minimal, auto, full) for this item/type.

Specified by:

getProcessing in interface ItemDefinition<T>

Specified by:

getProcessing in interface PrismItemMiscDefinition

Overrides:

getProcessing in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

getProcessing

public 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

public 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
public @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()

getInboundMappingBeans

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

Description copied from interface: ShadowAttributeDefinition

Gets the inbound mappings (if any).

Specified by:

getInboundMappingBeans in interface ResourceObjectInboundProcessingDefinition.ItemInboundProcessingDefinition

Specified by:

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

See Also:

• ResourceItemDefinitionType.getInbound()

getMaxOccurs

public int getMaxOccurs()

Description copied from interface: PrismItemBasicDefinition

Returns the number of maximal value occurrences. Any negative number means "unbounded".

Specified by:

getMaxOccurs in interface PrismItemBasicDefinition

Overrides:

getMaxOccurs in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

getMaxOccurs

public 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

public int getMinOccurs()

Description copied from interface: PrismItemBasicDefinition

Returns the number of minimal value occurrences.

Specified by:

getMinOccurs in interface PrismItemBasicDefinition

Overrides:

getMinOccurs in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

getMinOccurs

public int getMinOccurs(LayerType layer)

Description copied from interface: ShadowItemLayeredDefinition

Gets `minOccurs` limitation for given layer.

Specified by:

getMinOccurs in interface ShadowItemLayeredDefinition

isExclusiveStrong

public 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()

getLimitations

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

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

getTolerantValuePatterns

@NotNull
public @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
public @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()

isVolatilityTrigger

public 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()
• ResourceItemDefinitionType.getVolatility()

isVolatileOnAddOperation

public boolean isVolatileOnAddOperation()

Description copied from interface: ShadowAttributeDefinition

This attribute may get unexpected values when the object is created on the resource. (Regardless of whether any value is provided by the client. These subtle cases may get distinguished later.)

Specified by:

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

isVolatileOnModifyOperation

public boolean isVolatileOnModifyOperation()

Description copied from interface: ShadowAttributeDefinition

This attribute may get unexpected values when the object is updated on the resource, regardless of what attributes are modified and in what way.

Specified by:

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

getSchemaContextDefinition

@Nullable
public @Nullable SchemaContextDefinition getSchemaContextDefinition()

Specified by:

getSchemaContextDefinition in interface Definition

Overrides:

getSchemaContextDefinition in class PrismPropertyWrapperImpl<T>

clone

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

Specified by:

clone in interface ShadowSimpleAttributeDefinition<T>

Overrides:

clone in class PrismPropertyWrapperImpl<T>

deepClone

public 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 ResourceAttributeWrapper<T>

Specified by:

deepClone in interface ShadowSimpleAttributeDefinition<T>

Overrides:

deepClone in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Specified by:

debugDump in interface ItemWrapper<PrismProperty<T>,PrismPropertyValueWrapper<T>>

Overrides:

debugDump in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

debugDump

public String debugDump(int indent,
 LayerType layer)

Description copied from interface: ShadowAttributeDefinition

Provides a debug dump respective to the given layer.

Specified by:

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

forLayer

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

setOverrideCanRead

public 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

public 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

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

getModificationPriority

public 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

public 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()

isDisplayNameAttribute

public 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

public ItemCorrelatorDefinitionType getCorrelatorDefinition()

Specified by:

getCorrelatorDefinition in interface ResourceObjectInboundProcessingDefinition.ItemInboundProcessingDefinition

Specified by:

getCorrelatorDefinition in interface ShadowSimpleAttributeDefinition<T>

See Also:

• ItemRefinedDefinitionType.getCorrelator()

getChangeApplicationMode

@Nullable
public @Nullable ItemChangeApplicationModeType getChangeApplicationMode()

Specified by:

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

See Also:

• ItemRefinedDefinitionType.getChangeApplicationMode()

getLifecycleState

@Nullable
public @Nullable String getLifecycleState()

Specified by:

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

Specified by:

getLifecycleState in interface ShadowItemDefinition

See Also:

• ItemRefinedDefinitionType.getLifecycleState()

instantiate

@NotNull
public @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 PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>

Specified by:

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

Overrides:

instantiate in class PrismPropertyWrapperImpl<T>

instantiate

@NotNull
public @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 PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>

Specified by:

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

Overrides:

instantiate in class PrismPropertyWrapperImpl<T>

createPrismValueFromRealValue

public PrismPropertyValue<T> createPrismValueFromRealValue(@NotNull
 @NotNull Object realValue)
                                                    throws SchemaException

Specified by:

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

Throws:

SchemaException

getHumanReadableDescription

public String getHumanReadableDescription()

Specified by:

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

isSimulated

public boolean isSimulated()

Description copied from interface: ShadowAttributeDefinition

If `true`, the item does not exist on the resource, but is simulated by midPoint. Applies to reference attributes for now.

Specified by:

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

structuredType

public Optional<ComplexTypeDefinition> structuredType()

Description copied from interface: ItemDefinition

Returns complex type definition of item, if underlying value is possible structured. NOTE: This seems weird, since properties and references are simple values, but actually object reference is serialized as structured value and some of properties are also.

Specified by:

structuredType in interface ItemDefinition<T>

Overrides:

structuredType in class ItemWrapperImpl<PrismProperty<T>,PrismPropertyValueWrapper<T>>

getReturnedByDefault

@Nullable
public @Nullable 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

public 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

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

hasRefinements

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

getCurrentLayer

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

shortDump

public void shortDump(StringBuilder sb)

Description copied from interface: ShortDumpable

Show the content of the object intended for diagnostics. This method is supposed to append a compact, human-readable output in a single line. Unlike toString() method, there is no requirement to identify the actual class or type of the object. It is assumed that the class/type will be obvious from the context in which the output is used.

Specified by:

shortDump in interface ShortDumpable

Parameters:

sb - StringBuilder to which to a compact one-line content of the object intended for diagnostics by system administrator should be appended.