Package com.evolveum.midpoint.common.refinery

Interface RefinedObjectClassDefinition

All Superinterfaces:

Cloneable, ComplexTypeDefinition, DebugDumpable, Definition, Freezable, LocalDefinitionStore, ObjectClassComplexTypeDefinition, PrismContextSensitive, Revivable, Serializable, SmartVisitable<Definition>, TypeDefinition, Visitable<Definition>

All Known Subinterfaces:

CompositeRefinedObjectClassDefinition, LayerRefinedObjectClassDefinition

All Known Implementing Classes:

CompositeRefinedObjectClassDefinitionImpl, LayerRefinedObjectClassDefinitionImpl, RefinedObjectClassDefinitionImpl

public interface RefinedObjectClassDefinition
extends ObjectClassComplexTypeDefinition

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
@NotNull RefinedObjectClassDefinition	clone()	Does a shallow clone of this definition (i.e.
default boolean	containsAttributeDefinition(@NotNull QName attributeName)
default boolean	containsAttributeDefinition(ItemPathType pathType)
PrismObject<ShadowType>	createBlankShadow(RefinedObjectClassDefinition definition, String tag)
default PrismObject<ShadowType>	createBlankShadow(String tag)
@NotNull RefinedObjectClassDefinition	deepClone(Map<QName,ComplexTypeDefinition> ctdMap, Map<QName,ComplexTypeDefinition> onThisPath, Consumer<ItemDefinition> postCloneAction)	Does a deep clone of this definition.
RefinedAssociationDefinition	findAssociationDefinition(QName name)
<X> RefinedAttributeDefinition<X>	findAttributeDefinition(@NotNull QName name)	Finds a attribute definition by looking at the property name.
default <X> RefinedAttributeDefinition<X>	findAttributeDefinition(String name)
LayerRefinedObjectClassDefinition	forLayer(@NotNull LayerType layerType)
ResourceBidirectionalMappingType	getActivationBidirectionalMappingType(QName propertyName)
AttributeFetchStrategyType	getActivationFetchStrategy(QName propertyName)
ResourceActivationDefinitionType	getActivationSchemaHandling()
default Collection<? extends RefinedAttributeDefinition<?>>	getAllIdentifiers()	Returns both primary and secondary identifiers.
@NotNull Collection<RefinedAssociationDefinition>	getAssociationDefinitions()	Returns definitions of all associations as an unmodifiable collection.
Collection<RefinedAssociationDefinition>	getAssociationDefinitions(ShadowKindType kind)
@NotNull Collection<? extends RefinedAttributeDefinition<?>>	getAttributeDefinitions()	Returns definitions of all attributes as an unmodifiable collection.
@NotNull Collection<RefinedObjectClassDefinition>	getAuxiliaryObjectClassDefinitions()
ResourceBidirectionalMappingAndDefinitionType	getAuxiliaryObjectClassMappings()
ResourceObjectReferenceType	getBaseContext()
CapabilitiesType	getCapabilities()	Returns configured capabilities for given refined object class definition.
String	getDebugDumpClassName()
String	getDescription()
<X> RefinedAttributeDefinition<X>	getDescriptionAttribute()	Returns the definition of description attribute of a resource object.
<X> RefinedAttributeDefinition<X>	getDisplayNameAttribute()	Returns the definition of display name attribute.
<T extends CapabilityType> T	getEffectiveCapability(Class<T> capabilityClass, ResourceType resourceType)
String	getHumanReadableName()
ResourceObjectMultiplicityType	getMultiplicity()
Collection<QName>	getNamesOfAssociations()
Collection<? extends QName>	getNamesOfAssociationsWithInboundExpressions()
Collection<? extends QName>	getNamesOfAssociationsWithOutboundExpressions()
Collection<? extends QName>	getNamesOfAttributesWithInboundExpressions()
Collection<? extends QName>	getNamesOfAttributesWithOutboundExpressions()
<X> RefinedAttributeDefinition<X>	getNamingAttribute()	TODO
ObjectClassComplexTypeDefinition	getObjectClassDefinition()
PrismObjectDefinition<ShadowType>	getObjectDefinition()
PagedSearchCapabilityType	getPagedSearches(ResourceType resourceType)
ResourcePasswordDefinitionType	getPasswordDefinition()
AttributeFetchStrategyType	getPasswordFetchStrategy()
List<MappingType>	getPasswordInbound()
List<MappingType>	getPasswordOutbound()
@NotNull Collection<? extends RefinedAttributeDefinition<?>>	getPrimaryIdentifiers()	Returns the definition of primary identifier attributes of a resource object.
ProjectionPolicyType	getProjection()
Collection<ResourceObjectPattern>	getProtectedObjectPatterns()
String	getResourceOid()
SearchHierarchyScope	getSearchHierarchyScope()
@NotNull Collection<? extends RefinedAttributeDefinition<?>>	getSecondaryIdentifiers()	Returns the definition of secondary identifier attributes of a resource object.
ObjectReferenceType	getSecurityPolicyRef()
ResourceShadowDiscriminator	getShadowDiscriminator()
ResourceObjectVolatilityType	getVolatility()
boolean	hasAuxiliaryObjectClass(QName expectedObjectClassName)
boolean	isDefault()
boolean	isObjectCountingEnabled(ResourceType resourceType)
boolean	isPagedSearchEnabled(ResourceType resourceType)
boolean	matches(ShadowType shadow)	Do not use.

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

containsItemDefinition, getDefaultNamespace, getDefinitions, getExtensionForType, getIgnoredNamespaces, hasSubstitutions, isContainerMarker, isEmpty, isItemDefinitionRemoved, isListMarker, isObjectMarker, isReferenceMarker, isShared, isXsdAnyMarker, itemOrSubstitution, merge, revive, substitution, 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, getDeprecatedSince, getDiagrams, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getProcessing, getSchemaMigrations, getSchemaRegistry, getTypeClass, getTypeClassIfKnown, 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.prism.LocalDefinitionStore

findContainerDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findNamedItemDefinition, findPropertyDefinition, findReferenceDefinition, findReferenceDefinition

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

createShadowSearchQuery, findAttributeDefinition, getIntent, getKind, getNativeObjectClass, hasIndexOnlyAttributes, instantiate, isAuxiliary, isDefaultInAKind, isIdentifier, isPrimaryIdentifier, isSecondaryIdentifier, toMutable, toResourceAttributeContainerDefinition, toResourceAttributeContainerDefinition

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

getPrismContext

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

getAttributeDefinitions

@NotNull
@NotNull Collection<? extends RefinedAttributeDefinition<?>> getAttributeDefinitions()

Returns definitions of all attributes as an unmodifiable collection. Note: content of this is exactly the same as for getDefinitions

Specified by:

getAttributeDefinitions in interface ObjectClassComplexTypeDefinition

containsAttributeDefinition

default boolean containsAttributeDefinition(ItemPathType pathType)

containsAttributeDefinition

default boolean containsAttributeDefinition(@NotNull
                                            @NotNull QName attributeName)

getNamesOfAttributesWithOutboundExpressions

Collection<? extends QName> getNamesOfAttributesWithOutboundExpressions()

getNamesOfAttributesWithInboundExpressions

Collection<? extends QName> getNamesOfAttributesWithInboundExpressions()

getPrimaryIdentifiers

@NotNull
@NotNull Collection<? extends RefinedAttributeDefinition<?>> getPrimaryIdentifiers()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns the definition of primary identifier attributes of a resource object. May return empty set if there are no identifier attributes. Must not return null. 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:

getPrimaryIdentifiers in interface ObjectClassComplexTypeDefinition

Returns:

definition of identifier attributes

getSecondaryIdentifiers

@NotNull
@NotNull Collection<? extends RefinedAttributeDefinition<?>> getSecondaryIdentifiers()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns the definition of secondary identifier attributes of a resource object. May return empty set if there are no secondary identifier attributes. Must not return null. 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:

getSecondaryIdentifiers in interface ObjectClassComplexTypeDefinition

Returns:

definition of secondary identifier attributes

getAllIdentifiers

default Collection<? extends RefinedAttributeDefinition<?>> getAllIdentifiers()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns both primary and secondary identifiers.

Specified by:

getAllIdentifiers in interface ObjectClassComplexTypeDefinition

getDescriptionAttribute

<X> RefinedAttributeDefinition<X> getDescriptionAttribute()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns the definition of description attribute of a resource object. Returns null if there is no description attribute. 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:

getDescriptionAttribute in interface ObjectClassComplexTypeDefinition

getNamingAttribute

<X> RefinedAttributeDefinition<X> getNamingAttribute()

Description copied from interface: ObjectClassComplexTypeDefinition

TODO

Specified by:

getNamingAttribute in interface ObjectClassComplexTypeDefinition

getDisplayNameAttribute

<X> RefinedAttributeDefinition<X> getDisplayNameAttribute()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns the definition of display name attribute. Display name attribute specifies which resource attribute should be used as title when displaying objects of a specific resource object class. It must point to an attribute of String type. If not present, primary identifier should be used instead (but this method does not handle this default behavior). Returns null if there is no display name attribute. 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:

getDisplayNameAttribute in interface ObjectClassComplexTypeDefinition

getAssociationDefinitions

@NotNull
@NotNull Collection<RefinedAssociationDefinition> getAssociationDefinitions()

Returns definitions of all associations as an unmodifiable collection. Note: these items are _not_ included in getDefinitions. (BTW, RefinedAssociationDefinition is not a subtype of ItemDefinition, not even of Definition.)

getAssociationDefinitions

Collection<RefinedAssociationDefinition> getAssociationDefinitions(ShadowKindType kind)

findAssociationDefinition

RefinedAssociationDefinition findAssociationDefinition(QName name)

getNamesOfAssociations

Collection<QName> getNamesOfAssociations()

getNamesOfAssociationsWithOutboundExpressions

Collection<? extends QName> getNamesOfAssociationsWithOutboundExpressions()

getNamesOfAssociationsWithInboundExpressions

Collection<? extends QName> getNamesOfAssociationsWithInboundExpressions()

getDescription

String getDescription()

getObjectClassDefinition

ObjectClassComplexTypeDefinition getObjectClassDefinition()

getResourceOid

String getResourceOid()

isDefault

boolean isDefault()

getBaseContext

ResourceObjectReferenceType getBaseContext()

getSearchHierarchyScope

SearchHierarchyScope getSearchHierarchyScope()

getHumanReadableName

String getHumanReadableName()

getVolatility

ResourceObjectVolatilityType getVolatility()

getMultiplicity

ResourceObjectMultiplicityType getMultiplicity()

getProjection

ProjectionPolicyType getProjection()

getObjectDefinition

PrismObjectDefinition<ShadowType> getObjectDefinition()

createBlankShadow

default PrismObject<ShadowType> createBlankShadow(String tag)

createBlankShadow

PrismObject<ShadowType> createBlankShadow(RefinedObjectClassDefinition definition,
                                          String tag)

getShadowDiscriminator

ResourceShadowDiscriminator getShadowDiscriminator()

matches

boolean matches(ShadowType shadow)

Description copied from interface: ObjectClassComplexTypeDefinition

Do not use. Unclear semantics. For synchronization tasks use com.evolveum.midpoint.model.impl.sync.SynchronizationObjectsFilter class instead.

Specified by:

matches in interface ObjectClassComplexTypeDefinition

getAuxiliaryObjectClassDefinitions

@NotNull
@NotNull Collection<RefinedObjectClassDefinition> getAuxiliaryObjectClassDefinitions()

hasAuxiliaryObjectClass

boolean hasAuxiliaryObjectClass(QName expectedObjectClassName)

getAuxiliaryObjectClassMappings

ResourceBidirectionalMappingAndDefinitionType getAuxiliaryObjectClassMappings()

getProtectedObjectPatterns

Collection<ResourceObjectPattern> getProtectedObjectPatterns()

getPasswordDefinition

ResourcePasswordDefinitionType getPasswordDefinition()

getPasswordInbound

List<MappingType> getPasswordInbound()

getPasswordOutbound

List<MappingType> getPasswordOutbound()

getPasswordFetchStrategy

AttributeFetchStrategyType getPasswordFetchStrategy()

getSecurityPolicyRef

ObjectReferenceType getSecurityPolicyRef()

getActivationSchemaHandling

ResourceActivationDefinitionType getActivationSchemaHandling()

getActivationBidirectionalMappingType

ResourceBidirectionalMappingType getActivationBidirectionalMappingType(QName propertyName)

getActivationFetchStrategy

AttributeFetchStrategyType getActivationFetchStrategy(QName propertyName)

getCapabilities

CapabilitiesType getCapabilities()

Returns configured capabilities for given refined object class definition. Returned object is freely modifiable copy of the original information.

getEffectiveCapability

<T extends CapabilityType> T getEffectiveCapability(Class<T> capabilityClass,
                                                    ResourceType resourceType)

getPagedSearches

PagedSearchCapabilityType getPagedSearches(ResourceType resourceType)

isPagedSearchEnabled

boolean isPagedSearchEnabled(ResourceType resourceType)

isObjectCountingEnabled

boolean isObjectCountingEnabled(ResourceType resourceType)

clone

@NotNull
@NotNull RefinedObjectClassDefinition clone()

Description copied from interface: ComplexTypeDefinition

Does a shallow clone of this definition (i.e. item definitions themselves are NOT cloned).

Specified by:

clone in interface ComplexTypeDefinition

Specified by:

clone in interface Definition

Specified by:

clone in interface ObjectClassComplexTypeDefinition

deepClone

@NotNull
@NotNull RefinedObjectClassDefinition deepClone(Map<QName,ComplexTypeDefinition> ctdMap,
                                                Map<QName,ComplexTypeDefinition> onThisPath,
                                                Consumer<ItemDefinition> postCloneAction)

Description copied from interface: ComplexTypeDefinition

Does a deep clone of this definition.

Specified by:

deepClone in interface ComplexTypeDefinition

Specified by:

deepClone in interface ObjectClassComplexTypeDefinition

Parameters:

ctdMap - Keeps already cloned definitions when 'ultra deep cloning' is not requested. Each definition is then cloned only once.

onThisPath - Keeps already cloned definitions on the path from root to current node; in order to prevent infinite loops when doing ultra deep cloning.

forLayer

LayerRefinedObjectClassDefinition forLayer(@NotNull
                                           @NotNull LayerType layerType)

findAttributeDefinition

<X> RefinedAttributeDefinition<X> findAttributeDefinition(@NotNull
                                                          @NotNull QName name)

Description copied from interface: ObjectClassComplexTypeDefinition

Finds a attribute definition by looking at the property name.

Returns null if nothing is found.

Specified by:

findAttributeDefinition in interface ObjectClassComplexTypeDefinition

Parameters:

name - property definition name

Returns:

found property definition or null

findAttributeDefinition

default <X> RefinedAttributeDefinition<X> findAttributeDefinition(String name)

Specified by:

findAttributeDefinition in interface ObjectClassComplexTypeDefinition

getDebugDumpClassName

String getDebugDumpClassName()