Package com.evolveum.midpoint.schema.processor

Class ResourceObjectClassDefinitionImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.schema.processor.AbstractResourceObjectDefinitionImpl

com.evolveum.midpoint.schema.processor.ResourceObjectClassDefinitionImpl

All Implemented Interfaces:

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

public class ResourceObjectClassDefinitionImpl
extends AbstractResourceObjectDefinitionImpl
implements ResourceObjectClassDefinition

Default implementation of ResourceObjectClassDefinition. TODO should we have subclasses for raw/refined variants? Maybe.

Author:

semancik

See Also:

• Serialized Form

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 class com.evolveum.midpoint.schema.processor.AbstractResourceObjectDefinitionImpl

delineation

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
protected void	addDebugDumpHeaderExtension(StringBuilder sb)
protected void	addDebugDumpTrailer(StringBuilder sb, int indent)
@NotNull ResourceObjectClassDefinitionImpl	clone()	Returns a mutable definition.
protected @NotNull ResourceObjectClassDefinitionImpl	cloneInLayer(@NotNull LayerType layer)	Returns mutable copy.
static ResourceObjectClassDefinitionImpl	create(@NotNull BasicResourceInformation basicResourceInformation, @NotNull NativeObjectClassDefinition nativeObjectClassDefinition, @Nullable ResourceObjectTypeDefinitionType definitionBean)
@NotNull ObjectQuery	createShadowSearchQuery(String resourceOid)	Creates a query for obtaining shadows related to this object class.
@NotNull ResourceObjectClassDefinition	deepClone(@NotNull DeepCloneOperation operation)	Returns a mutable definition.
boolean	equals(Object o)
String	getDebugDumpClassName()	Return a human readable name of this class suitable for logs.
@Nullable QName	getDescriptionAttributeName()	Returns name of the description attribute.
@Nullable QName	getDisplayNameAttributeName()	Returns name of the display name attribute.
@NotNull ResourceObjectInboundDefinition.FocusSpecification	getFocusSpecification()
String	getHumanReadableName()	TODO
@Nullable QName	getNamingAttributeName()	Returns name of the naming attribute.
@NotNull NativeObjectClassDefinition	getNativeObjectClassDefinition()	Returns the [structural] native object class definition, typically obtained from the connector.
String	getNativeObjectClassName()	Returns the native object class name.
@NotNull ResourceObjectClassDefinition	getObjectClassDefinition()	Returns the [structural] object class definition.
@NotNull QName	getObjectClassName()	Returns the name of the object class.
@Nullable ResourcePasswordDefinitionType	getPasswordDefinition()	See ResourceObjectTypeDefinitionType.getCredentials()
ObjectReferenceType	getSecurityPolicyRef()
@NotNull String	getShortIdentification()	Very short identification, like the object class local name or the kind/intent pair.
@NotNull Collection<? extends SynchronizationReactionDefinition>	getSynchronizationReactions()
@Nullable ResourceObjectTypeDefinition	getTypeDefinition()	Is this definition bound to a specific resource type? If yes, this method returns its definition.
@Nullable ResourceObjectTypeIdentification	getTypeIdentification()	Is this definition bound to a specific resource type? If yes, this method returns its identification.
boolean	hasAnyInbounds()
int	hashCode()
boolean	hasRefinements()	Returns `true` if there are really any refinements (i.e.
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.
boolean	isDefaultAccountDefinition()	Indicates whether definition is the default account definition.
boolean	isDefaultFor(@NotNull ShadowKindType kind)	Returns true if this definition can be considered as a default for the specified kind.
boolean	isRaw()	Returns `true` if this definition is a part of the raw schema.
void	setInstantiationOrder(Integer order)
String	toString()

Methods inherited from class com.evolveum.midpoint.schema.processor.AbstractResourceObjectDefinitionImpl

accept, accept, add, copyDefinitionDataFrom, debugDump, debugDump, findItemDefinition, findSimpleAttributeDefinition, forLayerImmutable, forLayerMutable, getActivationSchemaHandling, getAnnotation, getAnnotations, getAssociationInboundDefinition, getAttributeDefinitions, getAttributeInboundDefinition, getAuxiliaryDefinitions, getAuxiliaryObjectClassMappings, getBaseContext, getBasicResourceInformation, getConfiguredAuxiliaryObjectClassNames, getCorrelation, getCurrentLayer, getDefaultInboundMappingEvaluationPhases, getDefinitionBean, getDefinitions, getDelineation, getDeprecatedSince, getDescription, getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getEffectiveShadowCachingPolicy, getEnabledCapability, getHelp, getLifecycleState, getMergerIdentifier, getMergerInstance, getNaturalKeyConstituents, getNaturalKeyInstance, getObjectMultiplicity, getPlannedRemoval, getPrimaryIdentifiers, getPrimaryIdentifiersNames, getPrismObjectDefinition, getProjectionPolicy, getProtectedObjectPatterns, getRemovedSince, getSchemaMigrations, getSearchHierarchyScope, getSecondaryIdentifiers, getSecondaryIdentifiersNames, getTypeClass, getTypeName, getVolatility, hasAuxiliaryObjectClass, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isOptionalCleanup, isRemoved, isRuntimeSchema, mutator, performFreeze, replaceDefinition, resolveFrameworkName, revive, trimTo, validate

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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, composite, createBlankShadow, createBlankShadowWithPrimaryId, createBlankShadowWithTag, findReferenceAttributeDefinition, forLayerImmutable, forLayerMutable, getActivationBidirectionalMappingType, getActivationFetchStrategy, getActivationSchemaHandling, getAssociationsComplexTypeDefinition, getAttributesComplexTypeDefinition, getAuxiliaryDefinitions, getAuxiliaryObjectClassMappings, getBaseContext, getBasicResourceInformation, getCompileTimeClass, getConfiguredAuxiliaryObjectClassNames, getDefaultInboundMappingEvaluationPhases, getDefinitionBean, getDelineation, getDescription, getDescriptionAttribute, getDisplayNameAttribute, getEffectiveShadowCachingPolicy, getEnabledCapability, getIdentification, getInstantiationOrder, getLifecycleState, getNamingAttribute, getObjectClassLocalName, getObjectMultiplicity, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, getPrismObjectDefinition, getProjectionPolicy, getProtectedObjectPatterns, getReferenceAttributeDefinitions, getResourceOid, getSearchHierarchyScope, getStaticSubTypes, getSuperType, getVolatility, hasAuxiliaryObjectClass, matchesObjectClassName, replaceDefinition, replaceDefinition, toPrismObjectDefinition, toResourceAttributeContainerDefinition, toShadowAssociationsContainerDefinition, trimTo, validate

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

getAssociationInboundDefinition, getAttributeInboundDefinition, getCorrelation, 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

create

public static ResourceObjectClassDefinitionImpl create(@NotNull
 @NotNull BasicResourceInformation basicResourceInformation,
 @NotNull
 @NotNull NativeObjectClassDefinition nativeObjectClassDefinition,
 @Nullable
 @Nullable ResourceObjectTypeDefinitionType definitionBean)
                                                throws ConfigurationException,
SchemaException

Throws:

ConfigurationException

SchemaException

getObjectClassName

@NotNull
public @NotNull QName getObjectClassName()

Description copied from interface: ResourceObjectDefinition

Returns the name of the object class. Always fully qualified; currently with the SchemaConstants.NS_RI namespace.

Specified by:

getObjectClassName in interface ResourceObjectDefinition

getObjectClassDefinition

@NotNull
public @NotNull ResourceObjectClassDefinition getObjectClassDefinition()

Description copied from interface: ResourceObjectDefinition

Returns the [structural] object class definition.

Specified by:

getObjectClassDefinition in interface ResourceObjectDefinition

getNativeObjectClassDefinition

@NotNull
public @NotNull NativeObjectClassDefinition getNativeObjectClassDefinition()

Description copied from interface: ResourceObjectDefinition

Returns the [structural] native object class definition, typically obtained from the connector.

Specified by:

getNativeObjectClassDefinition in interface ResourceObjectDefinition

getNamingAttributeName

@Nullable
public @Nullable QName getNamingAttributeName()

Description copied from interface: ResourceObjectDefinition

Returns name of the naming attribute.

Specified by:

getNamingAttributeName in interface ResourceObjectDefinition

See Also:

• ResourceObjectDefinition.getNamingAttributeName()

getDisplayNameAttributeName

@Nullable
public @Nullable QName getDisplayNameAttributeName()

Description copied from interface: ResourceObjectDefinition

Returns name of the display name attribute.

Specified by:

getDisplayNameAttributeName in interface ResourceObjectDefinition

getDescriptionAttributeName

@Nullable
public @Nullable QName getDescriptionAttributeName()

Description copied from interface: ResourceObjectDefinition

Returns name of the description attribute.

Specified by:

getDescriptionAttributeName in interface ResourceObjectDefinition

See Also:

• ResourceObjectDefinition.getDescriptionAttribute()

getNativeObjectClassName

public 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

public 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

public 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

clone

@NotNull
public @NotNull ResourceObjectClassDefinitionImpl clone()

Description copied from interface: ResourceObjectDefinition

Returns a mutable definition. BEWARE, the mutable CompositeObjectDefinition is significantly slower than its immutable counterpart. See MID-9156.

Specified by:

clone in interface Definition

Specified by:

clone in interface ResourceObjectClassDefinition

Specified by:

clone in interface ResourceObjectDefinition

Specified by:

clone in class AbstractResourceObjectDefinitionImpl

cloneInLayer

@NotNull
protected @NotNull ResourceObjectClassDefinitionImpl cloneInLayer(@NotNull
 @NotNull LayerType layer)

Description copied from class: AbstractResourceObjectDefinitionImpl

Returns mutable copy.

Specified by:

cloneInLayer in class AbstractResourceObjectDefinitionImpl

setInstantiationOrder

public void setInstantiationOrder(Integer order)

deepClone

@NotNull
public @NotNull ResourceObjectClassDefinition deepClone(@NotNull
 @NotNull DeepCloneOperation operation)

Description copied from interface: ResourceObjectDefinition

Returns a mutable definition. BEWARE, the mutable CompositeObjectDefinition is significantly slower than its immutable counterpart. See MID-9156.

Specified by:

deepClone in interface ResourceObjectClassDefinition

Specified by:

deepClone in interface ResourceObjectDefinition

getSecurityPolicyRef

public ObjectReferenceType getSecurityPolicyRef()

Specified by:

getSecurityPolicyRef in interface ResourceObjectDefinition

Overrides:

getSecurityPolicyRef in class AbstractResourceObjectDefinitionImpl

See Also:

• ResourceObjectTypeDefinitionType.getSecurityPolicyRef()

isRaw

public 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

public 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

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractResourceObjectDefinitionImpl

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractResourceObjectDefinitionImpl

getPasswordDefinition

@Nullable
public @Nullable ResourcePasswordDefinitionType getPasswordDefinition()

Description copied from interface: ResourceObjectDefinition

See ResourceObjectTypeDefinitionType.getCredentials()

Specified by:

getPasswordDefinition in interface ResourceObjectDefinition

Overrides:

getPasswordDefinition in class AbstractResourceObjectDefinitionImpl

createShadowSearchQuery

@NotNull
public @NotNull ObjectQuery createShadowSearchQuery(String resourceOid)

Description copied from interface: ResourceObjectClassDefinition

Creates a query for obtaining shadows related to this object class.

Specified by:

createShadowSearchQuery in interface ResourceObjectClassDefinition

Specified by:

createShadowSearchQuery in interface ResourceObjectDefinition

getHumanReadableName

public String getHumanReadableName()

Description copied from interface: ResourceObjectDefinition

TODO

Specified by:

getHumanReadableName in interface ResourceObjectDefinition

getTypeIdentification

@Nullable
public @Nullable 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

getTypeDefinition

@Nullable
public @Nullable 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

isDefaultFor

public 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

toString

public String toString()

Overrides:

toString in class Object

getDebugDumpClassName

public String getDebugDumpClassName()

Description copied from interface: ResourceObjectDefinition

Return a human readable name of this class suitable for logs.

Specified by:

getDebugDumpClassName in interface ResourceObjectDefinition

addDebugDumpHeaderExtension

protected void addDebugDumpHeaderExtension(StringBuilder sb)

Overrides:

addDebugDumpHeaderExtension in class AbstractResourceObjectDefinitionImpl

addDebugDumpTrailer

protected void addDebugDumpTrailer(StringBuilder sb,
 int indent)

Overrides:

addDebugDumpTrailer in class AbstractResourceObjectDefinitionImpl

getShortIdentification

@NotNull
public @NotNull String getShortIdentification()

Description copied from interface: ResourceObjectDefinition

Very short identification, like the object class local name or the kind/intent pair.

Specified by:

getShortIdentification in interface ResourceObjectDefinition

getFocusSpecification

@NotNull
public @NotNull ResourceObjectInboundDefinition.FocusSpecification getFocusSpecification()

Specified by:

getFocusSpecification in interface ResourceObjectInboundDefinition

getSynchronizationReactions

@NotNull
public @NotNull Collection<? extends SynchronizationReactionDefinition> getSynchronizationReactions()

Specified by:

getSynchronizationReactions in interface ResourceObjectInboundDefinition

hasAnyInbounds

public boolean hasAnyInbounds()

Specified by:

hasAnyInbounds in interface ResourceObjectInboundDefinition