Package com.evolveum.midpoint.schema.processor

Interface ResourceObjectDefinition

All Superinterfaces:

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

All Known Subinterfaces:

CompositeObjectDefinition, CompositeObjectDefinitionDelegator, ResourceObjectClassDefinition, ResourceObjectClassDefinitionDelegator, ResourceObjectDefinitionDelegator, ResourceObjectTypeDefinition, ResourceObjectTypeDefinitionDelegator

All Known Implementing Classes:

AbstractResourceObjectDefinitionImpl, CompositeObjectDefinitionImpl, ResourceObjectClassDefinitionImpl, ResourceObjectTypeDefinitionImpl

public interface ResourceObjectDefinition
extends IdentifiersDefinitionStore, AttributeDefinitionStore, AssociationDefinitionStore, LayeredDefinition, FrameworkNameResolver, ResourceObjectInboundDefinition, TypeDefinition

A definition that describes either an object class (as fetched from the resource, optionally refined by `schemaHandling`), or an object type (as defined in `schemaHandling` part of resource definition). Since 4.9, it is no longer a ComplexTypeDefinition; see ShadowItemsComplexTypeDefinition for explanation. ResourceObjectDefinition ^ | +------------------+-------------------+ | | ResourceObjectClassDefinition ResourceObjectTypeDefinition

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 boolean	areCredentialsCached()
default boolean	areCredentialsCachedLegacy()	Returns `true` if the caching is turned on, but only because of the legacy configuration.
default void	assertAttached()
static void	assertAttached(ResourceObjectDefinition resourceObjectDefinition)
default boolean	canRepresent(QName typeName)
@NotNull ResourceObjectDefinition	clone()	Returns a mutable definition.
default @NotNull ResourceObjectDefinition	composite(Collection<? extends ResourceObjectDefinition> auxiliaryDefinitions)
default AbstractShadow	createBlankShadow()	Creates a blank, empty shadow.
default AbstractShadow	createBlankShadowWithPrimaryId(@NotNull Object primaryIdentifierValue)	As createBlankShadow() but with the specified primary identifier.
default AbstractShadow	createBlankShadowWithTag(String tag)	As createBlankShadow() but having the correct resource OID, kind/intent (if applicable), and tag set.
default ResourceObjectIdentification.WithPrimary	createPrimaryIdentification(@NotNull Object identifierRealValue)
@NotNull ObjectQuery	createShadowSearchQuery(String resourceOid)	Creates a query for obtaining shadows related to this object class or object type.
@NotNull ResourceObjectDefinition	deepClone(@NotNull DeepCloneOperation operation)	Returns a mutable definition.
default ShadowReferenceAttributeDefinition	findReferenceAttributeDefinition(QName name)
@NotNull ResourceObjectDefinition	forLayerImmutable(@NotNull LayerType layer)	As forLayerMutable(LayerType) but returns immutable definition.
@NotNull ResourceObjectDefinition	forLayerMutable(@NotNull LayerType layer)	Creates a layer-specific mutable version of this definition.
default ResourceBidirectionalMappingType	getActivationBidirectionalMappingType(ItemName itemName)	TODO Rarely used, consider removing from the interface
default @Nullable AttributeFetchStrategyType	getActivationFetchStrategy(ItemName itemName)	TODO Rarely used, consider removing from the interface
ResourceActivationDefinitionType	getActivationSchemaHandling()
default Collection<? extends ShadowAssociationDefinition>	getAssociationDefinitionsFor(@NotNull ItemName refAttrName)
default @NotNull ShadowAssociationsComplexTypeDefinition	getAssociationsComplexTypeDefinition()
default @NotNull ShadowAttributesComplexTypeDefinition	getAttributesComplexTypeDefinition()
@NotNull Collection<ShadowAttributeDefinition<?,?,?,?>>	getAttributesVolatileOnAddOperation()	See ShadowAttributeDefinition.isVolatileOnAddOperation().
@NotNull Collection<ShadowAttributeDefinition<?,?,?,?>>	getAttributesVolatileOnModifyOperation()	See ShadowAttributeDefinition.isVolatileOnModifyOperation().
@NotNull Collection<? extends ResourceObjectDefinition>	getAuxiliaryDefinitions()	TODO define semantics (it's different for CompositeObjectDefinition and the others!
ResourceBidirectionalMappingAndDefinitionType	getAuxiliaryObjectClassMappings()
ResourceObjectReferenceType	getBaseContext()	The definition of base context (resource object container).
@NotNull BasicResourceInformation	getBasicResourceInformation()	The basic information about the resource (like name, OID, selected configuration beans).
default @Nullable Class<?>	getCompileTimeClass()	Returns compile-time class, if this type has any.
@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).
String	getDebugDumpClassName()	Return a human readable name of this class suitable for logs.
@Nullable DefaultInboundMappingEvaluationPhasesType	getDefaultInboundMappingEvaluationPhases()	Returns the phases in which inbound mappings are evaluated by default.
default @Nullable String	getDefaultOperationPolicyOid(@NotNull TaskExecutionMode mode)
@NotNull ResourceObjectTypeDefinitionType	getDefinitionBean()	Returns the configuration bean for this object type or class.
@NotNull ResourceObjectTypeDelineation	getDelineation()	Returns the delineation of the set of objects belonging to this object type.
String	getDescription()	Free-form textual description of the object.
default @Nullable ShadowSimpleAttributeDefinition<?>	getDescriptionAttribute()	Returns the definition of description attribute of a resource object.
@Nullable QName	getDescriptionAttributeName()	Returns name of the description attribute.
default ShadowSimpleAttributeDefinition<?>	getDisplayNameAttribute()	Returns the definition of display name attribute.
@Nullable QName	getDisplayNameAttributeName()	Returns name of the display name attribute.
@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).
<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.
String	getHumanReadableName()	TODO
default @NotNull ResourceObjectDefinitionIdentification	getIdentification()
default Integer	getInstantiationOrder()
@Nullable ResourceLastLoginTimestampDefinitionType	getLastLoginTimestampDefinition()	See ResourceObjectTypeDefinitionType.getBehavior()
default @Nullable AttributeFetchStrategyType	getLastLoginTimestampFetchStrategy()
@Nullable String	getLifecycleState()	What lifecycle state is the (refined) object class or object type definition?
default @Nullable ShadowSimpleAttributeDefinition<?>	getNamingAttribute()	Returns the attribute used as a visible name of the resource object.
@Nullable QName	getNamingAttributeName()	Returns name of the naming attribute.
@NotNull NativeObjectClassDefinition	getNativeObjectClassDefinition()	Returns the [structural] native object class definition, typically obtained from the connector.
@NotNull ResourceObjectClassDefinition	getObjectClassDefinition()	Returns the [structural] object class definition.
default @NotNull String	getObjectClassLocalName()
@NotNull QName	getObjectClassName()	Returns the name of the object class.
ResourceObjectMultiplicityType	getObjectMultiplicity()
@Nullable ResourcePasswordDefinitionType	getPasswordDefinition()	See ResourceObjectTypeDefinitionType.getCredentials()
default @Nullable AttributeFetchStrategyType	getPasswordFetchStrategy()	TODO Rarely used, consider removing from the interface
default @NotNull List<MappingType>	getPasswordInbound()
default @NotNull List<MappingType>	getPasswordOutbound()
PrismObjectDefinition<ShadowType>	getPrismObjectDefinition()	Returns a prism definition for the prism object/objects carrying the resource object/objects.
ProjectionPolicyType	getProjectionPolicy()
default @NotNull List<? extends ShadowReferenceAttributeDefinition>	getReferenceAttributeDefinitions()	Returns definitions of all associations as an unmodifiable collection.
default @NotNull ShadowAttributesComplexTypeDefinition	getReferenceAttributesComplexTypeDefinition()
default String	getResourceOid()	The resource OID, if known.
SearchHierarchyScope	getSearchHierarchyScope()	Definition of search hierarchy scope.
ObjectReferenceType	getSecurityPolicyRef()
@NotNull ShadowMarkingRules	getShadowMarkingRules()	Returns compiled patterns denoting protected objects or other kinds of marks.
@NotNull String	getShortIdentification()	Very short identification, like the object class local name or the kind/intent pair.
default @NotNull ShadowAttributesComplexTypeDefinition	getSimpleAttributesComplexTypeDefinition()
default @NotNull Collection<TypeDefinition>	getStaticSubTypes()	Subtypes - but only these that are a part of the static schema.
default @Nullable QName	getSuperType()	Name of super type of this complex type definition.
@Nullable ResourceObjectTypeDefinition	getTypeDefinition()	Is this definition bound to a specific resource type?
@Nullable ResourceObjectTypeIdentification	getTypeIdentification()	Is this definition bound to a specific resource type?
@NotNull ResourceObjectVolatilityType	getVolatility()	Specifies volatility of this type of resource objects, i.e. whether such an object can change when midPoint is not looking.
boolean	hasAuxiliaryObjectClass(QName expectedObjectClassName)	TODO define semantics (it's different for CompositeObjectDefinition and the others!
default boolean	isActivationCached()
default boolean	isAuxiliaryObjectClassPropertyCached()
default boolean	isCachingEnabled()
boolean	isDefaultFor(@NotNull ShadowKindType kind)	Returns true if this definition can be considered as a default for the specified kind.
default boolean	isEffectivelyCached(ItemPath itemPath)
default boolean	matchesObjectClassName(@Nullable QName name)	Returns true if the type definition matches specified object class name.
default @NotNull S_FilterEntryOrEmpty	queryFor()
default void	replaceAttributeDefinition(@NotNull ItemDefinition<?> newDefinition)
void	replaceAttributeDefinition(@NotNull QName itemName, @Nullable ItemDefinition<?> newDefinition)	Replaces a definition for given item name with a provided one.
default @NotNull PrismObjectDefinition<ShadowType>	toPrismObjectDefinition()	Call getPrismObjectDefinition() for the cached version.
default @NotNull ShadowAssociationsContainerDefinition	toShadowAssociationsContainerDefinition()
default @NotNull ShadowAttributesContainerDefinition	toShadowAttributesContainerDefinition()	Creates ShadowAttributesContainerDefinition with this definition as a complex type definition.
void	trimAttributesTo(@NotNull Collection<ItemPath> paths)
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, findSimpleAttributeDefinition, findSimpleAttributeDefinition, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionStrictlyRequired, findSimpleAttributeDefinitionStrictlyRequired, getAllSimpleAttributesNames, getAttributeDefinitions, getAttributeDefinitions, getAttributeNames, getReferenceAttributesNames, getSimpleAttributeDefinitions, 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.schema.processor.FrameworkNameResolver

resolveFrameworkName

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, getPrimaryIdentifiers, getPrimaryIdentifiersNames, getSecondaryIdentifierRequired, getSecondaryIdentifiers, getSecondaryIdentifiersNames, isIdentifier, isPrimaryIdentifier, isSecondaryIdentifier

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

getCurrentLayer

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

getAttributeDefinitions, getCorrelation, getFocusSpecification, getReferenceAttributeInboundDefinition, getSimpleAttributeInboundDefinition, getSynchronizationReactions

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

getBasicResourceInformation

@NotNull
@NotNull BasicResourceInformation getBasicResourceInformation()

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.

getResourceOid

default String getResourceOid()

The resource OID, if known.

getObjectClassDefinition

@NotNull
@NotNull ResourceObjectClassDefinition getObjectClassDefinition()

Returns the [structural] object class definition.

getNativeObjectClassDefinition

@NotNull
@NotNull NativeObjectClassDefinition getNativeObjectClassDefinition()

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

getObjectClassName

@NotNull
@NotNull QName getObjectClassName()

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

getObjectClassLocalName

@NotNull
default @NotNull String getObjectClassLocalName()

getConfiguredAuxiliaryObjectClassNames

@NotNull
@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). For dynamically composed definitions (CompositeObjectDefinition only the statically-defined ones (i.e. those from the structural definition) are returned.

getAuxiliaryDefinitions

@NotNull
@NotNull Collection<? extends ResourceObjectDefinition> getAuxiliaryDefinitions()

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

hasAuxiliaryObjectClass

boolean hasAuxiliaryObjectClass(QName expectedObjectClassName)

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

getDescription

String getDescription()

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

See Also:

• ResourceObjectTypeDefinitionType.getDescription()

getDescriptionAttribute

@Nullable
default @Nullable ShadowSimpleAttributeDefinition<?> getDescriptionAttribute()

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

getDescriptionAttributeName

@Nullable
@Nullable QName getDescriptionAttributeName()

Returns name of the description attribute.

See Also:

• getDescriptionAttribute()

getNamingAttribute

@Nullable
default @Nullable ShadowSimpleAttributeDefinition<?> getNamingAttribute()

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

getNamingAttributeName

@Nullable
@Nullable QName getNamingAttributeName()

Returns name of the naming attribute.

See Also:

• getNamingAttributeName()

getDisplayNameAttribute

default ShadowSimpleAttributeDefinition<?> getDisplayNameAttribute()

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

getDisplayNameAttributeName

@Nullable
@Nullable QName getDisplayNameAttributeName()

Returns name of the display name attribute.

getDelineation

@NotNull
@NotNull ResourceObjectTypeDelineation getDelineation()

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

getBaseContext

ResourceObjectReferenceType getBaseContext()

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

See Also:

• ResourceObjectTypeDefinitionType.getBaseContext()

getSearchHierarchyScope

SearchHierarchyScope getSearchHierarchyScope()

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

See Also:

• ResourceObjectTypeDefinitionType.getSearchHierarchyScope()

getShadowMarkingRules

@NotNull
@NotNull ShadowMarkingRules getShadowMarkingRules()

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

See Also:

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

getAuxiliaryObjectClassMappings

ResourceBidirectionalMappingAndDefinitionType getAuxiliaryObjectClassMappings()

Specified by:

getAuxiliaryObjectClassMappings in interface ResourceObjectInboundDefinition

See Also:

• ResourceObjectTypeDefinitionType.getAuxiliaryObjectClassMappings()

getSecurityPolicyRef

ObjectReferenceType getSecurityPolicyRef()

See Also:

• ResourceObjectTypeDefinitionType.getSecurityPolicyRef()

getObjectMultiplicity

ResourceObjectMultiplicityType getObjectMultiplicity()

See Also:

• ResourceObjectTypeDefinitionType.getMultiplicity()

getProjectionPolicy

ProjectionPolicyType getProjectionPolicy()

See Also:

• ResourceObjectTypeDefinitionType.getProjection()

getPasswordDefinition

@Nullable
@Nullable ResourcePasswordDefinitionType getPasswordDefinition()

See ResourceObjectTypeDefinitionType.getCredentials()

getLastLoginTimestampDefinition

@Nullable
@Nullable ResourceLastLoginTimestampDefinitionType getLastLoginTimestampDefinition()

See ResourceObjectTypeDefinitionType.getBehavior()

getPasswordFetchStrategy

@Nullable
default @Nullable AttributeFetchStrategyType getPasswordFetchStrategy()

TODO Rarely used, consider removing from the interface

getPasswordInbound

@NotNull
default @NotNull List<MappingType> getPasswordInbound()

Specified by:

getPasswordInbound in interface ResourceObjectInboundDefinition

getPasswordOutbound

@NotNull
default @NotNull List<MappingType> getPasswordOutbound()

getActivationSchemaHandling

ResourceActivationDefinitionType getActivationSchemaHandling()

See Also:

• ResourceObjectTypeDefinitionType.getActivation()

getActivationBidirectionalMappingType

default ResourceBidirectionalMappingType getActivationBidirectionalMappingType(ItemName itemName)

TODO Rarely used, consider removing from the interface

Specified by:

getActivationBidirectionalMappingType in interface ResourceObjectInboundDefinition

getActivationFetchStrategy

@Nullable
default @Nullable AttributeFetchStrategyType getActivationFetchStrategy(ItemName itemName)

TODO Rarely used, consider removing from the interface

getLastLoginTimestampFetchStrategy

@Nullable
default @Nullable AttributeFetchStrategyType getLastLoginTimestampFetchStrategy()

getVolatility

@NotNull
@NotNull ResourceObjectVolatilityType getVolatility()

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

See Also:

• ResourceObjectTypeDefinitionType.getVolatility()

getDefaultInboundMappingEvaluationPhases

@Nullable
@Nullable DefaultInboundMappingEvaluationPhasesType getDefaultInboundMappingEvaluationPhases()

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

Specified by:

getDefaultInboundMappingEvaluationPhases in interface ResourceObjectInboundDefinition

See Also:

• ResourceObjectTypeDefinitionType.getMappingsEvaluation()

getLifecycleState

@Nullable
@Nullable String getLifecycleState()

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

See Also:

• ResourceObjectTypeDefinitionType.getLifecycleState()

createShadowSearchQuery

@NotNull
@NotNull ObjectQuery createShadowSearchQuery(String resourceOid)

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.

createBlankShadow

default AbstractShadow createBlankShadow()

Creates a blank, empty shadow. It contains only the object class name and resource OID. Kind/intent are NOT set, because the definition may be a "default type definition for given object class" (which is sadly still supported); and we do not want to create typed shadows in such cases. ShadowBuilder.withDefinition(ResourceObjectDefinition) provides kind and intent.

createBlankShadowWithPrimaryId

default AbstractShadow createBlankShadowWithPrimaryId(@NotNull
 @NotNull Object primaryIdentifierValue)
                                               throws SchemaException

As createBlankShadow() but with the specified primary identifier.

Throws:

SchemaException

createBlankShadowWithTag

default AbstractShadow createBlankShadowWithTag(String tag)

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

getPrismObjectDefinition

PrismObjectDefinition<ShadowType> getPrismObjectDefinition()

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

toShadowAttributesContainerDefinition

@NotNull
default @NotNull ShadowAttributesContainerDefinition toShadowAttributesContainerDefinition()

Creates ShadowAttributesContainerDefinition with this definition as a complex type definition.

toShadowAssociationsContainerDefinition

@NotNull
default @NotNull ShadowAssociationsContainerDefinition toShadowAssociationsContainerDefinition()

getEnabledCapability

<T extends CapabilityType> T getEnabledCapability(@NotNull
 @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. Returns the present capability, but only if it's enabled.

trimAttributesTo

void trimAttributesTo(@NotNull
 @NotNull Collection<ItemPath> paths)

validate

void validate()
       throws SchemaException

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

Throws:

SchemaException

getDebugDumpClassName

String getDebugDumpClassName()

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

getHumanReadableName

String getHumanReadableName()

TODO

getShortIdentification

@NotNull
@NotNull String getShortIdentification()

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

clone

@NotNull
@NotNull ResourceObjectDefinition clone()

Returns a mutable definition. BEWARE, the mutable CompositeObjectDefinition is significantly slower than its immutable counterpart. See MID-9156.

Specified by:

clone in interface Definition

deepClone

@NotNull
@NotNull ResourceObjectDefinition deepClone(@NotNull
 @NotNull DeepCloneOperation operation)

Returns a mutable definition. BEWARE, the mutable CompositeObjectDefinition is significantly slower than its immutable counterpart. See MID-9156.

getDefinitionBean

@NotNull
@NotNull ResourceObjectTypeDefinitionType getDefinitionBean()

Returns the configuration bean for this object type or class.

forLayerMutable

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

Creates a layer-specific mutable version of this definition.

forLayerImmutable

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

As forLayerMutable(LayerType) but returns immutable definition.

replaceAttributeDefinition

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

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

replaceAttributeDefinition

default void replaceAttributeDefinition(@NotNull
 @NotNull ItemDefinition<?> newDefinition)

matchesObjectClassName

default boolean matchesObjectClassName(@Nullable
 @Nullable QName name)

Returns true if the type definition matches specified object class name. OC name of `null` matches all definitions.

getTypeIdentification

@Nullable
@Nullable ResourceObjectTypeIdentification getTypeIdentification()

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

getIdentification

@NotNull
default @NotNull ResourceObjectDefinitionIdentification getIdentification()

getTypeDefinition

@Nullable
@Nullable ResourceObjectTypeDefinition getTypeDefinition()

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

isDefaultFor

@Experimental
boolean isDefaultFor(@NotNull
 @NotNull ShadowKindType kind)

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!

assertAttached

static void assertAttached(ResourceObjectDefinition resourceObjectDefinition)

assertAttached

default void assertAttached()

toPrismObjectDefinition

@NotNull
default @NotNull PrismObjectDefinition<ShadowType> toPrismObjectDefinition()

Call getPrismObjectDefinition() for the cached version.

composite

@NotNull
default @NotNull ResourceObjectDefinition composite(Collection<? extends ResourceObjectDefinition> auxiliaryDefinitions)

getAttributesComplexTypeDefinition

@NotNull
default @NotNull ShadowAttributesComplexTypeDefinition getAttributesComplexTypeDefinition()

getSimpleAttributesComplexTypeDefinition

@NotNull
default @NotNull ShadowAttributesComplexTypeDefinition getSimpleAttributesComplexTypeDefinition()

getReferenceAttributesComplexTypeDefinition

@NotNull
default @NotNull ShadowAttributesComplexTypeDefinition getReferenceAttributesComplexTypeDefinition()

getAssociationsComplexTypeDefinition

@NotNull
default @NotNull ShadowAssociationsComplexTypeDefinition getAssociationsComplexTypeDefinition()

getCompileTimeClass

@Nullable
default @Nullable Class<?> getCompileTimeClass()

Description copied from interface: TypeDefinition

Returns compile-time class, if this type has any. For example, UserType.class, ObjectType.class, ExtensionType.class.

Specified by:

getCompileTimeClass in interface TypeDefinition

getSuperType

@Nullable
default @Nullable QName getSuperType()

Description copied from interface: TypeDefinition

Name of super type of this complex type definition. For example, `c:ObjectType` is a super type for `c:FocusType` which is a super type for `c:UserType`. Extension types have `c:ExtensionType` as their supertype, if no explicit supertype is specified in XSD.

Specified by:

getSuperType in interface TypeDefinition

getStaticSubTypes

@NotNull
default @NotNull Collection<TypeDefinition> getStaticSubTypes()

Description copied from interface: TypeDefinition

Subtypes - but only these that are a part of the static schema. A little bit experimental. :)

Specified by:

getStaticSubTypes in interface TypeDefinition

getInstantiationOrder

default Integer getInstantiationOrder()

Specified by:

getInstantiationOrder in interface TypeDefinition

canRepresent

default boolean canRepresent(QName typeName)

Specified by:

canRepresent in interface TypeDefinition

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

findReferenceAttributeDefinition

default ShadowReferenceAttributeDefinition findReferenceAttributeDefinition(QName name)

Specified by:

findReferenceAttributeDefinition in interface AttributeDefinitionStore

createPrimaryIdentification

@NotNull
default ResourceObjectIdentification.WithPrimary createPrimaryIdentification(@NotNull
 @NotNull Object identifierRealValue)
                                                                      throws SchemaException

Throws:

SchemaException

queryFor

@NotNull
default @NotNull S_FilterEntryOrEmpty queryFor()

getAssociationDefinitionsFor

default Collection<? extends ShadowAssociationDefinition> getAssociationDefinitionsFor(@NotNull
 @NotNull ItemName refAttrName)

getEffectiveShadowCachingPolicy

@NotNull
@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). The returned value has all the defaults applied. Throws an exception for unattached raw object class definitions.

isCachingEnabled

default boolean isCachingEnabled()

isActivationCached

default boolean isActivationCached()

isAuxiliaryObjectClassPropertyCached

default boolean isAuxiliaryObjectClassPropertyCached()

areCredentialsCached

default boolean areCredentialsCached()

areCredentialsCachedLegacy

default boolean areCredentialsCachedLegacy()

Returns `true` if the caching is turned on, but only because of the legacy configuration.

isEffectivelyCached

default boolean isEffectivelyCached(ItemPath itemPath)

getDefaultOperationPolicyOid

@Nullable
default @Nullable String getDefaultOperationPolicyOid(@NotNull
 @NotNull TaskExecutionMode mode)
                                               throws ConfigurationException

Throws:

ConfigurationException

getAttributesVolatileOnAddOperation

@NotNull
@NotNull Collection<ShadowAttributeDefinition<?,?,?,?>> getAttributesVolatileOnAddOperation()

See ShadowAttributeDefinition.isVolatileOnAddOperation().

getAttributesVolatileOnModifyOperation

@NotNull
@NotNull Collection<ShadowAttributeDefinition<?,?,?,?>> getAttributesVolatileOnModifyOperation()

See ShadowAttributeDefinition.isVolatileOnModifyOperation().