java.lang.Object
- com.evolveum.midpoint.prism.AbstractFreezable
- - com.evolveum.midpoint.schema.processor.ResourceAttributeDefinitionImpl<T>

All Implemented Interfaces:

Definition, Freezable, ItemDefinition<PrismProperty<T>>, PrismContextSensitive, PrismItemAccessDefinition, PrismPropertyDefinition<T>, Revivable, SmartVisitable<Definition>, Visitable<Definition>, LayeredDefinition, RawResourceAttributeDefinition<T>, ResourceAttributeDefinition<T>, DebugDumpable, Serializable, Cloneable
```
public class ResourceAttributeDefinitionImpl<T>
extends AbstractFreezable
implements ResourceAttributeDefinition<T>
```
An attribute definition (obtained typically from the connector), optionally refined by information from `schemaHandling` section of a resource definition. The implementation consists of a pair of rawDefinition and customizationBean, plus some auxiliary information for faster access. NOTE: This structure is used to hold both "raw" and "refined" attributes. See the note for customizationBean.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition
  PrismItemAccessDefinition.Mutable

Field Summary
- Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
  INDENT_STRING

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(Visitor<Definition> visitor)`
`boolean`	`accept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)`
`void`	`adoptElementDefinitionFrom(ItemDefinition<?> otherDef)`	Transfers selected parts of the definition (currently item name, min/max occurs) from another definition.
`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`	`canBeDefinitionOf(PrismProperty<T> item)`	TODO document
`boolean`	`canBeDefinitionOf(PrismValue pvalue)`	TODO document
`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 ResourceAttributeDefinitionImpl<T>`	`clone()`
`static <T> ResourceAttributeDefinition<T>`	`create(@NotNull RawResourceAttributeDefinition<T> rawDefinition)`	This is the creation point from "raw" form only.
`static <T> ResourceAttributeDefinition<T>`	`create(@NotNull RawResourceAttributeDefinition<T> rawDefinition, @Nullable ResourceAttributeDefinitionType customizationBean)`	This is the main creation point.
`static <T> ResourceAttributeDefinition<T>`	`create(@NotNull ResourceAttributeDefinition<T> definitionProvidingRawData, @Nullable ResourceAttributeDefinitionType customizationBean)`	Creates the definition from a `ResourceAttributeDefinition` containing only the raw part.
`@NotNull PropertyDelta<T>`	`createEmptyDelta(ItemPath path)`	Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
`String`	`debugDump(int indent)`
`String`	`debugDump(int indent, LayerType layer)`	Provides a debug dump respective to the given layer.
`void`	`debugDumpShortToString(StringBuilder sb)`	Used in debugDumping items.
`ResourceAttributeDefinition<T>`	`deepClone(@NotNull DeepCloneOperation operation)`	TODO document
`T`	`defaultValue()`
`boolean`	`equals(Object o)`
`<D extends ItemDefinition<?>> D`	`findItemDefinition(@NotNull ItemPath path, @NotNull Class<D> clazz)`	Used to find a matching item definition _within_ this definition.
`@NotNull ResourceAttributeDefinitionImpl<T>`	`forLayer(@NotNull LayerType layer)`	Creates a view of the current definition for a given layer.
`Collection<? extends DisplayableValue<T>>`	`getAllowedValues()`	Returns allowed values for this property.
`<A> A`	`getAnnotation(QName qname)`	Returns generic definition annotation.
`@Nullable Map<QName,Object>`	`getAnnotations()`	Returns all annotations, as unmodifiable map.
`@Nullable ItemCorrelatorDefinitionType`	`getCorrelatorDefinition()`
`@NotNull LayerType`	`getCurrentLayer()`	Gets the current point-of-view: on which layer do we look at the data?
`String`	`getDebugDumpClassName()`	Return a human readable name of this class suitable for logs.
`String`	`getDeprecatedSince()`
`String`	`getDescription()`	Gets the (configured) attribute description.
`List<ItemDiagramSpecification>`	`getDiagrams()`
`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()`
`String`	`getDocumentationPreview()`	Returns only a first sentence of documentation.
`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.
`PropertyLimitations`	`getLimitations(LayerType layer)`	Returns limitations (cardinality, access rights, processing) for given layer.
`QName`	`getMatchingRuleQName()`	Returns matching rule name.
`int`	`getMaxOccurs()`	Return the number of maximal value occurrences.
`int`	`getMaxOccurs(LayerType layer)`	Gets `maxOccurs` limitation for given layer.
`int`	`getMinOccurs()`	Return 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.
`String`	`getPlannedRemoval()`	Version of data model in which the item is likely to be removed.
`PrismContext`	`getPrismContext()`
`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.
`RawResourceAttributeDefinition<T>`	`getRawAttributeDefinition()`	Gets the original (raw) attribute definition.
`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()`	Returns the name of an element this one can be substituted for (e.g.
`Collection<? extends DisplayableValue<T>>`	`getSuggestedValues()`	Returns suggested values for this property.
`@NotNull List<String>`	`getTolerantValuePatterns()`	Gets patterns for values that are "tolerated" on the resource.
`Class<T>`	`getTypeClass()`	Returns a compile-time class that is used to represent items.
`@NotNull QName`	`getTypeName()`	Returns a name of the type for this definition.
`PrismReferenceValue`	`getValueEnumerationRef()`	Reference to an object that directly or indirectly represents possible values for this item.
`int`	`hashCode()`
`@NotNull ResourceAttribute<T>`	`instantiate()`	Create an item instance.
`@NotNull ResourceAttribute<T>`	`instantiate(QName name)`	Create an item instance.
`boolean`	`isAbstract()`	For types: is the type abstract so that it should not be instantiated directly? For items: TODO
`boolean`	`isDeprecated()`
`boolean`	`isDisplayNameAttribute()`	Is this attribute configured to serve as a display name?
`boolean`	`isDynamic()`	Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML.
`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`	`isExperimental()`	Experimental functionality is not stable and it may be changed in any future release without any warning.
`boolean`	`isHeterogeneousListItem()`	Can be used in heterogeneous lists as a list item.
`boolean`	`isIgnored()`	Item definition that has this flag set should be ignored by any processing.
`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()`	Whether the item is inherited from a supertype.
`boolean`	`isOperational()`	Marks operational item.
`boolean`	`isRuntimeSchema()`	This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.
`Boolean`	`isSecondaryIdentifierOverride()`	Is this attribute designated as a secondary identifier via `schemaHandling`?
`boolean`	`isTolerant()`	When set to true, allows to preserve attribute values that are set outside midPoint.
`boolean`	`isValidFor(@NotNull QName elementQName, @NotNull Class<? extends ItemDefinition<?>> clazz, boolean caseInsensitive)`	Returns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way.
`boolean`	`isVolatilityTrigger()`	Is this attribute so-called volatility trigger, i.e.
`void`	`performFreeze()`
`void`	`revive(PrismContext prismContext)`	TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
`<A> void`	`setAnnotation(QName qname, A value)`
`void`	`setOverrideCanAdd(Boolean value)`	Provides a value that will override `ResourceAttributeDefinition.canAdd(LayerType)` return values (for all layers).
`void`	`setOverrideCanModify(Boolean value)`	Provides a value that will override `ResourceAttributeDefinition.canModify(LayerType)` return values (for all layers).
`void`	`setOverrideCanRead(Boolean value)`	Provides a value that will override `ResourceAttributeDefinition.canRead(LayerType)` return values (for all layers).
`ResourceAttributeDefinition<T>`	`spawnModifyingRaw(@NotNull Consumer<MutableRawResourceAttributeDefinition<T>> rawPartCustomizer)`	Creates a copy of the definition, with a given customizer applied to the _raw_ part of the definition.
`Optional<ComplexTypeDefinition>`	`structuredType()`	Returns complex type definition of item, if underlying value is possible structured.
`@NotNull MutableRawResourceAttributeDefinition<T>`	`toMutable()`	Returns an interface to mutate this definition.
`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
debugDump, getMutabilityFlag, getSchemaRegistry

Methods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition
isMandatory, isMultiValue, isOptional, isSingleValue

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

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

Methods inherited from interface com.evolveum.midpoint.schema.processor.ResourceAttributeDefinition
hasOutboundMapping, isIgnored, isMandatory, isMultiValue, isOptional, isSingleValue

- Method Detail
  - create
```
public static <T> ResourceAttributeDefinition<T> create(@NotNull
                                                        @NotNull ResourceAttributeDefinition<T> definitionProvidingRawData,
                                                        @Nullable
                                                        @Nullable ResourceAttributeDefinitionType customizationBean)
                                                 throws SchemaException
```
    Creates the definition from a ResourceAttributeDefinition containing only the raw part. TODO how we should call such definitions?
    
    Throws:
    
    SchemaException - If there's a problem with the customization bean.
  - create
```
public static <T> ResourceAttributeDefinition<T> create(@NotNull
                                                        @NotNull RawResourceAttributeDefinition<T> rawDefinition,
                                                        @Nullable
                                                        @Nullable ResourceAttributeDefinitionType customizationBean)
                                                 throws SchemaException
```
    This is the main creation point.
    
    Throws:
    
    SchemaException - If there's a problem with the customization bean.
  - create
```
public static <T> ResourceAttributeDefinition<T> create(@NotNull
                                                        @NotNull RawResourceAttributeDefinition<T> rawDefinition)
```
    This is the creation point from "raw" form only.
  - forLayer
```
@NotNull
public @NotNull ResourceAttributeDefinitionImpl<T> forLayer(@NotNull
                                                            @NotNull LayerType layer)
```
    Description copied from interface: ResourceAttributeDefinition
    
    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 ResourceAttributeDefinition<T>
  - clone
```
@NotNull
public @NotNull ResourceAttributeDefinitionImpl<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 ResourceAttributeDefinition<T>
    
    Overrides:
    
    clone in class Object
  - isTolerant
```
public boolean isTolerant()
```
    Description copied from interface: ResourceAttributeDefinition
    
    When set to true, allows to preserve attribute values that are set outside midPoint.
    
    Specified by:
    
    isTolerant in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ItemRefinedDefinitionType.isTolerant()
  - isSecondaryIdentifierOverride
```
public Boolean isSecondaryIdentifierOverride()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Is this attribute designated as a secondary identifier via `schemaHandling`?
    
    Specified by:
    
    isSecondaryIdentifierOverride in interface ResourceAttributeDefinition<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
  - canAdd
```
public boolean canAdd(LayerType layer)
```
    Description copied from interface: ResourceAttributeDefinition
    
    Is adding allowed (at specified layer)?
    
    Specified by:
    
    canAdd in interface ResourceAttributeDefinition<T>
    
    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: ResourceAttributeDefinition
    
    Is reading allowed (at specified layer)?
    
    Specified by:
    
    canRead in interface ResourceAttributeDefinition<T>
    
    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: ResourceAttributeDefinition
    
    Is modification allowed (at specified layer)?
    
    Specified by:
    
    canModify in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    PrismItemAccessDefinition.canModify()
  - setOverrideCanRead
```
public void setOverrideCanRead(Boolean value)
```
    Description copied from interface: ResourceAttributeDefinition
    
    Provides a value that will override ResourceAttributeDefinition.canRead(LayerType) return values (for all layers). Used e.g. when applying authorizations on the definition.
    
    Specified by:
    
    setOverrideCanRead in interface ResourceAttributeDefinition<T>
  - setOverrideCanAdd
```
public void setOverrideCanAdd(Boolean value)
```
    Description copied from interface: ResourceAttributeDefinition
    
    Provides a value that will override ResourceAttributeDefinition.canAdd(LayerType) return values (for all layers). Used e.g. when applying authorizations on the definition.
    
    Specified by:
    
    setOverrideCanAdd in interface ResourceAttributeDefinition<T>
  - setOverrideCanModify
```
public void setOverrideCanModify(Boolean value)
```
    Description copied from interface: ResourceAttributeDefinition
    
    Provides a value that will override ResourceAttributeDefinition.canModify(LayerType) return values (for all layers). Used e.g. when applying authorizations on the definition.
    
    Specified by:
    
    setOverrideCanModify in interface ResourceAttributeDefinition<T>
  - isIgnored
```
public boolean isIgnored()
```
    Description copied from interface: Definition
    
    Item definition that has this flag set should be ignored by any processing. The ignored item is still part of the schema. Item instances may appear in the serialized data formats (e.g. XML) or data store and the parser should not raise an error if it encounters them. But any high-level processing code should ignore presence of this item. E.g. it should not be displayed to the user, should not be present in transformed data structures, etc. Note that the same item can be ignored at higher layer (e.g. presentation) but not ignored at lower layer (e.g. model). This works by presenting different item definitions for these layers (see LayerRefinedAttributeDefinition). Semantics of this flag for complex type definitions is to be defined yet.
    
    Specified by:
    
    isIgnored in interface Definition
  - 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
  - isDeprecated
```
public boolean isDeprecated()
```
    Specified by:
    
    isDeprecated in interface Definition
  - isExperimental
```
public boolean isExperimental()
```
    Description copied from interface: Definition
    
    Experimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.
    
    Specified by:
    
    isExperimental in interface Definition
  - getPlannedRemoval
```
public String getPlannedRemoval()
```
    Description copied from interface: Definition
    
    Version of data model in which the item is likely to be removed. This annotation is used for deprecated item to indicate imminent incompatibility in future versions of data model.
    
    Specified by:
    
    getPlannedRemoval 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
  - getDeprecatedSince
```
public String getDeprecatedSince()
```
    Specified by:
    
    getDeprecatedSince in interface Definition
  - isEmphasized
```
public boolean isEmphasized()
```
    Description copied from interface: Definition
    
    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.
    
    Specified by:
    
    isEmphasized in interface Definition
  - getProcessing
```
public ItemProcessing getProcessing()
```
    Description copied from interface: Definition
    
    Level of processing (ignore, minimal, auto, full) for this item/type.
    
    Specified by:
    
    getProcessing in interface Definition
  - getProcessing
```
public ItemProcessing getProcessing(LayerType layer)
```
    Description copied from interface: ResourceAttributeDefinition
    
    Gets the level of processing for specified layer.
    
    Specified by:
    
    getProcessing in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    Definition.getProcessing()
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: Definition
    
    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 Definition
    
    Returns:
    
    display name string or catalog key
  - getDisplayOrder
```
public Integer getDisplayOrder()
```
    Description copied from interface: Definition
    
    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 Definition
  - getDescription
```
public String getDescription()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Gets the (configured) attribute description.
    
    Specified by:
    
    getDescription in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ItemRefinedDefinitionType.getDescription()
  - getRawAttributeDefinition
```
public RawResourceAttributeDefinition<T> getRawAttributeDefinition()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Gets the original (raw) attribute definition.
    
    Specified by:
    
    getRawAttributeDefinition in interface ResourceAttributeDefinition<T>
  - getOutboundMappingBean
```
@Nullable
public @Nullable MappingType getOutboundMappingBean()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Gets the outbound mapping, if defined.
    
    Specified by:
    
    getOutboundMappingBean in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceItemDefinitionType.getOutbound()
  - getInboundMappingBeans
```
@NotNull
public @NotNull List<InboundMappingType> getInboundMappingBeans()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Gets the inbound mappings (if any).
    
    Specified by:
    
    getInboundMappingBeans in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceItemDefinitionType.getInbound()
  - getItemName
```
@NotNull
public @NotNull ItemName getItemName()
```
    Description copied from interface: ItemDefinition
    
    Gets the "canonical" name of the item for the definition. Should be qualified, if at all possible.
    
    Specified by:
    
    getItemName in interface ItemDefinition<T>
  - getTypeName
```
@NotNull
public @NotNull QName getTypeName()
```
    Description copied from interface: Definition
    
    Returns a name of the type for this definition. The type can be part of the compile-time schema or it can be defined at run time. Examples of the former case are types like c:UserType, xsd:string, or even flexible ones like c:ExtensionType or c:ShadowAttributesType. Examples of the latter case are types used in - custom extensions, like ext:LocationsType (where ext = e.g. http://example.com/extension), - resource schema, like ri:inetOrgPerson (ri = http://.../resource/instance-3), - connector schema, like TODO In XML representation that corresponds to the name of the XSD type. Although beware, the run-time types do not have statically defined structure. And the resource and connector-related types may even represent different kinds of objects within different contexts (e.g. two distinct resources both with ri:AccountObjectClass types). Also note that for complex type definitions, the type name serves as a unique identifier. On the other hand, for item definitions, it is just one of its attributes; primary key is item name in that case. The type name should be fully qualified. (TODO reconsider this)
    
    Specified by:
    
    getTypeName in interface Definition
    
    Returns:
    
    the type name
  - 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
  - getReturnedByDefault
```
@Nullable
public @Nullable Boolean getReturnedByDefault()
```
    Description copied from interface: RawResourceAttributeDefinition
    
    Is this attribute returned by default? (I.e. if no specific options are sent to the connector?)
    
    Specified by:
    
    getReturnedByDefault in interface RawResourceAttributeDefinition<T>
  - getNativeAttributeName
```
public String getNativeAttributeName()
```
    Description copied from interface: RawResourceAttributeDefinition
    
    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 RawResourceAttributeDefinition<T>
    
    Returns:
    
    native attribute name
  - getFrameworkAttributeName
```
public String getFrameworkAttributeName()
```
    Description copied from interface: RawResourceAttributeDefinition
    
    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 RawResourceAttributeDefinition<T>
    
    Returns:
    
    name of the attribute as given in the connector framework.
  - instantiate
```
@NotNull
public @NotNull ResourceAttribute<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 PrismPropertyDefinition<T>
    
    Specified by:
    
    instantiate in interface RawResourceAttributeDefinition<T>
    
    Specified by:
    
    instantiate in interface ResourceAttributeDefinition<T>
  - instantiate
```
@NotNull
public @NotNull ResourceAttribute<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 PrismPropertyDefinition<T>
    
    Specified by:
    
    instantiate in interface RawResourceAttributeDefinition<T>
    
    Specified by:
    
    instantiate in interface ResourceAttributeDefinition<T>
  - getAllowedValues
```
public Collection<? extends DisplayableValue<T>> getAllowedValues()
```
    Description copied from interface: PrismPropertyDefinition
    
    Returns allowed values for this property.
    
    Specified by:
    
    getAllowedValues in interface PrismPropertyDefinition<T>
  - getSuggestedValues
```
public Collection<? extends DisplayableValue<T>> getSuggestedValues()
```
    Description copied from interface: PrismPropertyDefinition
    
    Returns suggested values for this property.
    
    Specified by:
    
    getSuggestedValues in interface PrismPropertyDefinition<T>
  - defaultValue
```
public T defaultValue()
```
    Specified by:
    
    defaultValue in interface PrismPropertyDefinition<T>
  - isIndexed
```
public Boolean isIndexed()
```
    Description copied from interface: PrismPropertyDefinition
    
    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 PrismPropertyDefinition<T>
  - getMaxOccurs
```
public int getMaxOccurs()
```
    Description copied from interface: ItemDefinition
    
    Return the number of maximal value occurrences. Any negative number means "unbounded".
    
    Specified by:
    
    getMaxOccurs in interface ItemDefinition<T>
  - isOperational
```
public boolean isOperational()
```
    Description copied from interface: ItemDefinition
    
    Marks operational item. Operational properties are auxiliary data (or meta-data) that are usually not modifiable by the end user. They are generated and maintained by the system. Operational items are also not usually displayed unless it is explicitly requested. The example of operational items are modification timestamps, create timestamps, user that made the last change, etc. They are also treated in a special way when comparing values. See ParameterizedEquivalenceStrategy.
    
    Specified by:
    
    isOperational in interface ItemDefinition<T>
  - isIndexOnly
```
public boolean isIndexOnly()
```
    Description copied from interface: ItemDefinition
    
    If true, this item is not stored in XML representation in repo. TODO better name
    
    Specified by:
    
    isIndexOnly in interface ItemDefinition<T>
  - isInherited
```
public boolean isInherited()
```
    Description copied from interface: ItemDefinition
    
    Whether the item is inherited from a supertype.
    
    Specified by:
    
    isInherited in interface ItemDefinition<T>
  - isDynamic
```
public boolean isDynamic()
```
    Description copied from interface: ItemDefinition
    
    Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML. This means that the definition needs to be stored alongside the data to have a successful serialization "roundtrip". The definition is not part of any schema and therefore cannot be determined. It may even be different for every instance of the associated item (element name).
    
    Specified by:
    
    isDynamic in interface ItemDefinition<T>
  - getSubstitutionHead
```
public QName getSubstitutionHead()
```
    Description copied from interface: ItemDefinition
    
    Returns the name of an element this one can be substituted for (e.g. c:user -> c:object, s:pipeline -> s:expression, etc). EXPERIMENTAL
    
    Specified by:
    
    getSubstitutionHead in interface ItemDefinition<T>
  - isHeterogeneousListItem
```
public boolean isHeterogeneousListItem()
```
    Description copied from interface: ItemDefinition
    
    Can be used in heterogeneous lists as a list item. EXPERIMENTAL.
    
    Specified by:
    
    isHeterogeneousListItem in interface ItemDefinition<T>
  - getValueEnumerationRef
```
public PrismReferenceValue getValueEnumerationRef()
```
    Description copied from interface: ItemDefinition
    
    Reference to an object that directly or indirectly represents possible values for this item. We do not define here what exactly the object has to be. It can be a lookup table, script that dynamically produces the values or anything similar. The object must produce the values of the correct type for this item otherwise an error occurs.
    
    Specified by:
    
    getValueEnumerationRef in interface ItemDefinition<T>
  - isValidFor
```
public boolean isValidFor(@NotNull
                          @NotNull QName elementQName,
                          @NotNull
                          @NotNull Class<? extends ItemDefinition<?>> clazz,
                          boolean caseInsensitive)
```
    Description copied from interface: ItemDefinition
    
    Returns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way. Used e.g. for "slow" path lookup where we iterate over all definitions in a complex type.
    
    Specified by:
    
    isValidFor in interface ItemDefinition<T>
  - adoptElementDefinitionFrom
```
public void adoptElementDefinitionFrom(ItemDefinition<?> otherDef)
```
    Description copied from interface: ItemDefinition
    
    Transfers selected parts of the definition (currently item name, min/max occurs) from another definition. TODO used only on few places, consider removing
    
    Specified by:
    
    adoptElementDefinitionFrom in interface ItemDefinition<T>
  - findItemDefinition
```
public <D extends ItemDefinition<?>> D findItemDefinition(@NotNull
                                                          @NotNull ItemPath path,
                                                          @NotNull
                                                          @NotNull Class<D> clazz)
```
    Description copied from interface: ItemDefinition
    
    Used to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.
    
    Specified by:
    
    findItemDefinition in interface ItemDefinition<T>
  - getMaxOccurs
```
public int getMaxOccurs(LayerType layer)
```
    Description copied from interface: ResourceAttributeDefinition
    
    Gets `maxOccurs` limitation for given layer.
    
    Specified by:
    
    getMaxOccurs in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ItemDefinition.getMaxOccurs()
  - getMinOccurs
```
public int getMinOccurs()
```
    Description copied from interface: ItemDefinition
    
    Return the number of minimal value occurrences.
    
    Specified by:
    
    getMinOccurs in interface ItemDefinition<T>
  - getMinOccurs
```
public int getMinOccurs(LayerType layer)
```
    Description copied from interface: ResourceAttributeDefinition
    
    Gets `minOccurs` limitation for given layer.
    
    Specified by:
    
    getMinOccurs in interface ResourceAttributeDefinition<T>
  - isExclusiveStrong
```
public boolean isExclusiveStrong()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Drives behavior of strong and normal mappings for this attribute.
    
    Specified by:
    
    isExclusiveStrong in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceItemDefinitionType.isExclusiveStrong()
  - getLimitations
```
public PropertyLimitations getLimitations(LayerType layer)
```
    Description copied from interface: ResourceAttributeDefinition
    
    Returns limitations (cardinality, access rights, processing) for given layer. These are obtained from resource and/or explicitly configured.
    
    Specified by:
    
    getLimitations in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ItemRefinedDefinitionType.getLimitations()
  - getHelp
```
public String getHelp()
```
    Description copied from interface: Definition
    
    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 Definition
    
    Returns:
    
    help string or catalog key
  - getDocumentation
```
public String getDocumentation()
```
    Specified by:
    
    getDocumentation in interface Definition
  - getDocumentationPreview
```
public String getDocumentationPreview()
```
    Description copied from interface: Definition
    
    Returns only a first sentence of documentation.
    
    Specified by:
    
    getDocumentationPreview 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
  - setAnnotation
```
public <A> void setAnnotation(QName qname,
                              A value)
```
    Specified by:
    
    setAnnotation in interface Definition
  - getAnnotations
```
@Nullable
public @Nullable 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
  - getSchemaMigrations
```
public List<SchemaMigration> getSchemaMigrations()
```
    Specified by:
    
    getSchemaMigrations in interface Definition
  - getDiagrams
```
public List<ItemDiagramSpecification> getDiagrams()
```
    Specified by:
    
    getDiagrams in interface Definition
  - getFetchStrategy
```
public AttributeFetchStrategyType getFetchStrategy()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Returns configured fetch strategy.
    
    Specified by:
    
    getFetchStrategy in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceItemDefinitionType.getFetchStrategy()
  - getStorageStrategy
```
@NotNull
public @NotNull AttributeStorageStrategyType getStorageStrategy()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Returns configured storage strategy.
    
    Specified by:
    
    getStorageStrategy in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceItemDefinitionType.getStorageStrategy()
  - getMatchingRuleQName
```
public QName getMatchingRuleQName()
```
    Description copied from interface: PrismPropertyDefinition
    
    Returns matching rule name. Matching rules are algorithms that specify how to compare, normalize and/or order the values. E.g. there are matching rules for case insensitive string comparison, for LDAP DNs, etc.
    
    Specified by:
    
    getMatchingRuleQName in interface PrismPropertyDefinition<T>
    
    Returns:
    
    matching rule name
  - createEmptyDelta
```
@NotNull
public @NotNull PropertyDelta<T> createEmptyDelta(ItemPath path)
```
    Description copied from interface: ItemDefinition
    
    Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
    
    Specified by:
    
    createEmptyDelta in interface ItemDefinition<T>
    
    Specified by:
    
    createEmptyDelta in interface PrismPropertyDefinition<T>
  - getTolerantValuePatterns
```
@NotNull
public @NotNull List<String> getTolerantValuePatterns()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Gets patterns for values that are "tolerated" on the resource.
    
    Specified by:
    
    getTolerantValuePatterns in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceAttributeDefinition.isTolerant(), ItemRefinedDefinitionType.getTolerantValuePattern()
  - getIntolerantValuePatterns
```
@NotNull
public @NotNull List<String> getIntolerantValuePatterns()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Gets patterns for values that are not "tolerated" on the resource.
    
    Specified by:
    
    getIntolerantValuePatterns in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceAttributeDefinition.isTolerant(), ItemRefinedDefinitionType.getIntolerantValuePattern()
  - isVolatilityTrigger
```
public boolean isVolatilityTrigger()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Is this attribute so-called volatility trigger, i.e. may its changes cause changes in other attributes?
    
    Specified by:
    
    isVolatilityTrigger in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceItemDefinitionType.isVolatilityTrigger()
  - toMutable
```
@NotNull
public @NotNull MutableRawResourceAttributeDefinition<T> toMutable()
```
    Description copied from interface: Definition
    
    Returns an interface to mutate this definition.
    
    Specified by:
    
    toMutable in interface Definition
    
    Specified by:
    
    toMutable in interface ItemDefinition<T>
    
    Specified by:
    
    toMutable in interface PrismPropertyDefinition<T>
    
    Specified by:
    
    toMutable in interface ResourceAttributeDefinition<T>
  - getTypeClass
```
public 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 PrismPropertyDefinition<T>
  - deepClone
```
public ResourceAttributeDefinition<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 ResourceAttributeDefinition<T>
  - revive
```
public void revive(PrismContext prismContext)
```
    Description copied from interface: Revivable
    
    TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
    
    Specified by:
    
    revive in interface Revivable
  - debugDumpShortToString
```
public void debugDumpShortToString(StringBuilder sb)
```
    Description copied from interface: ItemDefinition
    
    Used in debugDumping items. Does not need to have name in it as item already has it. Does not need to have class as that is just too much info that is almost anytime pretty obvious anyway.
    
    Specified by:
    
    debugDumpShortToString in interface ItemDefinition<T>
  - canBeDefinitionOf
```
public boolean canBeDefinitionOf(PrismProperty<T> item)
```
    Description copied from interface: ItemDefinition
    
    TODO document
    
    Specified by:
    
    canBeDefinitionOf in interface ItemDefinition<T>
  - canBeDefinitionOf
```
public boolean canBeDefinitionOf(PrismValue pvalue)
```
    Description copied from interface: ItemDefinition
    
    TODO document
    
    Specified by:
    
    canBeDefinitionOf in interface ItemDefinition<T>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDebugDumpClassName
```
public 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: ResourceAttributeDefinition
    
    Provides a debug dump respective to the given layer. TODO reconsider this method
    
    Specified by:
    
    debugDump in interface ResourceAttributeDefinition<T>
  - getModificationPriority
```
public Integer getModificationPriority()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Determines the order in which this attribute should be modified (in very special cases).
    
    Specified by:
    
    getModificationPriority in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceItemDefinitionType.getModificationPriority()
  - getReadReplaceMode
```
public Boolean getReadReplaceMode()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Should be this attribute modified solely in "replace" mode?
    
    Specified by:
    
    getReadReplaceMode in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceItemDefinitionType.isReadReplaceMode()
  - isDisplayNameAttribute
```
public boolean isDisplayNameAttribute()
```
    Description copied from interface: ResourceAttributeDefinition
    
    Is this attribute configured to serve as a display name?
    
    Specified by:
    
    isDisplayNameAttribute in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ResourceItemDefinitionType.isDisplayNameAttribute()
  - getCorrelatorDefinition
```
@Nullable
public @Nullable ItemCorrelatorDefinitionType getCorrelatorDefinition()
```
    Specified by:
    
    getCorrelatorDefinition in interface ResourceAttributeDefinition<T>
    
    See Also:
    
    ()
  - 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>
  - performFreeze
```
public void performFreeze()
```
    Overrides:
    
    performFreeze in class AbstractFreezable
  - getPrismContext
```
public PrismContext getPrismContext()
```
    Specified by:
    
    getPrismContext in interface PrismContextSensitive
  - accept
```
public boolean accept(Visitor<Definition> visitor,
                      SmartVisitation<Definition> visitation)
```
    Specified by:
    
    accept in interface SmartVisitable<T>
    
    Returns:
    
    false if we already was here
  - accept
```
public void accept(Visitor<Definition> visitor)
```
    Specified by:
    
    accept in interface Visitable<T>
  - spawnModifyingRaw
```
public ResourceAttributeDefinition<T> spawnModifyingRaw(@NotNull
                                                        @NotNull Consumer<MutableRawResourceAttributeDefinition<T>> rawPartCustomizer)
```
    Description copied from interface: ResourceAttributeDefinition
    
    Creates a copy of the definition, with a given customizer applied to the _raw_ part of the definition. Should be used only in special cases, near the resource schema construction time. (So various alternate implementations of this interface need not support this method.) May not preserve all information (like access override flags).
    
    Specified by:
    
    spawnModifyingRaw in interface ResourceAttributeDefinition<T>
  - 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

Class ResourceAttributeDefinitionImpl<T>

Nested Class Summary

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

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

Method Detail

create

create

create

forLayer

clone

isTolerant

isSecondaryIdentifierOverride

canAdd

canAdd

canRead

canRead

canModify

canModify

setOverrideCanRead

setOverrideCanAdd

setOverrideCanModify

isIgnored

isAbstract

isDeprecated

isExperimental

getPlannedRemoval

isElaborate

getDeprecatedSince

isEmphasized

getProcessing

getProcessing

getDisplayName

getDisplayOrder

getDescription

getRawAttributeDefinition

getOutboundMappingBean

getInboundMappingBeans

getItemName

getTypeName

isRuntimeSchema

getReturnedByDefault

getNativeAttributeName

getFrameworkAttributeName

instantiate

instantiate

getAllowedValues

getSuggestedValues

defaultValue

isIndexed

getMaxOccurs

isOperational

isIndexOnly

isInherited

isDynamic

getSubstitutionHead

isHeterogeneousListItem

getValueEnumerationRef

isValidFor

adoptElementDefinitionFrom

findItemDefinition

getMaxOccurs

getMinOccurs

getMinOccurs

isExclusiveStrong

getLimitations

getHelp

getDocumentation

getDocumentationPreview

getAnnotation