Interface ResourceObjectTypeDefinition
- All Superinterfaces:
AbstractTypeDefinition
,AssociationDefinitionStore
,AttributeDefinitionStore
,Cloneable
,DebugDumpable
,Definition
,FrameworkNameResolver
,Freezable
,IdentifiersDefinitionStore
,LayeredDefinition
,LocalItemDefinitionStore
,PrismLifecycleDefinition
,PrismPresentationDefinition
,ResourceObjectDefinition
,ResourceObjectInboundDefinition
,Revivable
,Serializable
,SmartVisitable<Definition>
,TypeDefinition
,Visitable<Definition>
- All Known Subinterfaces:
ResourceObjectTypeDefinitionDelegator
- All Known Implementing Classes:
ResourceObjectTypeDefinitionImpl
Definition of "resource object type". Roughly corresponds to an `objectType` section in `schemaHandling`
part of resource definition.
-
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.AssociationProcessingImplementation, ResourceObjectInboundDefinition.BeanBasedItemImplementation, ResourceObjectInboundDefinition.ComplexProcessingImplementation, 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 TypeMethodDescriptiondefault @NotNull ObjectQuery
createShadowSearchQuery
(String resourceOid) Creates a query for obtaining shadows related to this object class or object type.@NotNull ResourceObjectTypeDefinition
forLayerMutable
(@NotNull LayerType layer) Creates a layer-specific mutable version of this definition.@NotNull Set<ResourceObjectTypeIdentification>
Returns the identification of all ancestors.default @Nullable String
Archetype OID - a convenience method.@Nullable ObjectReferenceType
Archetype reference - not present in standalone definitions.@Nullable ExpressionType
Temporary?<T extends CapabilityType>
TgetConfiguredCapability
(Class<T> capabilityClass) Returns the configured capability of given class, if present.@Nullable CorrelationDefinitionType
Returns the correlation definition bean, if present here.@Nullable QName
Returns the focus type name, if present here.@NotNull String
Intent defining this object type (along withgetKind()
).@NotNull ShadowKindType
getKind()
Kind of objects covered by this object type.@NotNull Collection<? extends SynchronizationReactionDefinition.ObjectSynchronizationReactionDefinition>
Returns the synchronization reactions defined here.@NotNull ResourceObjectTypeDefinition
Is this definition bound to a specific resource type? If yes, this method returns its definition.@NotNull ResourceObjectTypeIdentification
Identification (kind+intent) of this object type.boolean
Returns true if there is "synchronization reactions" definition section here (even if it's empty).boolean
Is this type explicitly marked as the default object type for given kind? (using default or defaultForKind property).boolean
Is this type explicitly marked as the default object type for given object class? (using default or defaultForObjectClass property).@Nullable Boolean
Returns the "synchronization enabled" flag value, if present here.@Nullable Boolean
Returns the "synchronization opportunistic" flag value, if present here.default boolean
isThisOrDescendantOf
(@NotNull ResourceObjectTypeIdentification identification) default boolean
isThisOrDescendantOf
(@NotNull Collection<? extends ResourceObjectTypeIdentification> identifications) 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.prism.AbstractTypeDefinition
getTypeName
Methods inherited from interface com.evolveum.midpoint.schema.processor.AssociationDefinitionStore
findAssociationDefinitionRequired, findAssociationDefinitionRequired, getNamesOfAssociations
Methods inherited from interface com.evolveum.midpoint.schema.processor.AttributeDefinitionStore
containsAttributeDefinition, findAttributeDefinition, findAttributeDefinition, findShadowAttributeDefinitionRequired, findSimpleAttributeDefinition, findSimpleAttributeDefinition, findSimpleAttributeDefinition, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionStrictlyRequired, findSimpleAttributeDefinitionStrictlyRequired, getAllSimpleAttributesNames, getAttributeDefinitions, getAttributeDefinitions, 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, 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.ResourceObjectDefinition
assertAttached, canRepresent, clone, composite, createBlankShadow, createBlankShadowWithPrimaryId, createBlankShadowWithTag, deepClone, findReferenceAttributeDefinition, forLayerImmutable, getActivationBidirectionalMappingType, getActivationFetchStrategy, getActivationSchemaHandling, getAssociationsComplexTypeDefinition, getAttributesComplexTypeDefinition, getAuxiliaryDefinitions, getAuxiliaryObjectClassMappings, getBaseContext, getBasicResourceInformation, getCompileTimeClass, getConfiguredAuxiliaryObjectClassNames, getDebugDumpClassName, getDefaultInboundMappingEvaluationPhases, getDefinitionBean, getDelineation, getDescription, getDescriptionAttribute, getDescriptionAttributeName, getDisplayNameAttribute, getDisplayNameAttributeName, getEffectiveShadowCachingPolicy, getEnabledCapability, getHumanReadableName, getIdentification, getInstantiationOrder, getLifecycleState, getNamingAttribute, getNamingAttributeName, getNativeObjectClassDefinition, getObjectClassDefinition, getObjectClassLocalName, getObjectClassName, getObjectMultiplicity, getPasswordDefinition, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, getPrismObjectDefinition, getProjectionPolicy, getProtectedObjectPatterns, getReferenceAttributeDefinitions, getResourceOid, getSearchHierarchyScope, getSecurityPolicyRef, getShortIdentification, getStaticSubTypes, getSuperType, getVolatility, hasAuxiliaryObjectClass, isDefaultFor, matchesObjectClassName, replaceDefinition, replaceDefinition, toPrismObjectDefinition, toResourceAttributeContainerDefinition, toShadowAssociationsContainerDefinition, trimTo, validate
Methods inherited from interface com.evolveum.midpoint.schema.processor.ResourceObjectInboundDefinition
getAssociationInboundDefinition, getAttributeInboundDefinition, getCorrelation, getDefaultObjectRefDefinition, getFocusSpecification, hasAnyInbounds
Methods inherited from interface com.evolveum.midpoint.prism.SmartVisitable
accept
Methods inherited from interface com.evolveum.midpoint.prism.TypeDefinition
isAssignableFrom
-
Method Details
-
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 interfaceResourceObjectDefinition
- Throws:
SchemaException
-
getTypeIdentification
Identification (kind+intent) of this object type.- Specified by:
getTypeIdentification
in interfaceResourceObjectDefinition
-
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 interfaceResourceObjectDefinition
-
getKind
Kind of objects covered by this object type. -
getIntent
Intent defining this object type (along withgetKind()
). -
getAncestorsIds
Returns the identification of all ancestors. This type is not included in the list. -
matches
Returns true if this object type matches specified (non-null) kind and intent. -
isThisOrDescendantOf
default boolean isThisOrDescendantOf(@NotNull @NotNull ResourceObjectTypeIdentification identification) -
isThisOrDescendantOf
default boolean isThisOrDescendantOf(@NotNull @NotNull Collection<? extends ResourceObjectTypeIdentification> identifications) -
matchesKind
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). -
isDefaultForObjectClass
boolean isDefaultForObjectClass()Is this type explicitly marked as the default object type for given object class? (using default or defaultForObjectClass property). -
forLayerMutable
Description copied from interface:ResourceObjectDefinition
Creates a layer-specific mutable version of this definition.- Specified by:
forLayerMutable
in interfaceResourceObjectDefinition
-
getConfiguredCapability
Returns the configured capability of given class, if present. -
getCorrelationDefinitionBean
Returns the correlation definition bean, if present here. (It may be standalone.) -
isSynchronizationEnabled
Returns the "synchronization enabled" flag value, if present here. (It may be standalone.) FIXME -
isSynchronizationOpportunistic
Returns the "synchronization opportunistic" flag value, if present here. (It may be standalone.) -
getFocusTypeName
Returns the focus type name, if present here. (It may be standalone.) -
getArchetypeRef
Archetype reference - not present in standalone definitions. -
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<? extends SynchronizationReactionDefinition.ObjectSynchronizationReactionDefinition> getSynchronizationReactions()Returns the synchronization reactions defined here. (They may be standalone.)- Specified by:
getSynchronizationReactions
in interfaceResourceObjectInboundDefinition
-
getClassificationCondition
Temporary?
-