Package com.evolveum.midpoint.schema.processor

Interface ResourceObjectTypeDefinition

All Superinterfaces:

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

All Known Subinterfaces:

ResourceObjectTypeDefinitionDelegator

All Known Implementing Classes:

ResourceObjectTypeDefinitionImpl, TransformableComplexTypeDefinition.TrResourceObjectTypeDefinition

public interface ResourceObjectTypeDefinition
extends ResourceObjectDefinition

Definition of "resource object type". Roughly corresponds to an `objectType` section in `schemaHandling` part of resource definition.

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	forLayer(@NotNull LayerType layerType)	Creates a layer-specific version of this definition.
default @Nullable String	getArchetypeOid()	Archetype OID - a convenience method.
@Nullable ObjectReferenceType	getArchetypeRef()	Archetype reference - not present in standalone definitions.
@Nullable ExpressionType	getClassificationCondition()	Temporary?
<T extends CapabilityType> T	getConfiguredCapability(Class<T> capabilityClass)	Returns the configured capability of given class, if present.
@Nullable CorrelationDefinitionType	getCorrelationDefinitionBean()	Returns the correlation definition bean, if present here.
@Nullable QName	getFocusTypeName()	Returns the focus type name, if present here.
@NotNull String	getIntent()	Intent defining this object type (along with getKind()).
@NotNull ShadowKindType	getKind()	Kind of objects covered by this object type.
@NotNull Collection<SynchronizationReactionDefinition>	getSynchronizationReactions()	Returns the synchronization reactions defined here.
@NotNull ResourceObjectTypeDefinition	getTypeDefinition()	Is this definition bound to a specific resource type? If yes, this method returns its definition.
@NotNull ResourceObjectTypeIdentification	getTypeIdentification()	Identification (kind+intent) of this object type.
boolean	hasSynchronizationReactionsDefinition()	Returns true if there is "synchronization reactions" definition section here (even if it's empty).
boolean	isDefaultForKind()	Is this type explicitly marked as the default object type for given kind? (using default or defaultForKind property).
boolean	isDefaultForObjectClass()	Is this type explicitly marked as the default object type for given object class? (using default or defaultForObjectClass property).
@Nullable Boolean	isSynchronizationEnabled()	Returns the "synchronization enabled" flag value, if present here.
@Nullable Boolean	isSynchronizationOpportunistic()	Returns the "synchronization opportunistic" flag value, if present here.
default boolean	matches(@NotNull ShadowKindType kind, @NotNull String intent)	Returns true if this object type matches specified (non-null) kind and intent.
default boolean	matchesKind(@Nullable ShadowKindType kind)	Returns true if the type definition is of specified kind.

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

findAssociationDefinition, findAssociationDefinitionRequired, getAssociationDefinitions, getAssociationDefinitions, getNamesOfAssociations, getNamesOfAssociationsWithInboundExpressions, getNamesOfAssociationsWithOutboundExpressions

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

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

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

getDefaultNamespace, getDefinitions, getExtensionForType, getIgnoredNamespaces, getXmlAttributeDefinitions, hasOperationalOnlyItems, hasSubstitutions, hasSubstitutions, isContainerMarker, isEmpty, isItemDefinitionRemoved, isListMarker, isObjectMarker, isReferenceMarker, isStrictAnyMarker, isXsdAnyMarker, itemOrSubstitution, merge, substitution, toMutable, trimTo

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

debugDump, getAnnotation, getAnnotations, getDeprecatedSince, getDiagrams, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getProcessing, getSchemaMigrations, getSchemaRegistry, getTypeClass, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, 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, getPrimaryIdentifiers, getPrimaryIdentifiersNames, 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

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

getPrismContext

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

clone, createBlankShadow, deepClone, getActivationBidirectionalMappingType, getActivationFetchStrategy, getActivationSchemaHandling, getAuxiliaryDefinitions, getAuxiliaryObjectClassMappings, getBaseContext, getConfiguredAuxiliaryObjectClassNames, getDebugDumpClassName, getDefaultInboundMappingEvaluationPhases, getDefinitionBean, getDelineation, getDescription, getDescriptionAttribute, getDescriptionAttributeName, getDisplayNameAttribute, getDisplayNameAttributeName, getEnabledCapability, getHumanReadableName, getLifecycleState, getNamingAttribute, getNamingAttributeName, getObjectClassDefinition, getObjectClassName, getObjectMultiplicity, getPasswordDefinition, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, getPrismObjectDefinition, getProjectionPolicy, getProtectedObjectPatterns, getRawObjectClassDefinition, getResourceOid, getSearchHierarchyScope, getSecurityPolicyRef, getVolatility, hasAuxiliaryObjectClass, instantiate, isDefaultFor, matchesObjectClassName, replaceDefinition, replaceDefinition, toResourceAttributeContainerDefinition, toResourceAttributeContainerDefinition, validate

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

revive

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

accept

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

canRepresent, getCompileTimeClass, getInstantiationOrder, getStaticSubTypes, getSuperType, isAssignableFrom

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

accept

Method Detail

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

@NotNull
@NotNull ResourceObjectTypeIdentification getTypeIdentification()

Identification (kind+intent) of this object type.

Specified by:

getTypeIdentification in interface ResourceObjectDefinition

getTypeDefinition

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

getKind

@NotNull
@NotNull ShadowKindType getKind()

Kind of objects covered by this object type.

getIntent

@NotNull
@NotNull String getIntent()

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

matches

default boolean matches(@NotNull
                        @NotNull ShadowKindType kind,
                        @NotNull
                        @NotNull String intent)

Returns true if this object type matches specified (non-null) kind and intent.

matchesKind

default boolean matchesKind(@Nullable
                            @Nullable ShadowKindType kind)

Returns true if the type definition is of specified kind. Kind of `null` matches all definitions.

isDefaultForKind

boolean isDefaultForKind()

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

See Also:

ResourceObjectTypeDefinitionType.isDefaultForKind(), ResourceObjectTypeDefinitionType.isDefault()

isDefaultForObjectClass

boolean isDefaultForObjectClass()

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

See Also:

ResourceObjectTypeDefinitionType.isDefaultForObjectClass(), ResourceObjectTypeDefinitionType.isDefault()

forLayer

ResourceObjectTypeDefinition forLayer(@NotNull
                                      @NotNull LayerType layerType)

Description copied from interface: ResourceObjectDefinition

Creates a layer-specific version of this definition.

Specified by:

forLayer in interface ResourceObjectDefinition

getConfiguredCapability

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

Returns the configured capability of given class, if present.

getCorrelationDefinitionBean

@Nullable
@Nullable CorrelationDefinitionType getCorrelationDefinitionBean()

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

isSynchronizationEnabled

@Nullable
@Nullable Boolean isSynchronizationEnabled()

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

isSynchronizationOpportunistic

@Nullable
@Nullable Boolean isSynchronizationOpportunistic()

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

getFocusTypeName

@Nullable
@Nullable QName getFocusTypeName()

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

getArchetypeRef

@Nullable
@Nullable ObjectReferenceType getArchetypeRef()

Archetype reference - not present in standalone definitions.

getArchetypeOid

@Nullable
default @Nullable String getArchetypeOid()

Archetype OID - a convenience method.

hasSynchronizationReactionsDefinition

boolean hasSynchronizationReactionsDefinition()

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

getSynchronizationReactions

@NotNull
@NotNull Collection<SynchronizationReactionDefinition> getSynchronizationReactions()

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

getClassificationCondition

@Nullable
@Nullable ExpressionType getClassificationCondition()

Temporary?