Package com.evolveum.midpoint.schema.processor

Class CompositeObjectDefinitionImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.schema.processor.CompositeObjectDefinitionImpl

All Implemented Interfaces:

ComplexTypeDefinition, Definition, Freezable, LocalItemDefinitionStore, PrismContextSensitive, Revivable, SmartVisitable<Definition>, TypeDefinition, Visitable<Definition>, AssociationDefinitionStore, AttributeDefinitionStore, CompositeObjectDefinition, IdentifiersDefinitionStore, LayeredDefinition, ResourceObjectDefinition, DebugDumpable, Serializable, Cloneable

public class CompositeObjectDefinitionImpl
extends AbstractFreezable
implements CompositeObjectDefinition

Used to represent combined definition of structural and auxiliary object classes.

Author:

semancik

See Also:

Serialized Form

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
CompositeObjectDefinitionImpl(@NotNull ResourceObjectDefinition structuralDefinition, @Nullable Collection<ResourceObjectDefinition> auxiliaryDefinitions)

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor<Definition> visitor)
boolean	accept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)
boolean	canRepresent(QName typeName)
@NotNull CompositeObjectDefinitionImpl	clone()	Does a shallow clone of this definition (i.e.
PrismObject<ShadowType>	createBlankShadow(String resourceOid, String tag)	Creates a blank ShadowType object, with the attributes container having appropriate definition.
@NotNull ObjectQuery	createShadowSearchQuery(String resourceOid)	Creates a query for obtaining shadows related to this object class or object type.
String	debugDump(int indent)
protected String	debugDump(int indent, LayerType layer)
@NotNull CompositeObjectDefinitionImpl	deepClone(@NotNull DeepCloneOperation operation)	Does a deep clone of this definition.
boolean	equals(Object obj)
<ID extends ItemDefinition<?>> ID	findItemDefinition(@NotNull ItemPath path, @NotNull Class<ID> clazz)	Returns a definition of given type corresponding to given path (rooted at this store).
CompositeObjectDefinition	forLayer(@NotNull LayerType layer)	Creates a layer-specific version of this definition.
ResourceActivationDefinitionType	getActivationSchemaHandling()
<A> A	getAnnotation(QName qname)	Returns generic definition annotation.
@Nullable Map<QName,Object>	getAnnotations()	Returns all annotations, as unmodifiable map.
@NotNull Collection<ResourceAssociationDefinition>	getAssociationDefinitions()	Returns definitions of all associations as an unmodifiable collection.
@NotNull List<? extends ResourceAttributeDefinition<?>>	getAttributeDefinitions()	Returns all attribute definitions as an unmodifiable collection.
@NotNull Collection<ResourceObjectDefinition>	getAuxiliaryDefinitions()	Returns auxiliary definitions.
ResourceBidirectionalMappingAndDefinitionType	getAuxiliaryObjectClassMappings()
ResourceObjectReferenceType	getBaseContext()	The definition of base context (resource object container).
Class<?>	getCompileTimeClass()	Returns compile-time class, if this type has any.
@Nullable CapabilitiesType	getConfiguredCapabilities()	Returns configured capabilities for given refined object class definition.
@NotNull LayerType	getCurrentLayer()	Gets the current point-of-view: on which layer do we look at the data?
String	getDebugDumpClassName()	Return a human readable name of this class suitable for logs.
@Nullable DefaultInboundMappingEvaluationPhasesType	getDefaultInboundMappingEvaluationPhases()	Returns the phases in which inbound mappings are evaluated by default.
String	getDefaultNamespace()	When resolving unqualified names for items contained in this CTD, what should be the default namespace to look into at first.
@NotNull List<? extends ItemDefinition<?>>	getDefinitions()	Returns definitions for all inner items.
String	getDeprecatedSince()
String	getDescription()	Free-form textual description of the object.
@Nullable QName	getDescriptionAttributeName()	Returns name of the description attribute.
List<ItemDiagramSpecification>	getDiagrams()
String	getDisplayName()	Returns display name.
@Nullable QName	getDisplayNameAttributeName()	Returns name of the display name attribute.
Integer	getDisplayOrder()	Specifies an order in which the item should be displayed relative to other items at the same level.
String	getDocumentation()
String	getDocumentationPreview()	Returns only a first sentence of documentation.
<T extends CapabilityType> T	getEffectiveCapability(Class<T> capabilityClass, ResourceType resource)	TODO
Collection<ResourceAssociationDefinition>	getEntitlementAssociationDefinitions()
QName	getExtensionForType()	If not null, indicates that this type defines the structure of `extension` element of a given type.
String	getHelp()	Returns help string.
String	getHumanReadableName()	TODO
@NotNull List<String>	getIgnoredNamespaces()	When resolving unqualified names for items contained in this CTD, what namespace(s) should be ignored.
Integer	getInstantiationOrder()
@Nullable QName	getNamingAttributeName()	Returns name of the naming attribute.
@NotNull ResourceObjectClassDefinition	getObjectClassDefinition()	Returns the object class definition.
@NotNull QName	getObjectClassName()	Returns the name of the object class.
ResourceObjectMultiplicityType	getObjectMultiplicity()
ResourcePasswordDefinitionType	getPasswordDefinition()	See ResourceObjectTypeDefinitionType.getCredentials()
String	getPlannedRemoval()	Version of data model in which the item is likely to be removed.
@NotNull Collection<? extends ResourceAttributeDefinition<?>>	getPrimaryIdentifiers()	Returns the definition of primary identifier attributes of a resource object.
@NotNull Collection<QName>	getPrimaryIdentifiersNames()	Returns names of primary identifiers.
PrismContext	getPrismContext()
PrismObjectDefinition<ShadowType>	getPrismObjectDefinition()	Returns a prism definition for the prism object/objects carrying the resource object/objects.
ItemProcessing	getProcessing()	Level of processing (ignore, minimal, auto, full) for this item/type.
ProjectionPolicyType	getProjectionPolicy()
@NotNull Collection<ResourceObjectPattern>	getProtectedObjectPatterns()	Returns compiled patterns denoting protected objects.
String	getResourceOid()	This is currently used only to pass information about association in the model-impl TODO consider removal!
List<SchemaMigration>	getSchemaMigrations()
SearchHierarchyScope	getSearchHierarchyScope()	Definition of search hierarchy scope.
@NotNull Collection<? extends ResourceAttributeDefinition<?>>	getSecondaryIdentifiers()	Returns the definition of secondary identifier attributes of a resource object.
@NotNull Collection<QName>	getSecondaryIdentifiersNames()	Returns names of secondary identifiers.
ObjectReferenceType	getSecurityPolicyRef()
@NotNull Collection<TypeDefinition>	getStaticSubTypes()	Subtypes - but only these that are a part of the static schema.
@NotNull ResourceObjectDefinition	getStructuralDefinition()	Returns the structural definition that represents the "base" of this composite definition.
QName	getSuperType()	Name of super type of this complex type definition.
Class<?>	getTypeClass()	Returns a compile-time class that is used to represent items.
Class<?>	getTypeClassIfKnown()
@NotNull QName	getTypeName()	Returns a name of the type for this definition.
@NotNull ResourceObjectVolatilityType	getVolatility()	Specifies volatility of this type of resource objects, i.e.
boolean	hasAuxiliaryObjectClass(QName expectedObjectClassName)	TODO define semantics (it's different for CompositeObjectDefinition and the others!
int	hashCode()
boolean	hasSubstitutions()
boolean	isAbstract()	For types: is the type abstract so that it should not be instantiated directly? For items: TODO
boolean	isContainerMarker()	Flag indicating whether this type was marked as "container" in the original schema.
boolean	isDeprecated()
boolean	isElaborate()	Elaborate items are complicated data structure that may deviate from normal principles of the system.
boolean	isEmphasized()	True for definitions that are more important than others and that should be emphasized during presentation.
boolean	isEmpty()	Returns true if there are no item definitions.
boolean	isExperimental()	Experimental functionality is not stable and it may be changed in any future release without any warning.
boolean	isIgnored()	Item definition that has this flag set should be ignored by any processing.
boolean	isListMarker()	True if the complex type definition is a type dedicated to hold so-called https://docs.evolveum.com/midpoint/devel/design/xml-json-yaml-vs-xnode-vs-internal-data/heterogeneous-lists/[heterogeneous lists].
boolean	isObjectMarker()	Flag indicating whether this type was marked as "object" in the original schema.
boolean	isPrimaryIdentifier(QName attrName)	Returns true if the attribute with a given name is among primary identifiers.
boolean	isReferenceMarker()	Flag indicating whether this type was marked as "objectReference" in the original schema.
boolean	isRuntimeSchema()	This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.
boolean	isSecondaryIdentifier(QName attrName)	Returns true if the attribute with a given name is among secondary identifiers.
boolean	isXsdAnyMarker()	True if the complex type definition contains xsd:any (directly or indirectly).
void	merge(ComplexTypeDefinition otherComplexTypeDef)	Copies cloned definitions from the other type definition into this one.
void	performFreeze()
void	replaceDefinition(@NotNull QName itemName, @Nullable ItemDefinition<?> newDefinition)	Replaces a definition for given item name with a provided one.
void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
<A> void	setAnnotation(QName qname, A value)
Optional<ItemDefinition<?>>	substitution(QName name)
MutableResourceObjectClassDefinition	toMutable()	Returns an interface to mutate this definition.
String	toString()
void	trimTo(@NotNull Collection<ItemPath> paths)	Trims the definition (and any definitions it refers to) to contain only items related to given paths.

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.schema.processor.AssociationDefinitionStore

findAssociationDefinition, findAssociationDefinitionRequired, getAssociationDefinitions, getNamesOfAssociations, getNamesOfAssociationsWithInboundExpressions, getNamesOfAssociationsWithOutboundExpressions

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

containsAttributeDefinition, findAttributeDefinition, findAttributeDefinition, findAttributeDefinition, findAttributeDefinitionRequired, findAttributeDefinitionRequired, findAttributeDefinitionStrictlyRequired, findAttributeDefinitionStrictlyRequired, getAttributeDefinitions, getNamesOfAttributesWithInboundExpressions, getNamesOfAttributesWithOutboundExpressions, hasIndexOnlyAttributes

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

getXmlAttributeDefinitions, hasSubstitutions, isStrictAnyMarker, itemOrSubstitution

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

getConfiguredAuxiliaryObjectClassNames

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

debugDump, debugDumpLazily, debugDumpLazily

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

debugDump, getMutabilityFlag, getSchemaRegistry

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

checkImmutable, checkMutable, freeze, isImmutable

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

getAllIdentifiers, isIdentifier

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

containsItemDefinition, findContainerDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition

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

getActivationBidirectionalMappingType, getActivationFetchStrategy, getDescriptionAttribute, getDisplayNameAttribute, getNamingAttribute, getPagedSearches, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, instantiate, isObjectCountingEnabled, isPagedSearchEnabled, matchesObjectClassName, replaceDefinition, toResourceAttributeContainerDefinition, toResourceAttributeContainerDefinition

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

isAssignableFrom

Constructor Detail

CompositeObjectDefinitionImpl

public CompositeObjectDefinitionImpl(@NotNull
                                     @NotNull ResourceObjectDefinition structuralDefinition,
                                     @Nullable
                                     @Nullable Collection<ResourceObjectDefinition> auxiliaryDefinitions)

Method Detail

getAuxiliaryDefinitions

@NotNull
public @NotNull Collection<ResourceObjectDefinition> getAuxiliaryDefinitions()

Description copied from interface: CompositeObjectDefinition

Returns auxiliary definitions. They enrich the structural definition e.g. by adding attribute definitions. TODO specify better

Specified by:

getAuxiliaryDefinitions in interface CompositeObjectDefinition

Specified by:

getAuxiliaryDefinitions in interface ResourceObjectDefinition

getPrismObjectDefinition

public PrismObjectDefinition<ShadowType> getPrismObjectDefinition()

Description copied from interface: ResourceObjectDefinition

Returns a prism definition for the prism object/objects carrying the resource object/objects.

Specified by:

getPrismObjectDefinition in interface ResourceObjectDefinition

getCompileTimeClass

public Class<?> getCompileTimeClass()

Description copied from interface: TypeDefinition

Returns compile-time class, if this type has any. For example, UserType.class, ObjectType.class, ExtensionType.class.

Specified by:

getCompileTimeClass in interface TypeDefinition

isContainerMarker

public boolean isContainerMarker()

Description copied from interface: ComplexTypeDefinition

Flag indicating whether this type was marked as "container" in the original schema. Does not provide any information to schema processing logic, just conveys the marker from original schema so we can serialize and deserialize the schema without loss of information.

Specified by:

isContainerMarker in interface ComplexTypeDefinition

isPrimaryIdentifier

public boolean isPrimaryIdentifier(QName attrName)

Description copied from interface: IdentifiersDefinitionStore

Returns true if the attribute with a given name is among primary identifiers. Matching is done using namespace-approximate method (testing only local part if no namespace is provided), so beware of incidental matching (e.g. ri:uid vs icfs:uid).

Specified by:

isPrimaryIdentifier in interface IdentifiersDefinitionStore

isObjectMarker

public boolean isObjectMarker()

Description copied from interface: ComplexTypeDefinition

Flag indicating whether this type was marked as "object" in the original schema. Does not provide any information to schema processing logic, just conveys the marker from original schema so we can serialized and deserialize the schema without loss of information.

Specified by:

isObjectMarker in interface ComplexTypeDefinition

isIgnored

public boolean isIgnored()

Description copied from interface: Definition

Item definition that has this flag set should be ignored by any processing. The ignored item is still part of the schema. Item instances may appear in the serialized data formats (e.g. XML) or data store and the parser should not raise an error if it encounters them. But any high-level processing code should ignore presence of this item. E.g. it should not be displayed to the user, should not be present in transformed data structures, etc. Note that the same item can be ignored at higher layer (e.g. presentation) but not ignored at lower layer (e.g. model). This works by presenting different item definitions for these layers (see LayerRefinedAttributeDefinition). Semantics of this flag for complex type definitions is to be defined yet.

Specified by:

isIgnored in interface Definition

getProcessing

public ItemProcessing getProcessing()

Description copied from interface: Definition

Level of processing (ignore, minimal, auto, full) for this item/type.

Specified by:

getProcessing in interface Definition

getSchemaMigrations

public List<SchemaMigration> getSchemaMigrations()

Specified by:

getSchemaMigrations in interface Definition

getDiagrams

public List<ItemDiagramSpecification> getDiagrams()

Specified by:

getDiagrams in interface Definition

isEmphasized

public boolean isEmphasized()

Description copied from interface: Definition

True for definitions that are more important than others and that should be emphasized during presentation. E.g. the emphasized definitions will always be displayed in the user interfaces (even if they are empty), they will always be included in the dumps, etc.

Specified by:

isEmphasized in interface Definition

isAbstract

public boolean isAbstract()

Description copied from interface: Definition

For types: is the type abstract so that it should not be instantiated directly? For items: TODO

Specified by:

isAbstract in interface Definition

getSuperType

public QName getSuperType()

Description copied from interface: TypeDefinition

Name of super type of this complex type definition. E.g. c:ObjectType is a super type for c:FocusType which is a super type for c:UserType. Or (more complex example) ri:ShadowAttributesType is a super type of ri:AccountObjectClass. (TODO is this really true?)

Specified by:

getSuperType in interface TypeDefinition

isSecondaryIdentifier

public boolean isSecondaryIdentifier(QName attrName)

Description copied from interface: IdentifiersDefinitionStore

Returns true if the attribute with a given name is among secondary identifiers. Matching is done using namespace-approximate method (testing only local part if no namespace is provided), so beware of incidental matching (e.g. ri:uid vs icfs:uid).

Specified by:

isSecondaryIdentifier in interface IdentifiersDefinitionStore

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface Definition

getDeprecatedSince

public String getDeprecatedSince()

Specified by:

getDeprecatedSince in interface Definition

isExperimental

public boolean isExperimental()

Description copied from interface: Definition

Experimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.

Specified by:

isExperimental in interface Definition

getPlannedRemoval

public String getPlannedRemoval()

Description copied from interface: Definition

Version of data model in which the item is likely to be removed. This annotation is used for deprecated item to indicate imminent incompatibility in future versions of data model.

Specified by:

getPlannedRemoval in interface Definition

isElaborate

public boolean isElaborate()

Description copied from interface: Definition

Elaborate items are complicated data structure that may deviate from normal principles of the system. For example elaborate items may not be supported in user interface and may only be manageable by raw edits or a special-purpose tools. Elaborate items may be not fully supported by authorizations, schema tools and so on.

Specified by:

isElaborate in interface Definition

getDisplayOrder

public Integer getDisplayOrder()

Description copied from interface: Definition

Specifies an order in which the item should be displayed relative to other items at the same level. The items will be displayed by sorting them by the values of displayOrder annotation (ascending). Items that do not have any displayOrder annotation will be displayed last. The ordering of values with the same displayOrder is undefined and it may be arbitrary.

Specified by:

getDisplayOrder in interface Definition

getHelp

public String getHelp()

Description copied from interface: Definition

Returns help string. Specifies the help text or a key to catalog file for a help text. The help text may be displayed in any suitable way by the GUI. It should explain the meaning of an attribute or object class. Returns null if no help string is set. Corresponds to "help" XSD annotation.

Specified by:

getHelp in interface Definition

Returns:

help string or catalog key

getTypeName

@NotNull
public @NotNull QName getTypeName()

Description copied from interface: Definition

Returns a name of the type for this definition. The type can be part of the compile-time schema or it can be defined at run time. Examples of the former case are types like c:UserType, xsd:string, or even flexible ones like c:ExtensionType or c:ShadowAttributesType. Examples of the latter case are types used in - custom extensions, like ext:LocationsType (where ext = e.g. http://example.com/extension), - resource schema, like ri:inetOrgPerson (ri = http://.../resource/instance-3), - connector schema, like TODO In XML representation that corresponds to the name of the XSD type. Although beware, the run-time types do not have statically defined structure. And the resource and connector-related types may even represent different kinds of objects within different contexts (e.g. two distinct resources both with ri:AccountObjectClass types). Also note that for complex type definitions, the type name serves as a unique identifier. On the other hand, for item definitions, it is just one of its attributes; primary key is item name in that case. The type name should be fully qualified. (TODO reconsider this)

Specified by:

getTypeName in interface Definition

Returns:

the type name

getDocumentation

public String getDocumentation()

Specified by:

getDocumentation in interface Definition

getDocumentationPreview

public String getDocumentationPreview()

Description copied from interface: Definition

Returns only a first sentence of documentation.

Specified by:

getDocumentationPreview in interface Definition

isRuntimeSchema

public boolean isRuntimeSchema()

Description copied from interface: Definition

This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g. extension schema, resource schema or connector schema or something like that. I.e. it is not defined statically.

Specified by:

isRuntimeSchema in interface Definition

getPrimaryIdentifiers

@NotNull
public @NotNull Collection<? extends ResourceAttributeDefinition<?>> getPrimaryIdentifiers()

Description copied from interface: IdentifiersDefinitionStore

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 IdentifiersDefinitionStore

Returns:

definition of identifier attributes

getPrimaryIdentifiersNames

@NotNull
public @NotNull Collection<QName> getPrimaryIdentifiersNames()

Description copied from interface: IdentifiersDefinitionStore

Returns names of primary identifiers.

Specified by:

getPrimaryIdentifiersNames in interface IdentifiersDefinitionStore

See Also:

IdentifiersDefinitionStore.getPrimaryIdentifiers()

getSecondaryIdentifiers

@NotNull
public @NotNull Collection<? extends ResourceAttributeDefinition<?>> getSecondaryIdentifiers()

Description copied from interface: IdentifiersDefinitionStore

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 IdentifiersDefinitionStore

Returns:

definition of secondary identifier attributes

getSecondaryIdentifiersNames

@NotNull
public @NotNull Collection<QName> getSecondaryIdentifiersNames()

Description copied from interface: IdentifiersDefinitionStore

Returns names of secondary identifiers.

Specified by:

getSecondaryIdentifiersNames in interface IdentifiersDefinitionStore

See Also:

()

getAssociationDefinitions

@NotNull
public @NotNull Collection<ResourceAssociationDefinition> getAssociationDefinitions()

Description copied from interface: AssociationDefinitionStore

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

Specified by:

getAssociationDefinitions in interface AssociationDefinitionStore

isEmpty

public boolean isEmpty()

Description copied from interface: ComplexTypeDefinition

Returns true if there are no item definitions.

Specified by:

isEmpty in interface ComplexTypeDefinition

getProtectedObjectPatterns

@NotNull
public @NotNull Collection<ResourceObjectPattern> getProtectedObjectPatterns()

Description copied from interface: ResourceObjectDefinition

Returns compiled patterns denoting protected objects.

Specified by:

getProtectedObjectPatterns in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getProtected()

getDisplayName

public String getDisplayName()

Description copied from interface: Definition

Returns display name. Specifies the printable name of the object class or attribute. It must contain a printable string. It may also contain a key to catalog file. Returns null if no display name is set. Corresponds to "displayName" XSD annotation.

Specified by:

getDisplayName in interface Definition

Returns:

display name string or catalog key

getDescription

public String getDescription()

Description copied from interface: ResourceObjectDefinition

Free-form textual description of the object. It is supposed to describe the object or a construct that it is attached to.

Specified by:

getDescription in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getDescription()

getResourceOid

public String getResourceOid()

Description copied from interface: ResourceObjectDefinition

This is currently used only to pass information about association in the model-impl TODO consider removal!

Specified by:

getResourceOid in interface ResourceObjectDefinition

getObjectClassDefinition

@NotNull
public @NotNull ResourceObjectClassDefinition getObjectClassDefinition()

Description copied from interface: ResourceObjectDefinition

Returns the object class definition. It is either this object itself, or the linked definition (for object type).

Specified by:

getObjectClassDefinition in interface ResourceObjectDefinition

getBaseContext

public ResourceObjectReferenceType getBaseContext()

Description copied from interface: ResourceObjectDefinition

The definition of base context (resource object container). This object will be used as a base for searches for objects of this type.

Specified by:

getBaseContext in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getBaseContext()

getSearchHierarchyScope

public SearchHierarchyScope getSearchHierarchyScope()

Description copied from interface: ResourceObjectDefinition

Definition of search hierarchy scope. It specifies how "deep" the search should go into the object hierarchy.

Specified by:

getSearchHierarchyScope in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getSearchHierarchyScope()

getVolatility

@NotNull
public @NotNull ResourceObjectVolatilityType getVolatility()

Description copied from interface: ResourceObjectDefinition

Specifies volatility of this type of resource objects, i.e. whether such an object can change when midPoint is not looking.

Specified by:

getVolatility in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getVolatility()

getDefaultInboundMappingEvaluationPhases

@Nullable
public @Nullable DefaultInboundMappingEvaluationPhasesType getDefaultInboundMappingEvaluationPhases()

Description copied from interface: ResourceObjectDefinition

Returns the phases in which inbound mappings are evaluated by default.

Specified by:

getDefaultInboundMappingEvaluationPhases in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType#getInboundMappingsEvaluation()

getObjectMultiplicity

public ResourceObjectMultiplicityType getObjectMultiplicity()

Specified by:

getObjectMultiplicity in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getMultiplicity()

getProjectionPolicy

public ProjectionPolicyType getProjectionPolicy()

Specified by:

getProjectionPolicy in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getProjection()

getSecurityPolicyRef

public ObjectReferenceType getSecurityPolicyRef()

Specified by:

getSecurityPolicyRef in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getSecurityPolicyRef()

getActivationSchemaHandling

public ResourceActivationDefinitionType getActivationSchemaHandling()

Specified by:

getActivationSchemaHandling in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getActivation()

getConfiguredCapabilities

@Nullable
public @Nullable CapabilitiesType getConfiguredCapabilities()

Description copied from interface: ResourceObjectDefinition

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

Specified by:

getConfiguredCapabilities in interface ResourceObjectDefinition

getEffectiveCapability

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

Description copied from interface: ResourceObjectDefinition

TODO

Specified by:

getEffectiveCapability in interface ResourceObjectDefinition

getAttributeDefinitions

@NotNull
public @NotNull List<? extends ResourceAttributeDefinition<?>> getAttributeDefinitions()

Description copied from interface: AttributeDefinitionStore

Returns all attribute definitions as an unmodifiable collection. Should be the same content as returned by `getDefinitions`. The returned value is a List because of the contract of ComplexTypeDefinition.getDefinitions().

Specified by:

getAttributeDefinitions in interface AttributeDefinitionStore

getDefinitions

@NotNull
public @NotNull List<? extends ItemDefinition<?>> getDefinitions()

Description copied from interface: ComplexTypeDefinition

Returns definitions for all inner items. These are of type ItemDefinition. However, very often subtypes of this type are used, e.g. ResourceAttributeDefinition, RefinedAttributeDefinition, LayerRefinedAttributeDefinition, and so on. The returned structure is a List because the ordering is significant, e.g. for serialization purposes. The list is unmodifiable.

Specified by:

getDefinitions in interface ComplexTypeDefinition

Specified by:

getDefinitions in interface LocalItemDefinitionStore

getPrismContext

public PrismContext getPrismContext()

Specified by:

getPrismContext in interface PrismContextSensitive

revive

public void revive(PrismContext prismContext)

Description copied from interface: Revivable

TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)

Specified by:

revive in interface Revivable

getExtensionForType

public QName getExtensionForType()

Description copied from interface: ComplexTypeDefinition

If not null, indicates that this type defines the structure of `extension` element of a given type. E.g. `getExtensionForType()` == `c:UserType` means that this complex type defines structure of `extension` elements of `UserType` objects.

Specified by:

getExtensionForType in interface ComplexTypeDefinition

isXsdAnyMarker

public boolean isXsdAnyMarker()

Description copied from interface: ComplexTypeDefinition

True if the complex type definition contains xsd:any (directly or indirectly).

Specified by:

isXsdAnyMarker in interface ComplexTypeDefinition

getDefaultNamespace

public String getDefaultNamespace()

Description copied from interface: ComplexTypeDefinition

When resolving unqualified names for items contained in this CTD, what should be the default namespace to look into at first. Currently does NOT apply recursively (to inner CTDs). Set by parsing `defaultNamespace` XSD annotation.

Specified by:

getDefaultNamespace in interface ComplexTypeDefinition

getIgnoredNamespaces

@NotNull
public @NotNull List<String> getIgnoredNamespaces()

Description copied from interface: ComplexTypeDefinition

When resolving unqualified names for items contained in this CTD, what namespace(s) should be ignored. Names in this list are interpreted as a namespace prefixes. Currently does NOT apply recursively (to inner CTDs). Set by parsing `ignoredNamespace` XSD annotations.

Specified by:

getIgnoredNamespaces in interface ComplexTypeDefinition

getEntitlementAssociationDefinitions

public Collection<ResourceAssociationDefinition> getEntitlementAssociationDefinitions()

getAuxiliaryObjectClassMappings

public ResourceBidirectionalMappingAndDefinitionType getAuxiliaryObjectClassMappings()

Specified by:

getAuxiliaryObjectClassMappings in interface ResourceObjectDefinition

See Also:

ResourceObjectTypeDefinitionType.getAuxiliaryObjectClassMappings()

hasAuxiliaryObjectClass

public boolean hasAuxiliaryObjectClass(QName expectedObjectClassName)

Description copied from interface: ResourceObjectDefinition

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

Specified by:

hasAuxiliaryObjectClass in interface ResourceObjectDefinition

findItemDefinition

public <ID extends ItemDefinition<?>> ID findItemDefinition(@NotNull
                                                            @NotNull ItemPath path,
                                                            @NotNull
                                                            @NotNull Class<ID> clazz)

Description copied from interface: LocalItemDefinitionStore

Returns a definition of given type corresponding to given path (rooted at this store). Tries the global resolution in the case of "any" content.

Specified by:

findItemDefinition in interface LocalItemDefinitionStore

merge

public void merge(ComplexTypeDefinition otherComplexTypeDef)

Description copied from interface: ComplexTypeDefinition

Copies cloned definitions from the other type definition into this one. (TODO remove from the interface?)

Specified by:

merge in interface ComplexTypeDefinition

getTypeClassIfKnown

public Class<?> getTypeClassIfKnown()

Specified by:

getTypeClassIfKnown in interface Definition

getTypeClass

public Class<?> getTypeClass()

Description copied from interface: Definition

Returns a compile-time class that is used to represent items. E.g. returns String, Integer, subclasses of Objectable and Containerable and so on.

Specified by:

getTypeClass in interface Definition

createBlankShadow

public PrismObject<ShadowType> createBlankShadow(String resourceOid,
                                                 String tag)

Description copied from interface: ResourceObjectDefinition

Creates a blank ShadowType object, with the attributes container having appropriate definition.

Specified by:

createBlankShadow in interface ResourceObjectDefinition

getPasswordDefinition

public ResourcePasswordDefinitionType getPasswordDefinition()

Description copied from interface: ResourceObjectDefinition

See ResourceObjectTypeDefinitionType.getCredentials()

Specified by:

getPasswordDefinition in interface ResourceObjectDefinition

accept

public void accept(Visitor<Definition> visitor)

Specified by:

accept in interface Visitable<Definition>

accept

public boolean accept(Visitor<Definition> visitor,
                      SmartVisitation<Definition> visitation)

Specified by:

accept in interface SmartVisitable<Definition>

Returns:

false if we already was here

clone

@NotNull
public @NotNull CompositeObjectDefinitionImpl 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 ResourceObjectDefinition

Overrides:

clone in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

debugDump

protected String debugDump(int indent,
                           LayerType layer)

getDebugDumpClassName

public String getDebugDumpClassName()

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

Specified by:

getDebugDumpClassName in interface ResourceObjectDefinition

getHumanReadableName

public String getHumanReadableName()

Description copied from interface: ResourceObjectDefinition

TODO

Specified by:

getHumanReadableName in interface ResourceObjectDefinition

toString

public String toString()

Overrides:

toString in class Object

deepClone

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

Description copied from interface: ComplexTypeDefinition

Does a deep clone of this definition.

Specified by:

deepClone in interface ComplexTypeDefinition

Specified by:

deepClone in interface ResourceObjectDefinition

forLayer

public CompositeObjectDefinition forLayer(@NotNull
                                          @NotNull LayerType layer)

Description copied from interface: ResourceObjectDefinition

Creates a layer-specific version of this definition.

Specified by:

forLayer in interface ResourceObjectDefinition

getCurrentLayer

@NotNull
public @NotNull LayerType getCurrentLayer()

Description copied from interface: LayeredDefinition

Gets the current point-of-view: on which layer do we look at the data?

Specified by:

getCurrentLayer in interface LayeredDefinition

replaceDefinition

public void replaceDefinition(@NotNull
                              @NotNull QName itemName,
                              @Nullable
                              @Nullable ItemDefinition<?> newDefinition)

Description copied from interface: ResourceObjectDefinition

Replaces a definition for given item name with a provided one.

Specified by:

replaceDefinition in interface ResourceObjectDefinition

isListMarker

public boolean isListMarker()

Description copied from interface: ComplexTypeDefinition

True if the complex type definition is a type dedicated to hold so-called https://docs.evolveum.com/midpoint/devel/design/xml-json-yaml-vs-xnode-vs-internal-data/heterogeneous-lists/[heterogeneous lists]. See also DOMUtil.IS_LIST_ATTRIBUTE_NAME and ItemDefinition.isHeterogeneousListItem().

Specified by:

isListMarker in interface ComplexTypeDefinition

trimTo

public void trimTo(@NotNull
                   @NotNull Collection<ItemPath> paths)

Description copied from interface: ComplexTypeDefinition

Trims the definition (and any definitions it refers to) to contain only items related to given paths. USE WITH CARE. Be sure no shared definitions would be affected by this operation!

Specified by:

trimTo in interface ComplexTypeDefinition

toMutable

public MutableResourceObjectClassDefinition toMutable()

Description copied from interface: Definition

Returns an interface to mutate this definition.

Specified by:

toMutable in interface ComplexTypeDefinition

Specified by:

toMutable in interface Definition

isReferenceMarker

public boolean isReferenceMarker()

Description copied from interface: ComplexTypeDefinition

Flag indicating whether this type was marked as "objectReference" in the original schema.

Specified by:

isReferenceMarker in interface ComplexTypeDefinition

getStaticSubTypes

@NotNull
public @NotNull Collection<TypeDefinition> getStaticSubTypes()

Description copied from interface: TypeDefinition

Subtypes - but only these that are a part of the static schema. A little bit experimental. :)

Specified by:

getStaticSubTypes in interface TypeDefinition

getAnnotation

public <A> A getAnnotation(QName qname)

Description copied from interface: Definition

Returns generic definition annotation. Annotations are a method to extend schema definitions. This may be annotation stored in the schema definition file (e.g. XSD) or it may be a dynamic annotation determined at run-time. Annotation value should be a prism-supported object. E.g. a prims "bean" (JAXB annotated class), prism item, prism value or something like that. EXPERIMENTAL. Hic sunt leones. This may change at any moment. Note: annotations are only partially supported now (3.8). They are somehow transient. E.g. they are not serialized to XSD schema definitions (yet).

Specified by:

getAnnotation in interface Definition

setAnnotation

public <A> void setAnnotation(QName qname,
                              A value)

Specified by:

setAnnotation in interface Definition

getAnnotations

@Nullable
public @Nullable Map<QName,Object> getAnnotations()

Description copied from interface: Definition

Returns all annotations, as unmodifiable map. Nullable by design, to avoid creating lots of empty maps.

Specified by:

getAnnotations in interface Definition

getInstantiationOrder

public Integer getInstantiationOrder()

Specified by:

getInstantiationOrder in interface TypeDefinition

canRepresent

public boolean canRepresent(QName typeName)

Specified by:

canRepresent in interface TypeDefinition

performFreeze

public void performFreeze()

Overrides:

performFreeze in class AbstractFreezable

hasSubstitutions

public boolean hasSubstitutions()

Specified by:

hasSubstitutions in interface ComplexTypeDefinition

substitution

public Optional<ItemDefinition<?>> substitution(QName name)

Specified by:

substitution in interface ComplexTypeDefinition

getObjectClassName

@NotNull
public @NotNull QName getObjectClassName()

Description copied from interface: ResourceObjectDefinition

Returns the name of the object class.

Specified by:

getObjectClassName 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()

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

See Also:

ResourceObjectDefinition.getDisplayNameAttribute()

createShadowSearchQuery

@NotNull
public @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 ResourceObjectDefinition

Throws:

SchemaException

getStructuralDefinition

@NotNull
public @NotNull ResourceObjectDefinition getStructuralDefinition()

Description copied from interface: CompositeObjectDefinition

Returns the structural definition that represents the "base" of this composite definition.

Specified by:

getStructuralDefinition in interface CompositeObjectDefinition