Package com.evolveum.midpoint.schema.processor

Class ShadowAttributeDefinitionImpl<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>,ND extends NativeShadowAttributeDefinition>

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.schema.processor.ShadowAttributeDefinitionImpl<V,D,RV,SA,ND>

All Implemented Interfaces:

Definition, Freezable, PrismItemAccessDefinition, PrismItemBasicDefinition, PrismItemMiscDefinition, PrismItemStorageDefinition, PrismLifecycleDefinition, PrismPresentationDefinition, Revivable, SmartVisitable<Definition>, Visitable<Definition>, LayeredDefinition, ResourceObjectInboundProcessingDefinition.ItemInboundProcessingDefinition, ShadowAttributeDefinition<V,D,RV,SA>, ShadowAttributeUcfDefinition, ShadowItemDefinition, ShadowItemLayeredDefinition, ShadowItemLifecycleDefinitionDefaults, DebugDumpable, ShortDumpable, Serializable, Cloneable

Direct Known Subclasses:

ShadowReferenceAttributeDefinitionImpl, ShadowSimpleAttributeDefinitionImpl

public abstract class ShadowAttributeDefinitionImpl<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>,ND extends NativeShadowAttributeDefinition>
extends AbstractFreezable
implements ShadowAttributeDefinition<V,D,RV,SA>, ShadowItemLifecycleDefinitionDefaults

Base implementation of ShadowSimpleAttributeDefinitionImpl and ShadowReferenceAttributeDefinitionImpl. The implementation consists of a pair of nativeDefinition and customizationBean, plus some auxiliary information for faster access. This class intentionally does NOT inherit from PrismPropertyDefinitionImpl. Instead, a large part of the required functionality is delegated to nativeDefinition which inherits from that class.

See Also:

• NativeShadowAttributeDefinition
• 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.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.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.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.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
void	accept(Visitor<Definition> visitor)
boolean	accept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)
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)?
abstract @NotNull ShadowAttributeDefinitionImpl<V,D,RV,SA,ND>	clone()
String	debugDump(int indent)
String	debugDump(int indent, LayerType layer)	Provides a debug dump respective to the given layer.
boolean	equals(Object o)
protected abstract void	extendToString(StringBuilder sb)
<A> A	getAnnotation(QName qname)	Returns generic definition annotation.
Map<QName,Object>	getAnnotations()	Returns all annotations, as unmodifiable map.
@Nullable ItemChangeApplicationModeType	getChangeApplicationMode()
@NotNull LayerType	getCurrentLayer()	Gets the current point-of-view: on which layer do we look at the data?
abstract String	getDebugDumpClassName()	Return a human readable name of this class suitable for logs.
String	getDescription()	Gets the (configured) attribute description.
List<ItemDiagramSpecification>	getDiagrams()
DisplayHint	getDisplayHint()	Enumeration annotation that specifies how/whether the item should be displayed.
String	getDisplayName()	Returns display name.
Integer	getDisplayOrder()	Specifies an order in which the item should be displayed relative to other items at the same level.
String	getDocumentation()	Must contains tag because of html tags used in text.
String	getDocumentationPreview()	Returns only a first sentence of documentation.
@NotNull AttributeFetchStrategyType	getFetchStrategy()	Returns configured fetch strategy.
String	getFrameworkAttributeName()	Returns name of the attribute as given in the connector framework.
String	getHelp()	Returns help string.
@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.
@NotNull ItemName	getItemName()	Gets the "canonical" name of the item for the definition.
@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.
@Nullable String	getMergerIdentifier()
@Nullable ItemMerger	getMergerInstance(@NotNull MergeStrategy strategy, @Nullable OriginMarker originMarker)
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 List<QName>	getNaturalKeyConstituents()
@Nullable NaturalKeyDefinition	getNaturalKeyInstance()
@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? (I.e.
List<SchemaMigration>	getSchemaMigrations()
@NotNull AttributeStorageStrategyType	getStorageStrategy()	Returns configured storage strategy.
QName	getSubstitutionHead()
@NotNull List<String>	getTolerantValuePatterns()	Gets patterns for values that are "tolerated" on the resource.
PrismReferenceValue	getValueEnumerationRef()
int	hashCode()
boolean	hasRefinements()	Returns `true` if there are any refinements (like in `schemaHandling`).
SA	instantiate()
SA	instantiate(QName name)
boolean	isAbstract()	For types: is the type abstract so that it should not be instantiated directly? For items: TODO
boolean	isAlwaysUseForEquals()
Boolean	isCached()	If present, it overrides the inclusion/exclusion of this item in/from the shadow caching.
boolean	isDynamic()
boolean	isElaborate()	Elaborate items are complicated data structure that may deviate from normal principles of the system.
boolean	isEmphasized()	True for definitions that are more important than others and that should be emphasized during presentation.
boolean	isExclusiveStrong()	Drives behavior of strong and normal mappings for this attribute.
boolean	isHeterogeneousListItem()
Boolean	isIndexed()	This is XSD annotation that specifies whether a property should be indexed in the storage.
boolean	isIndexOnly()	If true, this item is not stored in XML representation in repo.
boolean	isInherited()
boolean	isOperational()
boolean	isOptionalCleanup()	Marks item that could be ignored by SCM tools (e.g.
boolean	isRuntimeSchema()	This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.
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.
void	performFreeze()
<A> void	setAnnotation(QName qname, A value)
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()
String	toString()

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

Methods inherited from class java.lang.Object

finalize, getClass, 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, getMutabilityFlag, getSchemaContextDefinition, getTypeName, mutator

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

checkImmutable, checkMutable, freeze, isImmutable

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

isSearchable

Methods inherited from interface com.evolveum.midpoint.schema.processor.ResourceObjectInboundProcessingDefinition.ItemInboundProcessingDefinition

getCorrelatorDefinition

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

revive

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

createPrismValueFromRealValue, forLayer, getHumanReadableDescription, getStandardPath, getTypeClass, hasOutboundMapping, instantiateFrom, instantiateFromRealValue, instantiateFromRealValues, isEffectivelyCached, isIgnored, isReturnedByDefault, isSimulated, 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.ShadowItemLifecycleDefinitionDefaults

getDeprecatedSince, getPlannedRemoval, getRemovedSince, isDeprecated, isExperimental, isRemoved

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

shortDump, shortDumpLazily

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

See Also:

• ItemRefinedDefinitionType.isTolerant()

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

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

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

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

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

getDisplayHint

public DisplayHint getDisplayHint()

Description copied from interface: PrismPresentationDefinition

Enumeration annotation that specifies how/whether the item should be displayed. It is also a replacement for the old "emphasized" annotation.

Specified by:

getDisplayHint in interface PrismPresentationDefinition

isEmphasized

public boolean isEmphasized()

Description copied from interface: PrismPresentationDefinition

True for definitions that are more important than others and that should be emphasized during presentation. E.g. the emphasized definitions will always be displayed in the user interfaces (even if they are empty), they will always be included in the dumps, etc. TODO probably deprecated, isn't it?

Specified by:

isEmphasized in interface PrismPresentationDefinition

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 PrismItemMiscDefinition

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

getDisplayName

public String getDisplayName()

Description copied from interface: PrismPresentationDefinition

Returns display name. Specifies the printable name of the object class or attribute. It must contain a printable string. It may also contain a key to catalog file. Returns null if no display name is set. Corresponds to "displayName" XSD annotation.

Specified by:

getDisplayName in interface PrismPresentationDefinition

Returns:

display name string or catalog key

getDisplayOrder

public Integer getDisplayOrder()

Description copied from interface: PrismPresentationDefinition

Specifies an order in which the item should be displayed relative to other items at the same level. The items will be displayed by sorting them by the values of displayOrder annotation (ascending). Items that do not have any displayOrder annotation will be displayed last. The ordering of values with the same displayOrder is undefined and it may be arbitrary.

Specified by:

getDisplayOrder in interface PrismPresentationDefinition

getHelp

public String getHelp()

Description copied from interface: PrismPresentationDefinition

Returns help string. Specifies the help text or a key to catalog file for a help text. The help text may be displayed in any suitable way by the GUI. It should explain the meaning of an attribute or object class. Returns null if no help string is set. Corresponds to "help" XSD annotation.

Specified by:

getHelp in interface PrismPresentationDefinition

Returns:

help string or catalog key

getDescription

public String getDescription()

Description copied from interface: ShadowAttributeDefinition

Gets the (configured) attribute description.

Specified by:

getDescription in interface ShadowAttributeDefinition<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

See Also:

• ResourceItemDefinitionType.getInbound()

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.

instantiate

@NotNull
public SA instantiate()

Specified by:

instantiate in interface ShadowAttributeDefinition<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

instantiate

@NotNull
public SA instantiate(QName name)

Specified by:

instantiate in interface ShadowAttributeDefinition<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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

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

getItemName

@NotNull
public @NotNull ItemName getItemName()

Description copied from interface: PrismItemBasicDefinition

Gets the "canonical" name of the item for the definition. Should be qualified, if at all possible.

Specified by:

getItemName in interface PrismItemBasicDefinition

getMinOccurs

public int getMinOccurs()

Description copied from interface: PrismItemBasicDefinition

Returns the number of minimal value occurrences.

Specified by:

getMinOccurs in interface PrismItemBasicDefinition

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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

getDocumentation

public String getDocumentation()

Description copied from interface: PrismPresentationDefinition

Must contains tag because of html tags used in text.

Specified by:

getDocumentation in interface PrismPresentationDefinition

getDocumentationPreview

public String getDocumentationPreview()

Description copied from interface: PrismPresentationDefinition

Returns only a first sentence of documentation.

Specified by:

getDocumentationPreview in interface PrismPresentationDefinition

getFetchStrategy

@NotNull
public @NotNull AttributeFetchStrategyType getFetchStrategy()

Description copied from interface: ShadowAttributeDefinition

Returns configured fetch strategy.

Specified by:

getFetchStrategy in interface ShadowAttributeDefinition<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

See Also:

• ResourceItemDefinitionType.getStorageStrategy()

isIndexOnly

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

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

toString

public String toString()

Overrides:

toString in class Object

extendToString

protected abstract void extendToString(StringBuilder sb)

getDebugDumpClassName

public abstract String getDebugDumpClassName()

Return a human readable name of this class suitable for logs.

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

See Also:

• ResourceItemDefinitionType.isReadReplaceMode()

getChangeApplicationMode

@Nullable
public @Nullable ItemChangeApplicationModeType getChangeApplicationMode()

Specified by:

getChangeApplicationMode in interface ShadowAttributeDefinition<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

See Also:

• ItemRefinedDefinitionType.getChangeApplicationMode()

getLifecycleState

@Nullable
public @Nullable String getLifecycleState()

Specified by:

getLifecycleState in interface ShadowAttributeDefinition<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

Specified by:

getLifecycleState in interface ShadowItemDefinition

See Also:

• ItemRefinedDefinitionType.getLifecycleState()

structuredType

public Optional<ComplexTypeDefinition> structuredType()

performFreeze

public void performFreeze()

Overrides:

performFreeze in class AbstractFreezable

accept

public boolean accept(Visitor<Definition> visitor,
 SmartVisitation<Definition> visitation)

Specified by:

accept in interface SmartVisitable<V extends PrismValue>

Returns:

false if we already was here

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

isRuntimeSchema

public boolean isRuntimeSchema()

Description copied from interface: Definition

This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g. extension schema, resource schema or connector schema or something like that. I.e. it is not defined statically.

Specified by:

isRuntimeSchema in interface Definition

getAnnotation

public <A> A getAnnotation(QName qname)

Description copied from interface: Definition

Returns generic definition annotation. Annotations are a method to extend schema definitions. This may be annotation stored in the schema definition file (e.g. XSD) or it may be a dynamic annotation determined at run-time. Annotation value should be a prism-supported object. E.g. a prims "bean" (JAXB annotated class), prism item, prism value or something like that. EXPERIMENTAL. Hic sunt leones. This may change at any moment. Note: annotations are only partially supported now (3.8). They are somehow transient. E.g. they are not serialized to XSD schema definitions (yet).

Specified by:

getAnnotation in interface Definition

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<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

accept

public void accept(Visitor<Definition> visitor)

Specified by:

accept in interface Visitable<V extends PrismValue>

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.

isAbstract

public boolean isAbstract()

Description copied from interface: Definition

For types: is the type abstract so that it should not be instantiated directly? For items: TODO

Specified by:

isAbstract in interface Definition

isElaborate

public boolean isElaborate()

Description copied from interface: Definition

Elaborate items are complicated data structure that may deviate from normal principles of the system. For example elaborate items may not be supported in user interface and may only be manageable by raw edits or a special-purpose tools. Elaborate items may be not fully supported by authorizations, schema tools and so on.

Specified by:

isElaborate in interface Definition

isOperational

public boolean isOperational()

isInherited

public boolean isInherited()

isDynamic

public boolean isDynamic()

getSubstitutionHead

public QName getSubstitutionHead()

isHeterogeneousListItem

public boolean isHeterogeneousListItem()

getValueEnumerationRef

public PrismReferenceValue getValueEnumerationRef()

getSchemaMigrations

public List<SchemaMigration> getSchemaMigrations()

Specified by:

getSchemaMigrations in interface PrismLifecycleDefinition

getDiagrams

public List<ItemDiagramSpecification> getDiagrams()

Specified by:

getDiagrams in interface PrismPresentationDefinition

setAnnotation

public <A> void setAnnotation(QName qname,
 A value)

getAnnotations

public Map<QName,Object> getAnnotations()

Description copied from interface: Definition

Returns all annotations, as unmodifiable map. Nullable by design, to avoid creating lots of empty maps.

Specified by:

getAnnotations in interface Definition

isIndexed

public Boolean isIndexed()

Description copied from interface: PrismItemStorageDefinition

This is XSD annotation that specifies whether a property should be indexed in the storage. It can only apply to properties. It has following meaning: true: the property must be indexed. If the storage is not able to index the value, it should indicate an error. false: the property should not be indexed. null: data store decides whether to index the property or not.

Specified by:

isIndexed in interface PrismItemStorageDefinition

isOptionalCleanup

public boolean isOptionalCleanup()

Description copied from interface: Definition

Marks item that could be ignored by SCM tools (e.g. Git), or removed before commit.

Specified by:

isOptionalCleanup in interface Definition

isAlwaysUseForEquals

public boolean isAlwaysUseForEquals()

getMergerIdentifier

@Nullable
public @Nullable String getMergerIdentifier()

Specified by:

getMergerIdentifier in interface Definition

getMergerInstance

@Nullable
public @Nullable ItemMerger getMergerInstance(@NotNull
 @NotNull MergeStrategy strategy,
 @Nullable
 @Nullable OriginMarker originMarker)

Specified by:

getMergerInstance in interface Definition

getNaturalKeyConstituents

@Nullable
public @Nullable List<QName> getNaturalKeyConstituents()

Specified by:

getNaturalKeyConstituents in interface Definition

getNaturalKeyInstance

@Nullable
public @Nullable NaturalKeyDefinition getNaturalKeyInstance()

Specified by:

getNaturalKeyInstance in interface Definition

clone

@NotNull
public abstract @NotNull ShadowAttributeDefinitionImpl<V,D,RV,SA,ND> clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ShadowAttributeDefinition<V extends PrismValue,D extends ShadowAttributeDefinition<V,D,RV,SA>,RV,SA extends ShadowAttribute<V,D,RV,SA>>

Overrides:

clone in class Object