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

Interface ResourceObjectDefinitionDelegator

All Superinterfaces:

AbstractTypeDefinition, AssociationDefinitionStore, AttributeDefinitionStore, Cloneable, DebugDumpable, Definition, FrameworkNameResolver, Freezable, IdentifiersDefinitionStore, LayeredDefinition, LocalItemDefinitionStore, PrismLifecycleDefinition, PrismPresentationDefinition, ResourceObjectDefinition, ResourceObjectInboundDefinition, Revivable, SchemaLookup.Aware, Serializable, SmartVisitable<Definition>, TypeDefinition, Visitable<Definition>

All Known Subinterfaces:

CompositeObjectDefinitionDelegator, ResourceObjectClassDefinitionDelegator, ResourceObjectTypeDefinitionDelegator

public interface ResourceObjectDefinitionDelegator
extends ResourceObjectDefinition

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

ResourceObjectInboundDefinition.AssociationBasedItemImplementation, ResourceObjectInboundDefinition.AssociationSynchronizationImplementation, ResourceObjectInboundDefinition.EmptyImplementation, ResourceObjectInboundDefinition.FocusSpecification, ResourceObjectInboundDefinition.ItemInboundDefinition

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

TypeDefinition.TypeDefinitionLikeBuilder, TypeDefinition.TypeDefinitionMutator

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default AbstractShadow	createBlankShadowWithTag(String tag)	As ResourceObjectDefinition.createBlankShadow() but having the correct resource OID, kind/intent (if applicable), and tag set.
default @NotNull ObjectQuery	createShadowSearchQuery(String resourceOid)	Creates a query for obtaining shadows related to this object class or object type.
ResourceObjectDefinition	delegate()
default <T> ShadowSimpleAttributeDefinition<T>	findSimpleAttributeDefinition(String name)	Finds attribute definition using local name only.
default <T> @Nullable ShadowSimpleAttributeDefinition<T>	findSimpleAttributeDefinition(QName name, boolean caseInsensitive)	Finds a simple attribute definition by looking at the property name.
default @NotNull ResourceObjectDefinition	forLayerImmutable(@NotNull LayerType layer)	As ResourceObjectDefinition.forLayerMutable(LayerType) but returns immutable definition.
default @NotNull ResourceObjectDefinition	forLayerMutable(@NotNull LayerType layer)	Creates a layer-specific mutable version of this definition.
default ResourceActivationDefinitionType	getActivationSchemaHandling()
default ResourceBidirectionalMappingAndDefinitionType	getAuxiliaryObjectClassMappings()
default ResourceObjectReferenceType	getBaseContext()	The definition of base context (resource object container).
default @NotNull BasicResourceInformation	getBasicResourceInformation()	The basic information about the resource (like name, OID, selected configuration beans).
default @NotNull Collection<QName>	getConfiguredAuxiliaryObjectClassNames()	Returns the names of auxiliary object classes that are "statically" defined for this object type (or object class, in the future).
default CorrelationDefinitionType	getCorrelation()
default @NotNull LayerType	getCurrentLayer()	Gets the current point-of-view: on which layer do we look at the data?
default String	getDebugDumpClassName()	Return a human readable name of this class suitable for logs.
default @Nullable DefaultInboundMappingEvaluationPhasesType	getDefaultInboundMappingEvaluationPhases()	Returns the phases in which inbound mappings are evaluated by default.
default @NotNull ResourceObjectTypeDefinitionType	getDefinitionBean()	Returns the configuration bean for this object type or class.
default @NotNull ResourceObjectTypeDelineation	getDelineation()	Returns the delineation of the set of objects belonging to this object type.
default String	getDescription()	Free-form textual description of the object.
default ShadowSimpleAttributeDefinition<?>	getDescriptionAttribute()	Returns the definition of description attribute of a resource object.
default @Nullable QName	getDescriptionAttributeName()	Returns name of the description attribute.
default ShadowSimpleAttributeDefinition<?>	getDisplayNameAttribute()	Returns the definition of display name attribute.
default @Nullable QName	getDisplayNameAttributeName()	Returns name of the display name attribute.
default @NotNull ShadowCachingPolicyType	getEffectiveShadowCachingPolicy()	Returns shadow caching policy determined by the application of resource-level definitions down to the specific object type/class definition (using bean merging).
default <T extends CapabilityType> T	getEnabledCapability(@NotNull Class<T> capabilityClass, ResourceType resource)	Checks the presence of capability in: 1. resource object definition (applicable only to resource object _type_ definitions), 2. additional connectors in resource (only if enabled there), 3. the main connector.
default @NotNull ResourceObjectInboundDefinition.FocusSpecification	getFocusSpecification()
default String	getHumanReadableName()	TODO
default @Nullable ResourceLastLoginTimestampDefinitionType	getLastLoginTimestampDefinition()	See ResourceObjectTypeDefinitionType.getBehavior()
default @Nullable String	getLifecycleState()	What lifecycle state is the (refined) object class or object type definition?
default @Nullable QName	getNamingAttributeName()	Returns name of the naming attribute.
default @NotNull NativeObjectClassDefinition	getNativeObjectClassDefinition()	Returns the [structural] native object class definition, typically obtained from the connector.
default @NotNull ResourceObjectClassDefinition	getObjectClassDefinition()	Returns the [structural] object class definition.
default @NotNull QName	getObjectClassName()	Returns the name of the object class.
default ResourceObjectMultiplicityType	getObjectMultiplicity()
default @Nullable ResourcePasswordDefinitionType	getPasswordDefinition()	See ResourceObjectTypeDefinitionType.getCredentials()
default @NotNull Collection<? extends ShadowSimpleAttributeDefinition<?>>	getPrimaryIdentifiers()	Returns the definition of primary identifier attributes of a resource object.
default @NotNull Collection<QName>	getPrimaryIdentifiersNames()	Returns names of primary identifiers.
default PrismObjectDefinition<ShadowType>	getPrismObjectDefinition()	Returns a prism definition for the prism object/objects carrying the resource object/objects.
default ProjectionPolicyType	getProjectionPolicy()
default @NotNull List<? extends ShadowReferenceAttributeDefinition>	getReferenceAttributeDefinitions()	Returns definitions of all associations as an unmodifiable collection.
default ResourceObjectInboundDefinition.ItemInboundDefinition	getReferenceAttributeInboundDefinition(ItemName itemName)
default SearchHierarchyScope	getSearchHierarchyScope()	Definition of search hierarchy scope.
default @NotNull Collection<? extends ShadowSimpleAttributeDefinition<?>>	getSecondaryIdentifiers()	Returns the definition of secondary identifier attributes of a resource object.
default @NotNull Collection<QName>	getSecondaryIdentifiersNames()	Returns names of secondary identifiers.
default ObjectReferenceType	getSecurityPolicyRef()
default @NotNull ShadowMarkingRules	getShadowMarkingRules()	Returns compiled patterns denoting protected objects or other kinds of marks.
default @NotNull String	getShortIdentification()	Very short identification, like the object class local name or the kind/intent pair.
default @NotNull List<? extends ShadowSimpleAttributeDefinition<?>>	getSimpleAttributeDefinitions()
default ResourceObjectInboundDefinition.ItemInboundDefinition	getSimpleAttributeInboundDefinition(ItemName itemName)
default @NotNull Collection<? extends SynchronizationReactionDefinition>	getSynchronizationReactions()
default @Nullable ResourceObjectTypeDefinition	getTypeDefinition()	Is this definition bound to a specific resource type?
default @Nullable ResourceObjectTypeIdentification	getTypeIdentification()	Is this definition bound to a specific resource type?
default @NotNull ResourceObjectVolatilityType	getVolatility()	Specifies volatility of this type of resource objects, i.e. whether such an object can change when midPoint is not looking.
default boolean	hasAuxiliaryObjectClass(QName expectedObjectClassName)	TODO define semantics (it's different for CompositeObjectDefinition and the others!
default boolean	isDefaultFor(@NotNull ShadowKindType kind)	Returns true if this definition can be considered as a default for the specified kind.
default boolean	isPrimaryIdentifier(QName attrName)	Returns true if the attribute with a given name is among primary identifiers.
default boolean	isSecondaryIdentifier(QName attrName)	Returns true if the attribute with a given name is among secondary identifiers.
default void	replaceAttributeDefinition(@NotNull QName itemName, @Nullable ItemDefinition<?> newDefinition)	Replaces a definition for given item name with a provided one.
default @Nullable ItemName	resolveFrameworkName(@NotNull String frameworkName)	Resolves framework-specific name (like `__NAME__`) to midPoint name (like `ri:dn`), if available.
default void	validate()	Executes some basic checks on this object type.

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

getTypeName

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

findAssociationDefinition, findAssociationDefinitionRequired, findAssociationDefinitionRequired, getAssociationDefinitions, getNamesOfAssociations

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

containsAttributeDefinition, findAttributeDefinition, findAttributeDefinition, findAttributeDefinitionRequired, findAttributeDefinitionRequired, findAttributeDefinitionStrictlyRequired, findAttributeDefinitionStrictlyRequired, findReferenceAttributeDefinitionRequired, findReferenceAttributeDefinitionRequired, findShadowAttributeDefinitionRequired, findSimpleAttributeDefinition, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionStrictlyRequired, findSimpleAttributeDefinitionStrictlyRequired, getAllSimpleAttributesNames, getAttributeDefinitions, getAttributeDefinitions, getAttributeNames, getReferenceAttributesNames, hasIndexOnlyAttributes, instantiateAttribute

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

checkMutableOnExposing, debugDump, getAnnotation, getAnnotations, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, getSchemaContextDefinition, getTypeClass, getTypeName, isAbstract, isElaborate, isOptionalCleanup, isRuntimeSchema, mutator

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

checkImmutable, checkMutable, freeze, isImmutable

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

getAllIdentifiers, getAllIdentifiersNames, getPrimaryIdentifierRequired, getSecondaryIdentifierRequired, isIdentifier

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

containsItemDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition, getDefinitions

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

getDeprecatedSince, getPlannedRemoval, getRemovedSince, getSchemaMigrations, isDeprecated, isExperimental, isRemoved

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

getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, isEmphasized

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

areCredentialsCached, areCredentialsCachedLegacy, assertAttached, canRepresent, clone, composite, createBlankShadow, createBlankShadowWithPrimaryId, createPrimaryIdentification, deepClone, findReferenceAttributeDefinition, getActivationBidirectionalMappingType, getActivationFetchStrategy, getAssociationDefinitionsFor, getAssociationsComplexTypeDefinition, getAttributesComplexTypeDefinition, getAttributesVolatileOnAddOperation, getAttributesVolatileOnModifyOperation, getAuxiliaryDefinitions, getCompileTimeClass, getDefaultOperationPolicyOid, getIdentification, getInstantiationOrder, getLastLoginTimestampFetchStrategy, getNamingAttribute, getObjectClassLocalName, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, getReferenceAttributesComplexTypeDefinition, getResourceOid, getSimpleAttributesComplexTypeDefinition, getStaticSubTypes, getSuperType, isActivationCached, isAuxiliaryObjectClassPropertyCached, isCachingEnabled, isEffectivelyCached, matchesObjectClassName, queryFor, replaceAttributeDefinition, toPrismObjectDefinition, toShadowAssociationsContainerDefinition, toShadowAttributesContainerDefinition, trimAttributesTo

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

getAttributeDefinitions

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

revive

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

schemaLookup

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

accept

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

isAssignableFrom

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

accept

Method Details

delegate

ResourceObjectDefinition delegate()

getBasicResourceInformation

@NotNull
default @NotNull BasicResourceInformation getBasicResourceInformation()

Description copied from interface: ResourceObjectDefinition

The basic information about the resource (like name, OID, selected configuration beans). Replaces the hard-coded resource OID; necessary also for determination of default values for some features, e.g., shadow caching, and useful for diagnostics.

Specified by:

getBasicResourceInformation in interface ResourceObjectDefinition

getSimpleAttributeDefinitions

@NotNull
default @NotNull List<? extends ShadowSimpleAttributeDefinition<?>> getSimpleAttributeDefinitions()

Specified by:

getSimpleAttributeDefinitions in interface AttributeDefinitionStore

findSimpleAttributeDefinition

@Nullable
default <T>
@Nullable ShadowSimpleAttributeDefinition<T> findSimpleAttributeDefinition(QName name,
 boolean caseInsensitive)

Description copied from interface: AttributeDefinitionStore

Finds a simple attribute definition by looking at the property name. Returns null if nothing is found.

Specified by:

findSimpleAttributeDefinition in interface AttributeDefinitionStore

Parameters:

name - property definition name

caseInsensitive - if true, ignoring the case

Returns:

found property definition or null

findSimpleAttributeDefinition

default <T> ShadowSimpleAttributeDefinition<T> findSimpleAttributeDefinition(String name)

Description copied from interface: AttributeDefinitionStore

Finds attribute definition using local name only. BEWARE: Ignores attributes in namespaces other than "ri:" (e.g. icfs:uid and icfs:name).

Specified by:

findSimpleAttributeDefinition in interface AttributeDefinitionStore

getPrimaryIdentifiers

@NotNull
default @NotNull Collection<? extends ShadowSimpleAttributeDefinition<?>> getPrimaryIdentifiers()

Description copied from interface: IdentifiersDefinitionStore

Returns the definition of primary identifier attributes of a resource object. May return empty set if there are no identifier attributes. Must not return null. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.

Specified by:

getPrimaryIdentifiers in interface IdentifiersDefinitionStore

Returns:

definition of identifier attributes

isPrimaryIdentifier

default boolean isPrimaryIdentifier(QName attrName)

Description copied from interface: IdentifiersDefinitionStore

Returns true if the attribute with a given name is among primary identifiers. Matching is done using namespace-approximate method (testing only local part if no namespace is provided), so beware of incidental matching (e.g. ri:uid vs icfs:uid).

Specified by:

isPrimaryIdentifier in interface IdentifiersDefinitionStore

getSecondaryIdentifiers

@NotNull
default @NotNull Collection<? extends ShadowSimpleAttributeDefinition<?>> getSecondaryIdentifiers()

Description copied from interface: IdentifiersDefinitionStore

Returns the definition of secondary identifier attributes of a resource object. May return empty set if there are no secondary identifier attributes. Must not return null. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.

Specified by:

getSecondaryIdentifiers in interface IdentifiersDefinitionStore

Returns:

definition of secondary identifier attributes

isSecondaryIdentifier

default boolean isSecondaryIdentifier(QName attrName)

Description copied from interface: IdentifiersDefinitionStore

Returns true if the attribute with a given name is among secondary identifiers. Matching is done using namespace-approximate method (testing only local part if no namespace is provided), so beware of incidental matching (e.g. ri:uid vs icfs:uid).

Specified by:

isSecondaryIdentifier in interface IdentifiersDefinitionStore

getDescriptionAttribute

default ShadowSimpleAttributeDefinition<?> getDescriptionAttribute()

Description copied from interface: ResourceObjectDefinition

Returns the definition of description attribute of a resource object. Returns null if there is no description attribute. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing. NOTE: Currently seems to be not used. (Neither not set nor used.)

Specified by:

getDescriptionAttribute in interface ResourceObjectDefinition

getDisplayNameAttribute

default ShadowSimpleAttributeDefinition<?> getDisplayNameAttribute()

Description copied from interface: ResourceObjectDefinition

Returns the definition of display name attribute. Display name attribute specifies which resource attribute should be used as title when displaying objects of a specific resource object class. It must point to an attribute of String type. If not present, primary identifier should be used instead (but this method does not handle this default behavior). Returns null if there is no display name attribute. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing. NOTE: Currently seems to be not used. (Neither not set nor used.)

Specified by:

getDisplayNameAttribute in interface ResourceObjectDefinition

getPrismObjectDefinition

default PrismObjectDefinition<ShadowType> getPrismObjectDefinition()

Description copied from interface: ResourceObjectDefinition

Returns a prism definition for the prism object/objects carrying the resource object/objects.

Specified by:

getPrismObjectDefinition in interface ResourceObjectDefinition

getPasswordDefinition

@Nullable
default @Nullable ResourcePasswordDefinitionType getPasswordDefinition()

Description copied from interface: ResourceObjectDefinition

See ResourceObjectTypeDefinitionType.getCredentials()

Specified by:

getPasswordDefinition in interface ResourceObjectDefinition

getLastLoginTimestampDefinition

@Nullable
default @Nullable ResourceLastLoginTimestampDefinitionType getLastLoginTimestampDefinition()

Description copied from interface: ResourceObjectDefinition

See ResourceObjectTypeDefinitionType.getBehavior()

Specified by:

getLastLoginTimestampDefinition in interface ResourceObjectDefinition

getObjectClassDefinition

@NotNull
default @NotNull ResourceObjectClassDefinition getObjectClassDefinition()

Description copied from interface: ResourceObjectDefinition

Returns the [structural] object class definition.

Specified by:

getObjectClassDefinition in interface ResourceObjectDefinition

getObjectClassName

@NotNull
default @NotNull QName getObjectClassName()

Description copied from interface: ResourceObjectDefinition

Returns the name of the object class. Always fully qualified; currently with the SchemaConstants.NS_RI namespace.

Specified by:

getObjectClassName in interface ResourceObjectDefinition

getDescriptionAttributeName

@Nullable
default @Nullable QName getDescriptionAttributeName()

Description copied from interface: ResourceObjectDefinition

Returns name of the description attribute.

Specified by:

getDescriptionAttributeName in interface ResourceObjectDefinition

See Also:

• ResourceObjectDefinition.getDescriptionAttribute()

getNamingAttributeName

@Nullable
default @Nullable QName getNamingAttributeName()

Description copied from interface: ResourceObjectDefinition

Returns name of the naming attribute.

Specified by:

getNamingAttributeName in interface ResourceObjectDefinition

See Also:

• ResourceObjectDefinition.getNamingAttributeName()

getDisplayNameAttributeName

@Nullable
default @Nullable QName getDisplayNameAttributeName()

Description copied from interface: ResourceObjectDefinition

Returns name of the display name attribute.

Specified by:

getDisplayNameAttributeName in interface ResourceObjectDefinition

createBlankShadowWithTag

default AbstractShadow createBlankShadowWithTag(String tag)

Description copied from interface: ResourceObjectDefinition

As ResourceObjectDefinition.createBlankShadow() but having the correct resource OID, kind/intent (if applicable), and tag set.

Specified by:

createBlankShadowWithTag in interface ResourceObjectDefinition

getEnabledCapability

default <T extends CapabilityType> T getEnabledCapability(@NotNull
 @NotNull Class<T> capabilityClass,
 ResourceType resource)

Description copied from interface: ResourceObjectDefinition

Checks the presence of capability in: 1. resource object definition (applicable only to resource object _type_ definitions), 2. additional connectors in resource (only if enabled there), 3. the main connector. Returns the present capability, but only if it's enabled.

Specified by:

getEnabledCapability in interface ResourceObjectDefinition

getHumanReadableName

default String getHumanReadableName()

Description copied from interface: ResourceObjectDefinition

TODO

Specified by:

getHumanReadableName in interface ResourceObjectDefinition

getReferenceAttributeDefinitions

@NotNull
default @NotNull List<? extends ShadowReferenceAttributeDefinition> getReferenceAttributeDefinitions()

Description copied from interface: AttributeDefinitionStore

Returns definitions of all associations as an unmodifiable collection. Note: these items are _not_ included in getDefinitions. (BTW, ResourceAssociationDefinition is not a subtype of ItemDefinition, not even of Definition.)

Specified by:

getReferenceAttributeDefinitions in interface AttributeDefinitionStore

Specified by:

getReferenceAttributeDefinitions in interface ResourceObjectDefinition

getPrimaryIdentifiersNames

@NotNull
default @NotNull Collection<QName> getPrimaryIdentifiersNames()

Description copied from interface: IdentifiersDefinitionStore

Returns names of primary identifiers.

Specified by:

getPrimaryIdentifiersNames in interface IdentifiersDefinitionStore

See Also:

• IdentifiersDefinitionStore.getPrimaryIdentifiers()

getSecondaryIdentifiersNames

@NotNull
default @NotNull Collection<QName> getSecondaryIdentifiersNames()

Description copied from interface: IdentifiersDefinitionStore

Returns names of secondary identifiers.

Specified by:

getSecondaryIdentifiersNames in interface IdentifiersDefinitionStore

See Also:

• ()

getDebugDumpClassName

default String getDebugDumpClassName()

Description copied from interface: ResourceObjectDefinition

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

Specified by:

getDebugDumpClassName in interface ResourceObjectDefinition

forLayerMutable

@NotNull
default @NotNull ResourceObjectDefinition forLayerMutable(@NotNull
 @NotNull LayerType layer)

Description copied from interface: ResourceObjectDefinition

Creates a layer-specific mutable version of this definition.

Specified by:

forLayerMutable in interface ResourceObjectDefinition

forLayerImmutable

@NotNull
default @NotNull ResourceObjectDefinition forLayerImmutable(@NotNull
 @NotNull LayerType layer)

Description copied from interface: ResourceObjectDefinition

As ResourceObjectDefinition.forLayerMutable(LayerType) but returns immutable definition.

Specified by:

forLayerImmutable in interface ResourceObjectDefinition

getSecurityPolicyRef

default ObjectReferenceType getSecurityPolicyRef()

Specified by:

getSecurityPolicyRef in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getSecurityPolicyRef()

replaceAttributeDefinition

default void replaceAttributeDefinition(@NotNull
 @NotNull QName itemName,
 @Nullable
 @Nullable ItemDefinition<?> newDefinition)

Description copied from interface: ResourceObjectDefinition

Replaces a definition for given item name with a provided one.

Specified by:

replaceAttributeDefinition in interface ResourceObjectDefinition

getCurrentLayer

@NotNull
default @NotNull LayerType getCurrentLayer()

Description copied from interface: LayeredDefinition

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

Specified by:

getCurrentLayer in interface LayeredDefinition

getDescription

default String getDescription()

Description copied from interface: ResourceObjectDefinition

Free-form textual description of the object. It is supposed to describe the object or a construct that it is attached to.

Specified by:

getDescription in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getDescription()

getObjectMultiplicity

default ResourceObjectMultiplicityType getObjectMultiplicity()

Specified by:

getObjectMultiplicity in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getMultiplicity()

getProjectionPolicy

default ProjectionPolicyType getProjectionPolicy()

Specified by:

getProjectionPolicy in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getProjection()

hasAuxiliaryObjectClass

default boolean hasAuxiliaryObjectClass(QName expectedObjectClassName)

Description copied from interface: ResourceObjectDefinition

TODO define semantics (it's different for CompositeObjectDefinition and the others!

Specified by:

hasAuxiliaryObjectClass in interface ResourceObjectDefinition

getAuxiliaryObjectClassMappings

default ResourceBidirectionalMappingAndDefinitionType getAuxiliaryObjectClassMappings()

Specified by:

getAuxiliaryObjectClassMappings in interface ResourceObjectDefinition

Specified by:

getAuxiliaryObjectClassMappings in interface ResourceObjectInboundDefinition

See Also:

• ResourceObjectTypeDefinitionType.getAuxiliaryObjectClassMappings()

getShadowMarkingRules

@NotNull
default @NotNull ShadowMarkingRules getShadowMarkingRules()

Description copied from interface: ResourceObjectDefinition

Returns compiled patterns denoting protected objects or other kinds of marks. Use only in the parsed state.

Specified by:

getShadowMarkingRules in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getProtected()
• ResourceObjectTypeDefinitionType.getMarking()

getActivationSchemaHandling

default ResourceActivationDefinitionType getActivationSchemaHandling()

Specified by:

getActivationSchemaHandling in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getActivation()

getDelineation

@NotNull
default @NotNull ResourceObjectTypeDelineation getDelineation()

Description copied from interface: ResourceObjectDefinition

Returns the delineation of the set of objects belonging to this object type. Note that this tells only about information stored right in the definition bean, i.e. legacy configuration is not provided here. The complete picture is provided by SynchronizationPolicy.getDelineation().

Specified by:

getDelineation in interface ResourceObjectDefinition

getBaseContext

default ResourceObjectReferenceType getBaseContext()

Description copied from interface: ResourceObjectDefinition

The definition of base context (resource object container). This object will be used as a base for searches for objects of this type.

Specified by:

getBaseContext in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getBaseContext()

getSearchHierarchyScope

default SearchHierarchyScope getSearchHierarchyScope()

Description copied from interface: ResourceObjectDefinition

Definition of search hierarchy scope. It specifies how "deep" the search should go into the object hierarchy.

Specified by:

getSearchHierarchyScope in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getSearchHierarchyScope()

getVolatility

@NotNull
default @NotNull ResourceObjectVolatilityType getVolatility()

Description copied from interface: ResourceObjectDefinition

Specifies volatility of this type of resource objects, i.e. whether such an object can change when midPoint is not looking.

Specified by:

getVolatility in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getVolatility()

getDefaultInboundMappingEvaluationPhases

@Nullable
default @Nullable DefaultInboundMappingEvaluationPhasesType getDefaultInboundMappingEvaluationPhases()

Description copied from interface: ResourceObjectDefinition

Returns the phases in which inbound mappings are evaluated by default.

Specified by:

getDefaultInboundMappingEvaluationPhases in interface ResourceObjectDefinition

Specified by:

getDefaultInboundMappingEvaluationPhases in interface ResourceObjectInboundDefinition

See Also:

• ResourceObjectTypeDefinitionType.getMappingsEvaluation()

getLifecycleState

@Nullable
default @Nullable String getLifecycleState()

Description copied from interface: ResourceObjectDefinition

What lifecycle state is the (refined) object class or object type definition? Raw object class definition should always return `null` here.

Specified by:

getLifecycleState in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getLifecycleState()

getConfiguredAuxiliaryObjectClassNames

@NotNull
default @NotNull Collection<QName> getConfiguredAuxiliaryObjectClassNames()

Description copied from interface: ResourceObjectDefinition

Returns the names of auxiliary object classes that are "statically" defined for this object type (or object class, in the future). For dynamically composed definitions (CompositeObjectDefinition only the statically-defined ones (i.e. those from the structural definition) are returned.

Specified by:

getConfiguredAuxiliaryObjectClassNames in interface ResourceObjectDefinition

validate

default void validate()
               throws SchemaException

Description copied from interface: ResourceObjectDefinition

Executes some basic checks on this object type. Moved from `validateObjectClassDefinition()` method in ResourceTypeUtil. TODO review this method

Specified by:

validate in interface ResourceObjectDefinition

Throws:

SchemaException

getDefinitionBean

@NotNull
default @NotNull ResourceObjectTypeDefinitionType getDefinitionBean()

Description copied from interface: ResourceObjectDefinition

Returns the configuration bean for this object type or class.

Specified by:

getDefinitionBean in interface ResourceObjectDefinition

getNativeObjectClassDefinition

@NotNull
default @NotNull NativeObjectClassDefinition getNativeObjectClassDefinition()

Description copied from interface: ResourceObjectDefinition

Returns the [structural] native object class definition, typically obtained from the connector.

Specified by:

getNativeObjectClassDefinition in interface ResourceObjectDefinition

createShadowSearchQuery

@NotNull
default @NotNull ObjectQuery createShadowSearchQuery(String resourceOid)

Description copied from interface: ResourceObjectDefinition

Creates a query for obtaining shadows related to this object class or object type. The current implementations return either: - a combination of resource OID + object class name, or - a combination of resource OID + kind + intent.

Specified by:

createShadowSearchQuery in interface ResourceObjectDefinition

getTypeIdentification

@Nullable
default @Nullable ResourceObjectTypeIdentification getTypeIdentification()

Description copied from interface: ResourceObjectDefinition

Is this definition bound to a specific resource type? If yes, this method returns its identification.

Specified by:

getTypeIdentification in interface ResourceObjectDefinition

getTypeDefinition

@Nullable
default @Nullable ResourceObjectTypeDefinition getTypeDefinition()

Description copied from interface: ResourceObjectDefinition

Is this definition bound to a specific resource type? If yes, this method returns its definition.

Specified by:

getTypeDefinition in interface ResourceObjectDefinition

isDefaultFor

default boolean isDefaultFor(@NotNull
 @NotNull ShadowKindType kind)

Description copied from interface: ResourceObjectDefinition

Returns true if this definition can be considered as a default for the specified kind. Normally, for a type definition it means that it is marked as "default for a kind" and has the specified kind. But there is a special case of ResourceObjectClassDefinition with ResourceObjectClassDefinition.isDefaultAccountDefinition() being `true`. It is considered to be the default for ShadowKindType.ACCOUNT. Use with care!

Specified by:

isDefaultFor in interface ResourceObjectDefinition

getEffectiveShadowCachingPolicy

@NotNull
default @NotNull ShadowCachingPolicyType getEffectiveShadowCachingPolicy()

Description copied from interface: ResourceObjectDefinition

Returns shadow caching policy determined by the application of resource-level definitions down to the specific object type/class definition (using bean merging). The returned value has all the defaults applied. Throws an exception for unattached raw object class definitions.

Specified by:

getEffectiveShadowCachingPolicy in interface ResourceObjectDefinition

getShortIdentification

@NotNull
default @NotNull String getShortIdentification()

Description copied from interface: ResourceObjectDefinition

Very short identification, like the object class local name or the kind/intent pair.

Specified by:

getShortIdentification in interface ResourceObjectDefinition

resolveFrameworkName

@Nullable
default @Nullable ItemName resolveFrameworkName(@NotNull
 @NotNull String frameworkName)

Description copied from interface: FrameworkNameResolver

Resolves framework-specific name (like `__NAME__`) to midPoint name (like `ri:dn`), if available.

Specified by:

resolveFrameworkName in interface FrameworkNameResolver

getSimpleAttributeInboundDefinition

default ResourceObjectInboundDefinition.ItemInboundDefinition getSimpleAttributeInboundDefinition(ItemName itemName)
                                                                                           throws SchemaException

Specified by:

getSimpleAttributeInboundDefinition in interface ResourceObjectInboundDefinition

Throws:

SchemaException

getReferenceAttributeInboundDefinition

default ResourceObjectInboundDefinition.ItemInboundDefinition getReferenceAttributeInboundDefinition(ItemName itemName)
                                                                                              throws SchemaException

Specified by:

getReferenceAttributeInboundDefinition in interface ResourceObjectInboundDefinition

Throws:

SchemaException

getFocusSpecification

@NotNull
default @NotNull ResourceObjectInboundDefinition.FocusSpecification getFocusSpecification()

Specified by:

getFocusSpecification in interface ResourceObjectInboundDefinition

getSynchronizationReactions

@NotNull
default @NotNull Collection<? extends SynchronizationReactionDefinition> getSynchronizationReactions()

Specified by:

getSynchronizationReactions in interface ResourceObjectInboundDefinition

getCorrelation

default CorrelationDefinitionType getCorrelation()

Specified by:

getCorrelation in interface ResourceObjectInboundDefinition