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

Interface ResourceObjectDefinitionDelegator

All Superinterfaces:

AssociationDefinitionStore, AttributeDefinitionStore, Cloneable, ComplexTypeDefinition, ComplexTypeDefinitionDelegator, DebugDumpable, Definition, DefinitionDelegator, Freezable, IdentifiersDefinitionStore, LayeredDefinition, LocalItemDefinitionStore, PrismContextSensitive, ResourceObjectDefinition, Revivable, Serializable, SmartVisitable<Definition>, TypeDefinition, TypeDefinitionDelegator, Visitable<Definition>

All Known Subinterfaces:

CompositeObjectDefinitionDelegator, ResourceObjectClassDefinitionDelegator, ResourceObjectTypeDefinitionDelegator

All Known Implementing Classes:

TransformableComplexTypeDefinition.TrCompositeObjectDefinition, TransformableComplexTypeDefinition.TrResourceObjectClassDefinition, TransformableComplexTypeDefinition.TrResourceObjectDefinition, TransformableComplexTypeDefinition.TrResourceObjectTypeDefinition

public interface ResourceObjectDefinitionDelegator
extends ComplexTypeDefinitionDelegator, ResourceObjectDefinition

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default PrismObject<ShadowType>	createBlankShadow(String resourceOid, String tag)	Creates a blank ShadowType object, with the attributes container having appropriate definition.
default @NotNull ObjectQuery	createShadowSearchQuery(String resourceOid)	Creates a query for obtaining shadows related to this object class or object type.
ResourceObjectDefinition	delegate()
default ResourceAttributeDefinition<?>	findAttributeDefinition(String name)	Finds attribute definition using local name only.
default @Nullable ResourceAttributeDefinition<?>	findAttributeDefinition(QName name, boolean caseInsensitive)	Finds a 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 @NotNull Collection<ResourceAssociationDefinition>	getAssociationDefinitions()	Returns definitions of all associations as an unmodifiable collection.
default @NotNull List<? extends ResourceAttributeDefinition<?>>	getAttributeDefinitions()	Returns all attribute definitions as an unmodifiable collection.
default ResourceBidirectionalMappingAndDefinitionType	getAuxiliaryObjectClassMappings()
default ResourceObjectReferenceType	getBaseContext()	The definition of base context (resource object container).
default 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 @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 "raw" configuration bean for this object type.
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 ResourceAttributeDefinition<?>	getDescriptionAttribute()	Returns the definition of description attribute of a resource object.
default @Nullable QName	getDescriptionAttributeName()	Returns name of the description attribute.
default ResourceAttributeDefinition<?>	getDisplayNameAttribute()	Returns the definition of display name attribute.
default @Nullable QName	getDisplayNameAttributeName()	Returns name of the display name attribute.
default <T extends CapabilityType> T	getEnabledCapability(@NotNull Class<T> capabilityClass, ResourceType resource)	Checks the presence of capability in: 1.
default String	getHumanReadableName()	TODO
default @Nullable String	getLifecycleState()	What lifecycle state is the (refined) object class or object type definition? Raw object class definition should always return `null` here.
default ResourceAttributeDefinition<?>	getNamingAttribute()	Returns the attribute used as a visible name of the resource object.
default @Nullable QName	getNamingAttributeName()	Returns name of the naming attribute.
default @NotNull ResourceObjectClassDefinition	getObjectClassDefinition()	Returns the (raw or refined) 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 ResourceAttributeDefinition<?>>	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 Collection<ResourceObjectPattern>	getProtectedObjectPatterns()	Returns compiled patterns denoting protected objects.
default @NotNull ResourceObjectClassDefinition	getRawObjectClassDefinition()	Returns the raw object class definition.
default String	getResourceOid()	This is currently used only to pass information about association in the model-impl TODO consider removal!
default SearchHierarchyScope	getSearchHierarchyScope()	Definition of search hierarchy scope.
default @NotNull Collection<? extends ResourceAttributeDefinition<?>>	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 @Nullable ResourceObjectTypeDefinition	getTypeDefinition()	Is this definition bound to a specific resource type? If yes, this method returns its definition.
default @Nullable ResourceObjectTypeIdentification	getTypeIdentification()	Is this definition bound to a specific resource type? If yes, this method returns its identification.
default @NotNull ResourceObjectVolatilityType	getVolatility()	Specifies volatility of this type of resource objects, i.e.
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	replaceDefinition(@NotNull QName itemName, @Nullable ItemDefinition<?> newDefinition)	Replaces a definition for given item name with a provided one.
default ResourceAttributeContainerDefinition	toResourceAttributeContainerDefinition()	Creates ResourceAttributeContainerDefinition with this definition as a complex type definition.
default ResourceAttributeContainerDefinition	toResourceAttributeContainerDefinition(QName elementName)	Creates ResourceAttributeContainerDefinition (with given item name) with this definition as a complex type definition.
default void	validate()	Executes some basic checks on this object type.

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

findAssociationDefinition, findAssociationDefinitionRequired, getAssociationDefinitions, getNamesOfAssociations, getNamesOfAssociationsWithInboundExpressions, getNamesOfAssociationsWithOutboundExpressions

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

containsAttributeDefinition, findAttributeDefinition, findAttributeDefinitionRequired, findAttributeDefinitionRequired, findAttributeDefinitionStrictlyRequired, findAttributeDefinitionStrictlyRequired, getAttributeDefinitions, getNamesOfAttributesWithInboundExpressions, getNamesOfAttributesWithOutboundExpressions, hasIndexOnlyAttributes, propertyToAttribute

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

getXmlAttributeDefinitions, hasSubstitutions, isItemDefinitionRemoved, isStrictAnyMarker, toMutable

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

findContainerDefinition, findItemDefinition, findItemDefinition, findReferenceDefinition, getDefaultNamespace, getDefinitions, getDiagrams, getExtensionForType, getIgnoredNamespaces, hasOperationalOnlyItems, hasSubstitutions, isContainerMarker, isEmpty, isListMarker, isObjectMarker, isReferenceMarker, isXsdAnyMarker, itemOrSubstitution, merge, substitution, trimTo

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

accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getPrismContext, getProcessing, getRemovedSince, getSchemaMigrations, getSchemaRegistry, getTypeClass, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRemoved, isRuntimeSchema, setAnnotation

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

checkImmutable, checkMutable, freeze, isImmutable

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

getAllIdentifiers, getPrimaryIdentifierRequired, isIdentifier

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

containsItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition

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

clone, deepClone, getActivationBidirectionalMappingType, getActivationFetchStrategy, getAuxiliaryDefinitions, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, instantiate, matchesObjectClassName, replaceDefinition

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

revive

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

isAssignableFrom

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

canRepresent, getCompileTimeClass, getInstantiationOrder, getStaticSubTypes, getSuperType

Method Details

delegate

ResourceObjectDefinition delegate()

Specified by:

delegate in interface ComplexTypeDefinitionDelegator

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface TypeDefinitionDelegator

getAttributeDefinitions

@NotNull
default @NotNull List<? extends ResourceAttributeDefinition<?>> getAttributeDefinitions()

Description copied from interface: AttributeDefinitionStore

Returns all attribute definitions as an unmodifiable collection. Should be the same content as returned by `getDefinitions`. The returned value is a List because of the contract of ComplexTypeDefinition.getDefinitions().

Specified by:

getAttributeDefinitions in interface AttributeDefinitionStore

findAttributeDefinition

@Nullable
default @Nullable ResourceAttributeDefinition<?> findAttributeDefinition(QName name,
 boolean caseInsensitive)

Description copied from interface: AttributeDefinitionStore

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

Specified by:

findAttributeDefinition in interface AttributeDefinitionStore

Parameters:

name - property definition name

caseInsensitive - if true, ignoring the case

Returns:

found property definition or null

findAttributeDefinition

default ResourceAttributeDefinition<?> findAttributeDefinition(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:

findAttributeDefinition in interface AttributeDefinitionStore

getPrimaryIdentifiers

@NotNull
default @NotNull Collection<? extends ResourceAttributeDefinition<?>> 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 ResourceAttributeDefinition<?>> 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 ResourceAttributeDefinition<?> 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

getNamingAttribute

default ResourceAttributeDefinition<?> getNamingAttribute()

Description copied from interface: ResourceObjectDefinition

Returns the attribute used as a visible name of the resource object.

Specified by:

getNamingAttribute in interface ResourceObjectDefinition

getDisplayNameAttribute

default ResourceAttributeDefinition<?> 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

toResourceAttributeContainerDefinition

default ResourceAttributeContainerDefinition toResourceAttributeContainerDefinition()

Description copied from interface: ResourceObjectDefinition

Creates ResourceAttributeContainerDefinition with this definition as a complex type definition.

Specified by:

toResourceAttributeContainerDefinition in interface ResourceObjectDefinition

toResourceAttributeContainerDefinition

default ResourceAttributeContainerDefinition toResourceAttributeContainerDefinition(QName elementName)

Description copied from interface: ResourceObjectDefinition

Creates ResourceAttributeContainerDefinition (with given item name) with this definition as a complex type definition.

Specified by:

toResourceAttributeContainerDefinition 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

getObjectClassDefinition

@NotNull
default @NotNull ResourceObjectClassDefinition getObjectClassDefinition()

Description copied from interface: ResourceObjectDefinition

Returns the (raw or refined) object class definition. It is either this object itself (for object classes), or the linked object class definition (for object types).

Specified by:

getObjectClassDefinition in interface ResourceObjectDefinition

getObjectClassName

@NotNull
default @NotNull QName getObjectClassName()

Description copied from interface: ResourceObjectDefinition

Returns the name of the object class.

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

See Also:

• ResourceObjectDefinition.getDisplayNameAttribute()

createBlankShadow

default PrismObject<ShadowType> createBlankShadow(String resourceOid,
 String tag)

Description copied from interface: ResourceObjectDefinition

Creates a blank ShadowType object, with the attributes container having appropriate definition.

Specified by:

createBlankShadow 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

getAssociationDefinitions

@NotNull
default @NotNull Collection<ResourceAssociationDefinition> getAssociationDefinitions()

Description copied from interface: AssociationDefinitionStore

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:

getAssociationDefinitions in interface AssociationDefinitionStore

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

replaceDefinition

default void replaceDefinition(@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:

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

getResourceOid

default String getResourceOid()

Description copied from interface: ResourceObjectDefinition

This is currently used only to pass information about association in the model-impl TODO consider removal!

Specified by:

getResourceOid in interface ResourceObjectDefinition

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

See Also:

• ResourceObjectTypeDefinitionType.getAuxiliaryObjectClassMappings()

getProtectedObjectPatterns

@NotNull
default @NotNull Collection<ResourceObjectPattern> getProtectedObjectPatterns()

Description copied from interface: ResourceObjectDefinition

Returns compiled patterns denoting protected objects.

Specified by:

getProtectedObjectPatterns in interface ResourceObjectDefinition

See Also:

• ResourceObjectTypeDefinitionType.getProtected()

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

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

default 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 "raw" configuration bean for this object type.

Specified by:

getDefinitionBean in interface ResourceObjectDefinition

getRawObjectClassDefinition

@NotNull
default @NotNull ResourceObjectClassDefinition getRawObjectClassDefinition()

Description copied from interface: ResourceObjectDefinition

Returns the raw object class definition.

Specified by:

getRawObjectClassDefinition in interface ResourceObjectDefinition

createShadowSearchQuery

@NotNull
default @NotNull ObjectQuery createShadowSearchQuery(String resourceOid)
                                              throws SchemaException

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

Throws:

SchemaException

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