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

Interface ResourceObjectTypeDefinitionDelegator

All Superinterfaces:

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

public interface ResourceObjectTypeDefinitionDelegator
extends ResourceObjectDefinitionDelegator, ResourceObjectTypeDefinition

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default @NotNull ObjectQuery	createShadowSearchQuery(String resourceOid)	Creates a query for obtaining shadows related to this object class or object type.
ResourceObjectTypeDefinition	delegate()
default @NotNull ResourceObjectTypeDefinition	forLayerMutable(@NotNull LayerType layer)	Creates a layer-specific mutable version of this definition.
default @Nullable ObjectReferenceType	getArchetypeRef()	Archetype reference - not present in standalone definitions.
default @NotNull Collection<ResourceObjectDefinition>	getAuxiliaryDefinitions()	TODO define semantics (it's different for CompositeObjectDefinition and the others!
default @Nullable ExpressionType	getClassificationCondition()	Temporary?
default <T extends CapabilityType> T	getConfiguredCapability(Class<T> capabilityClass)	Returns the configured capability of given class, if present.
default @Nullable CorrelationDefinitionType	getCorrelationDefinitionBean()	Returns the correlation definition bean, if present here.
default @Nullable QName	getFocusTypeName()	Returns the focus type name, if present here.
default @NotNull String	getIntent()	Intent defining this object type (along with ResourceObjectTypeDefinition.getKind()).
default @NotNull ShadowKindType	getKind()	Kind of objects covered by this object type.
default @Nullable CapabilityCollectionType	getSpecificCapabilities()	Returns all configured capabilities, if present.
default @NotNull Collection<SynchronizationReactionDefinition>	getSynchronizationReactions()	Returns the synchronization reactions defined here.
default @NotNull ResourceObjectTypeDefinition	getTypeDefinition()	Is this definition bound to a specific resource type?
default @NotNull ResourceObjectTypeIdentification	getTypeIdentification()	Is this definition bound to a specific resource type?
default boolean	hasSynchronizationReactionsDefinition()	Returns true if there is "synchronization reactions" definition section here (even if it's empty).
default ResourceAttributeContainer	instantiate(ItemName elementName)	Creates a ResourceAttributeContainer instance with this definition as its complex type definition.
default boolean	isDefaultFor(@NotNull ShadowKindType kind)	Returns true if this definition can be considered as a default for the specified kind.
default boolean	isDefaultForKind()	Is this type explicitly marked as the default object type for given kind?
default boolean	isDefaultForObjectClass()	Is this type explicitly marked as the default object type for given object class?
default @Nullable Boolean	isSynchronizationEnabled()	Returns the "synchronization enabled" flag value, if present here.
default @Nullable Boolean	isSynchronizationOpportunistic()	Returns the "synchronization opportunistic" flag value, if present here.

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, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, matchesObjectClassName, replaceDefinition

Methods inherited from interface com.evolveum.midpoint.schema.processor.deleg.ResourceObjectDefinitionDelegator

createBlankShadow, findAttributeDefinition, findAttributeDefinition, forLayerImmutable, getActivationSchemaHandling, getAssociationDefinitions, getAttributeDefinitions, getAuxiliaryObjectClassMappings, getBaseContext, getConfiguredAuxiliaryObjectClassNames, getCurrentLayer, getDebugDumpClassName, getDefaultInboundMappingEvaluationPhases, getDefinitionBean, getDelineation, getDescription, getDescriptionAttribute, getDescriptionAttributeName, getDisplayNameAttribute, getDisplayNameAttributeName, getEnabledCapability, getHumanReadableName, getLifecycleState, getNamingAttribute, getNamingAttributeName, getObjectClassDefinition, getObjectClassName, getObjectMultiplicity, getPasswordDefinition, getPrimaryIdentifiers, getPrimaryIdentifiersNames, getPrismObjectDefinition, getProjectionPolicy, getProtectedObjectPatterns, getRawObjectClassDefinition, getResourceOid, getSearchHierarchyScope, getSecondaryIdentifiers, getSecondaryIdentifiersNames, getSecurityPolicyRef, getVolatility, hasAuxiliaryObjectClass, isPrimaryIdentifier, isSecondaryIdentifier, replaceDefinition, toResourceAttributeContainerDefinition, toResourceAttributeContainerDefinition, validate

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

getArchetypeOid, matches, matchesKind

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

ResourceObjectTypeDefinition delegate()

Specified by:

delegate in interface ComplexTypeDefinitionDelegator

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface ResourceObjectDefinitionDelegator

Specified by:

delegate in interface TypeDefinitionDelegator

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

Specified by:

createShadowSearchQuery in interface ResourceObjectDefinitionDelegator

Specified by:

createShadowSearchQuery in interface ResourceObjectTypeDefinition

Throws:

SchemaException

getKind

@NotNull
default @NotNull ShadowKindType getKind()

Description copied from interface: ResourceObjectTypeDefinition

Kind of objects covered by this object type.

Specified by:

getKind in interface ResourceObjectTypeDefinition

getIntent

@NotNull
default @NotNull String getIntent()

Description copied from interface: ResourceObjectTypeDefinition

Intent defining this object type (along with ResourceObjectTypeDefinition.getKind()).

Specified by:

getIntent in interface ResourceObjectTypeDefinition

isDefaultForKind

default boolean isDefaultForKind()

Description copied from interface: ResourceObjectTypeDefinition

Is this type explicitly marked as the default object type for given kind? (using default or defaultForKind property).

Specified by:

isDefaultForKind in interface ResourceObjectTypeDefinition

See Also:

• ResourceObjectTypeDefinitionType.isDefaultForKind()
• ResourceObjectTypeDefinitionType.isDefault()

isDefaultForObjectClass

default boolean isDefaultForObjectClass()

Description copied from interface: ResourceObjectTypeDefinition

Is this type explicitly marked as the default object type for given object class? (using default or defaultForObjectClass property).

Specified by:

isDefaultForObjectClass in interface ResourceObjectTypeDefinition

See Also:

• ResourceObjectTypeDefinitionType.isDefaultForObjectClass()
• ResourceObjectTypeDefinitionType.isDefault()

forLayerMutable

@NotNull
default @NotNull ResourceObjectTypeDefinition 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

Specified by:

forLayerMutable in interface ResourceObjectDefinitionDelegator

Specified by:

forLayerMutable in interface ResourceObjectTypeDefinition

getConfiguredCapability

@Nullable
default <T extends CapabilityType> T getConfiguredCapability(Class<T> capabilityClass)

Description copied from interface: ResourceObjectTypeDefinition

Returns the configured capability of given class, if present.

Specified by:

getConfiguredCapability in interface ResourceObjectTypeDefinition

getSpecificCapabilities

@Nullable
default @Nullable CapabilityCollectionType getSpecificCapabilities()

Description copied from interface: ResourceObjectTypeDefinition

Returns all configured capabilities, if present.

Specified by:

getSpecificCapabilities in interface ResourceObjectTypeDefinition

getCorrelationDefinitionBean

@Nullable
default @Nullable CorrelationDefinitionType getCorrelationDefinitionBean()

Description copied from interface: ResourceObjectTypeDefinition

Returns the correlation definition bean, if present here. (It may be standalone.)

Specified by:

getCorrelationDefinitionBean in interface ResourceObjectTypeDefinition

isSynchronizationEnabled

@Nullable
default @Nullable Boolean isSynchronizationEnabled()

Description copied from interface: ResourceObjectTypeDefinition

Returns the "synchronization enabled" flag value, if present here. (It may be standalone.) FIXME

Specified by:

isSynchronizationEnabled in interface ResourceObjectTypeDefinition

isSynchronizationOpportunistic

@Nullable
default @Nullable Boolean isSynchronizationOpportunistic()

Description copied from interface: ResourceObjectTypeDefinition

Returns the "synchronization opportunistic" flag value, if present here. (It may be standalone.)

Specified by:

isSynchronizationOpportunistic in interface ResourceObjectTypeDefinition

getFocusTypeName

@Nullable
default @Nullable QName getFocusTypeName()

Description copied from interface: ResourceObjectTypeDefinition

Returns the focus type name, if present here. (It may be standalone.)

Specified by:

getFocusTypeName in interface ResourceObjectTypeDefinition

getArchetypeRef

@Nullable
default @Nullable ObjectReferenceType getArchetypeRef()

Description copied from interface: ResourceObjectTypeDefinition

Archetype reference - not present in standalone definitions.

Specified by:

getArchetypeRef in interface ResourceObjectTypeDefinition

hasSynchronizationReactionsDefinition

default boolean hasSynchronizationReactionsDefinition()

Description copied from interface: ResourceObjectTypeDefinition

Returns true if there is "synchronization reactions" definition section here (even if it's empty).

Specified by:

hasSynchronizationReactionsDefinition in interface ResourceObjectTypeDefinition

getSynchronizationReactions

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

Description copied from interface: ResourceObjectTypeDefinition

Returns the synchronization reactions defined here. (They may be standalone.)

Specified by:

getSynchronizationReactions in interface ResourceObjectTypeDefinition

getClassificationCondition

@Nullable
default @Nullable ExpressionType getClassificationCondition()

Description copied from interface: ResourceObjectTypeDefinition

Temporary?

Specified by:

getClassificationCondition in interface ResourceObjectTypeDefinition

getAuxiliaryDefinitions

@NotNull
default @NotNull Collection<ResourceObjectDefinition> getAuxiliaryDefinitions()

Description copied from interface: ResourceObjectDefinition

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

Specified by:

getAuxiliaryDefinitions in interface ResourceObjectDefinition

instantiate

default ResourceAttributeContainer instantiate(ItemName elementName)

Description copied from interface: ResourceObjectDefinition

Creates a ResourceAttributeContainer instance with this definition as its complex type definition.

Specified by:

instantiate in interface ResourceObjectDefinition

getTypeIdentification

@NotNull
default @NotNull 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

Specified by:

getTypeIdentification in interface ResourceObjectDefinitionDelegator

Specified by:

getTypeIdentification in interface ResourceObjectTypeDefinition

getTypeDefinition

@NotNull
default @NotNull 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

Specified by:

getTypeDefinition in interface ResourceObjectDefinitionDelegator

Specified by:

getTypeDefinition in interface ResourceObjectTypeDefinition

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

Specified by:

isDefaultFor in interface ResourceObjectDefinitionDelegator