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

Interface ResourceObjectClassDefinitionDelegator

All Superinterfaces:

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

All Known Implementing Classes:

TransformableComplexTypeDefinition.TrResourceObjectClassDefinition

public interface ResourceObjectClassDefinitionDelegator
extends ResourceObjectDefinitionDelegator, ResourceObjectClassDefinition

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<ResourceObjectDefinition>	getAuxiliaryDefinitions()	TODO define semantics (it's different for CompositeObjectDefinition and the others!
default String	getNativeObjectClass()	Returns the native object class name.
default boolean	hasRefinements()	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).
default ResourceAttributeContainer	instantiate(ItemName elementName)	Creates a ResourceAttributeContainer instance with this definition as its complex type definition.
default boolean	isAuxiliary()	TODO
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.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

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

clone, deepClone, toMutable

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

getActivationBidirectionalMappingType, getActivationFetchStrategy, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, matchesObjectClassName, replaceDefinition

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

createBlankShadow, findAttributeDefinition, findAttributeDefinition, forLayerImmutable, forLayerMutable, 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, getTypeDefinition, getTypeIdentification, getVolatility, hasAuxiliaryObjectClass, isDefaultFor, isPrimaryIdentifier, isSecondaryIdentifier, replaceDefinition, toResourceAttributeContainerDefinition, toResourceAttributeContainerDefinition, validate

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

ResourceObjectClassDefinition 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

getNativeObjectClass

default String getNativeObjectClass()

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:

getNativeObjectClass in interface ResourceObjectClassDefinition

Returns:

native object class

isAuxiliary

default boolean isAuxiliary()

Description copied from interface: ResourceObjectClassDefinition

TODO

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

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

Specified by:

instantiate in interface ResourceObjectDefinition