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

Interface ResourceObjectClassDefinitionDelegator

All Superinterfaces:

AbstractTypeDefinition, AssociationDefinitionStore, AttributeDefinitionStore, Cloneable, DebugDumpable, Definition, FrameworkNameResolver, Freezable, IdentifiersDefinitionStore, LayeredDefinition, LocalItemDefinitionStore, PrismLifecycleDefinition, PrismPresentationDefinition, ResourceObjectClassDefinition, ResourceObjectDefinition, ResourceObjectDefinitionDelegator, ResourceObjectInboundDefinition, Revivable, Serializable, SmartVisitable<Definition>, TypeDefinition, Visitable<Definition>

public interface ResourceObjectClassDefinitionDelegator
extends ResourceObjectDefinitionDelegator, ResourceObjectClassDefinition

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

ResourceObjectClassDefinition.ResourceObjectClassDefinitionMutator

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 Type	Method	Description
default @NotNull ObjectQuery	createShadowSearchQuery(String resourceOid)	Creates a query for obtaining shadows related to this object class or object type.
ResourceObjectClassDefinition	delegate()
default @NotNull Collection<? extends ResourceObjectDefinition>	getAuxiliaryDefinitions()	TODO define semantics (it's different for CompositeObjectDefinition and the others!
default @Nullable QName	getDescriptionAttributeName()	Returns name of the description attribute.
default @Nullable QName	getDisplayNameAttributeName()	Returns name of the display name attribute.
default @Nullable QName	getNamingAttributeName()	Returns name of the naming attribute.
default String	getNativeObjectClassName()	Returns the native object class name.
default boolean	hasRefinements()	Returns `true` if there are really any refinements (i.e.
default boolean	isAuxiliary()	Is this an auxiliary object class, i.e., a class that can be attached to an object that already holds the structural object class? This is originally an LDAP concept, but it may be applicable to other systems as well.
default boolean	isDefaultAccountDefinition()	Indicates whether definition is the default account definition.
default boolean	isRaw()	Returns `true` if this definition is a part of the raw schema.

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, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionRequired, findSimpleAttributeDefinitionStrictlyRequired, findSimpleAttributeDefinitionStrictlyRequired, getAllSimpleAttributesNames, getAttributeDefinitions, getAttributeDefinitions, 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.prism.Freezable

checkImmutable, checkMutable, freeze, isImmutable

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

getAllIdentifiers, getAllIdentifiersNames, getPrimaryIdentifierRequired, getSecondaryIdentifierRequired, isIdentifier

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

clone, deepClone

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

assertAttached, canRepresent, composite, createBlankShadow, createBlankShadowWithPrimaryId, findReferenceAttributeDefinition, getActivationBidirectionalMappingType, getActivationFetchStrategy, getAssociationsComplexTypeDefinition, getAttributesComplexTypeDefinition, getCompileTimeClass, getIdentification, getInstantiationOrder, getNamingAttribute, getObjectClassLocalName, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, getResourceOid, getStaticSubTypes, getSuperType, matchesObjectClassName, replaceDefinition, toPrismObjectDefinition, toResourceAttributeContainerDefinition, toShadowAssociationsContainerDefinition, trimTo

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

createBlankShadowWithTag, findSimpleAttributeDefinition, findSimpleAttributeDefinition, forLayerImmutable, forLayerMutable, getActivationSchemaHandling, getAssociationInboundDefinition, getAttributeInboundDefinition, getAuxiliaryObjectClassMappings, getBaseContext, getBasicResourceInformation, getConfiguredAuxiliaryObjectClassNames, getCorrelation, getCurrentLayer, getDebugDumpClassName, getDefaultInboundMappingEvaluationPhases, getDefinitionBean, getDelineation, getDescription, getDescriptionAttribute, getDisplayNameAttribute, getEffectiveShadowCachingPolicy, getEnabledCapability, getFocusSpecification, getHumanReadableName, getLifecycleState, getNativeObjectClassDefinition, getObjectClassDefinition, getObjectClassName, getObjectMultiplicity, getPasswordDefinition, getPrimaryIdentifiers, getPrimaryIdentifiersNames, getPrismObjectDefinition, getProjectionPolicy, getProtectedObjectPatterns, getReferenceAttributeDefinitions, getSearchHierarchyScope, getSecondaryIdentifiers, getSecondaryIdentifiersNames, getSecurityPolicyRef, getShortIdentification, getSimpleAttributeDefinitions, getSynchronizationReactions, getTypeDefinition, getTypeIdentification, getVolatility, hasAnyInbounds, hasAuxiliaryObjectClass, isDefaultFor, isPrimaryIdentifier, isSecondaryIdentifier, replaceDefinition, resolveFrameworkName, validate

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

getDefaultObjectRefDefinition

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

isAssignableFrom

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

accept

Method Details

delegate

ResourceObjectClassDefinition delegate()

Specified by:

delegate in interface ResourceObjectDefinitionDelegator

getNativeObjectClassName

default String getNativeObjectClassName()

Description copied from interface: ResourceObjectClassDefinition

Returns the native object class name. Native object class is the name of the object class as it is seen by the resource itself. The name of the object class used in midPoint may be constrained by XSD or other syntax and therefore may be "mangled" to conform to such syntax. The _native object class_ value will contain original, un-mangled name (if available). Returns null if there is no native object class. 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:

getNativeObjectClassName in interface ResourceObjectClassDefinition

Returns:

native object class

isAuxiliary

default boolean isAuxiliary()

Description copied from interface: ResourceObjectClassDefinition

Is this an auxiliary object class, i.e., a class that can be attached to an object that already holds the structural object class? This is originally an LDAP concept, but it may be applicable to other systems as well.

Specified by:

isAuxiliary in interface ResourceObjectClassDefinition

isDefaultAccountDefinition

default boolean isDefaultAccountDefinition()

Description copied from interface: ResourceObjectClassDefinition

Indicates whether definition is the default account definition. (This feature is present for "dumb" resource definition that are completely without `schemaHandling` part.) This is a way how a resource connector may suggest applicable object classes. Currently the only use of this flag is that ConnId `pass:[__ACCOUNT__]` is declared as a default for the kind of `ACCOUNT`. Originally, this property was called `defaultInAKind` and marked the object class as being default for given kind. At that time, the kind was part of object class definition. This is no longer the case, therefore also this property is renamed - and is available only for account-like object classes. In the future we may put those things (kind + default-in-a-kind) back, if needed.

Specified by:

isDefaultAccountDefinition in interface ResourceObjectClassDefinition

isRaw

default boolean isRaw()

Description copied from interface: ResourceObjectClassDefinition

Returns `true` if this definition is a part of the raw schema. Note that if it's part of refined schema (but not refined in any way) the return value is `true`. See also ResourceObjectClassDefinition.hasRefinements().

Specified by:

isRaw in interface ResourceObjectClassDefinition

hasRefinements

default boolean hasRefinements()

Description copied from interface: ResourceObjectClassDefinition

Returns `true` if there are really any refinements (i.e. a refinement bean exists, even if it can be effectively empty, besides obligatory object class name reference).

Specified by:

hasRefinements in interface ResourceObjectClassDefinition

getNamingAttributeName

@Nullable
default @Nullable QName getNamingAttributeName()

Description copied from interface: ResourceObjectDefinition

Returns name of the naming attribute.

Specified by:

getNamingAttributeName in interface ResourceObjectDefinition

Specified by:

getNamingAttributeName in interface ResourceObjectDefinitionDelegator

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

Specified by:

getDisplayNameAttributeName in interface ResourceObjectDefinitionDelegator

getDescriptionAttributeName

@Nullable
default @Nullable QName getDescriptionAttributeName()

Description copied from interface: ResourceObjectDefinition

Returns name of the description attribute.

Specified by:

getDescriptionAttributeName in interface ResourceObjectDefinition

Specified by:

getDescriptionAttributeName in interface ResourceObjectDefinitionDelegator

See Also:

• ResourceObjectDefinition.getDescriptionAttribute()

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 ResourceObjectClassDefinition

Specified by:

createShadowSearchQuery in interface ResourceObjectDefinition

Specified by:

createShadowSearchQuery in interface ResourceObjectDefinitionDelegator

Throws:

SchemaException

getAuxiliaryDefinitions

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

Description copied from interface: ResourceObjectDefinition

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

Specified by:

getAuxiliaryDefinitions in interface ResourceObjectDefinition