Package com.evolveum.midpoint.model.impl.schema.transform

Class TransformableComplexTypeDefinition.TrResourceObjectDefinition

java.lang.Object

com.evolveum.midpoint.model.impl.schema.transform.TransformableComplexTypeDefinition

com.evolveum.midpoint.model.impl.schema.transform.TransformableComplexTypeDefinition.TrResourceObjectDefinition

All Implemented Interfaces:

com.evolveum.midpoint.model.impl.schema.transform.PartiallyMutableComplexTypeDefinition.ObjectClassDefinition, ComplexTypeDefinition, Definition, ComplexTypeDefinitionDelegator, DefinitionDelegator, TypeDefinitionDelegator, Freezable, LocalItemDefinitionStore, MutableComplexTypeDefinition, MutableDefinition, MutableTypeDefinition, PrismContextSensitive, Revivable, SmartVisitable<Definition>, TypeDefinition, Visitable<Definition>, AssociationDefinitionStore, AttributeDefinitionStore, ResourceObjectDefinitionDelegator, IdentifiersDefinitionStore, LayeredDefinition, MutableResourceObjectClassDefinition, ResourceObjectClassDefinition, ResourceObjectDefinition, DebugDumpable, Serializable, Cloneable

Enclosing class:

TransformableComplexTypeDefinition

public static class TransformableComplexTypeDefinition.TrResourceObjectDefinition
extends TransformableComplexTypeDefinition
implements ResourceObjectDefinitionDelegator, com.evolveum.midpoint.model.impl.schema.transform.PartiallyMutableComplexTypeDefinition.ObjectClassDefinition

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.evolveum.midpoint.model.impl.schema.transform.TransformableComplexTypeDefinition

TransformableComplexTypeDefinition.TrResourceObjectDefinition

Field Summary

Fields inherited from class com.evolveum.midpoint.model.impl.schema.transform.TransformableComplexTypeDefinition

delegate

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
TrResourceObjectDefinition(ComplexTypeDefinition delegate)

Method Summary

Modifier and Type	Method	Description
default void	addDiagram(ItemDiagramSpecification diagram)
default void	addSchemaMigration(SchemaMigration schemaMigration)
default void	addSubstitution(ItemDefinition<?> itemDef, ItemDefinition<?> maybeSubst)
@NotNull MutableResourceObjectClassDefinition	clone()	Does a shallow clone of this definition (i.e.
TransformableComplexTypeDefinition.TrResourceObjectDefinition	copy()
default MutablePrismPropertyDefinition<?>	createPropertyDefinition(String name, QName typeName)
default MutablePrismPropertyDefinition<?>	createPropertyDefinition(QName name, QName typeName)
@NotNull ObjectQuery	createShadowSearchQuery(String resourceOid)	Creates a query for obtaining shadows related to this object class or object type.
@NotNull ResourceObjectClassDefinition	deepClone(@NotNull DeepCloneOperation operation)	Does a deep clone of this definition.
ResourceObjectDefinition	delegate()
default void	delete(QName itemName)
String	getNativeObjectClass()	Returns the native object class name.
ResourceAttributeContainer	instantiate(ItemName elementName)	Creates a ResourceAttributeContainer instance with this definition as its complex type definition.
boolean	isAuxiliary()	TODO
boolean	isDefaultAccountDefinition()	Indicates whether definition is the default account definition.
default void	setAbstract(boolean value)
default void	setCompileTimeClass(Class<?> compileTimeClass)
default void	setContainerMarker(boolean value)
default void	setDefaultNamespace(String namespace)
default void	setDeprecated(boolean deprecated)
default void	setDisplayName(String displayName)
default void	setDisplayOrder(Integer displayOrder)
default void	setDocumentation(String value)
default void	setEmphasized(boolean emphasized)
default void	setExperimental(boolean experimental)
default void	setExtensionForType(QName type)
default void	setHelp(String help)
default void	setIgnoredNamespaces(@NotNull List<String> ignoredNamespaces)
default void	setInstantiationOrder(Integer order)
default void	setListMarker(boolean value)
default void	setObjectMarker(boolean value)
default void	setProcessing(ItemProcessing processing)
default void	setReferenceMarker(boolean value)
default void	setRuntimeSchema(boolean value)
default void	setSuperType(QName superType)
default void	setTypeName(QName typeName)
default void	setXsdAnyMarker(boolean value)
MutableResourceObjectClassDefinition	toMutable()	Returns an interface to mutate this definition.

Methods inherited from class com.evolveum.midpoint.model.impl.schema.transform.TransformableComplexTypeDefinition

delete, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findNamedItemDefinition, freeze, from, getDefinitions, isEmpty, isImmutable, itemOrSubstitution, replaceDefinition, revive, substitution, trimTo

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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, findAttributeDefinitionRequired, findAttributeDefinitionRequired, findAttributeDefinitionStrictlyRequired, findAttributeDefinitionStrictlyRequired, getAttributeDefinitions, getNamesOfAttributesWithInboundExpressions, getNamesOfAttributesWithOutboundExpressions, hasIndexOnlyAttributes

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

getXmlAttributeDefinitions, hasSubstitutions, isStrictAnyMarker

Methods inherited from interface com.evolveum.midpoint.prism.deleg.ComplexTypeDefinitionDelegator

findContainerDefinition, findItemDefinition, findItemDefinition, findReferenceDefinition, getDefaultNamespace, getDefinitions, getDiagrams, getExtensionForType, getIgnoredNamespaces, 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, 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.schema.processor.IdentifiersDefinitionStore

getAllIdentifiers, isIdentifier

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

containsItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition

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

replaceDefinition, setAttributeDefinitions, setStrictAnyMarker

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

createAttributeDefinition

Methods inherited from interface com.evolveum.midpoint.model.impl.schema.transform.PartiallyMutableComplexTypeDefinition.ObjectClassDefinition

add, addPrimaryIdentifierName, addSecondaryIdentifierName, createAttributeDefinition, setAuxiliary, setDefaultAccountDefinition, setDescriptionAttributeName, setDisplayNameAttributeName, setNamingAttributeName, setNativeObjectClass

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

getActivationBidirectionalMappingType, getActivationFetchStrategy, getPagedSearches, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, isObjectCountingEnabled, isPagedSearchEnabled, matchesObjectClassName, replaceDefinition

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

createBlankShadow, findAttributeDefinition, findAttributeDefinition, forLayer, getActivationSchemaHandling, getAssociationDefinitions, getAttributeDefinitions, getAuxiliaryDefinitions, getAuxiliaryObjectClassMappings, getBaseContext, getConfiguredAuxiliaryObjectClassNames, getConfiguredCapabilities, getCurrentLayer, getDebugDumpClassName, getDefaultInboundMappingEvaluationPhases, getDescription, getDescriptionAttribute, getDescriptionAttributeName, getDisplayNameAttribute, getDisplayNameAttributeName, getEffectiveCapability, getHumanReadableName, getNamingAttribute, getNamingAttributeName, getObjectClassDefinition, getObjectClassName, getObjectMultiplicity, getPasswordDefinition, getPrimaryIdentifiers, getPrimaryIdentifiersNames, getPrismObjectDefinition, getProjectionPolicy, getProtectedObjectPatterns, getResourceOid, getSearchHierarchyScope, getSecondaryIdentifiers, getSecondaryIdentifiersNames, getSecurityPolicyRef, getVolatility, hasAuxiliaryObjectClass, isPrimaryIdentifier, isSecondaryIdentifier, replaceDefinition, toResourceAttributeContainerDefinition, toResourceAttributeContainerDefinition

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

Constructor Detail

TrResourceObjectDefinition

public TrResourceObjectDefinition(ComplexTypeDefinition delegate)

Method Detail

delegate

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

Overrides:

delegate in class TransformableComplexTypeDefinition

getNativeObjectClass

public 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

public boolean isAuxiliary()

Description copied from interface: ResourceObjectClassDefinition

TODO

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 MutableResourceObjectClassDefinition 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 MutableComplexTypeDefinition

Specified by:

clone in interface com.evolveum.midpoint.model.impl.schema.transform.PartiallyMutableComplexTypeDefinition.ObjectClassDefinition

Specified by:

clone in interface ResourceObjectClassDefinition

Specified by:

clone in interface ResourceObjectDefinition

Overrides:

clone in class TransformableComplexTypeDefinition

copy

public TransformableComplexTypeDefinition.TrResourceObjectDefinition copy()

Overrides:

copy in class TransformableComplexTypeDefinition

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

Specified by:

toMutable in interface ResourceObjectClassDefinition

Overrides:

toMutable in class TransformableComplexTypeDefinition

deepClone

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

Specified by:

deepClone in interface ResourceObjectDefinition

Overrides:

deepClone in class TransformableComplexTypeDefinition

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 ResourceObjectClassDefinition

Specified by:

createShadowSearchQuery in interface ResourceObjectDefinition

Specified by:

createShadowSearchQuery in interface ResourceObjectDefinitionDelegator

Throws:

SchemaException

instantiate

public 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

Specified by:

instantiate in interface ResourceObjectDefinitionDelegator

setInstantiationOrder

public default void setInstantiationOrder(Integer order)

Specified by:

setInstantiationOrder in interface MutableTypeDefinition

setProcessing

public default void setProcessing(ItemProcessing processing)

Specified by:

setProcessing in interface MutableDefinition

setDeprecated

public default void setDeprecated(boolean deprecated)

Specified by:

setDeprecated in interface MutableDefinition

setExperimental

public default void setExperimental(boolean experimental)

Specified by:

setExperimental in interface MutableDefinition

setEmphasized

public default void setEmphasized(boolean emphasized)

Specified by:

setEmphasized in interface MutableDefinition

setDisplayName

public default void setDisplayName(String displayName)

Specified by:

setDisplayName in interface MutableDefinition

setDisplayOrder

public default void setDisplayOrder(Integer displayOrder)

Specified by:

setDisplayOrder in interface MutableDefinition

setHelp

public default void setHelp(String help)

Specified by:

setHelp in interface MutableDefinition

setRuntimeSchema

public default void setRuntimeSchema(boolean value)

Specified by:

setRuntimeSchema in interface MutableDefinition

setTypeName

public default void setTypeName(QName typeName)

Specified by:

setTypeName in interface MutableDefinition

setDocumentation

public default void setDocumentation(String value)

Specified by:

setDocumentation in interface MutableDefinition

addSchemaMigration

public default void addSchemaMigration(SchemaMigration schemaMigration)

Specified by:

addSchemaMigration in interface MutableDefinition

delete

public default void delete(QName itemName)

Specified by:

delete in interface MutableComplexTypeDefinition

createPropertyDefinition

public default MutablePrismPropertyDefinition<?> createPropertyDefinition(QName name,
                                                                          QName typeName)

Specified by:

createPropertyDefinition in interface MutableComplexTypeDefinition

createPropertyDefinition

public default MutablePrismPropertyDefinition<?> createPropertyDefinition(String name,
                                                                          QName typeName)

Specified by:

createPropertyDefinition in interface MutableComplexTypeDefinition

setExtensionForType

public default void setExtensionForType(QName type)

Specified by:

setExtensionForType in interface MutableComplexTypeDefinition

setAbstract

public default void setAbstract(boolean value)

Specified by:

setAbstract in interface MutableComplexTypeDefinition

setSuperType

public default void setSuperType(QName superType)

Specified by:

setSuperType in interface MutableComplexTypeDefinition

setObjectMarker

public default void setObjectMarker(boolean value)

Specified by:

setObjectMarker in interface MutableComplexTypeDefinition

setContainerMarker

public default void setContainerMarker(boolean value)

Specified by:

setContainerMarker in interface MutableComplexTypeDefinition

setReferenceMarker

public default void setReferenceMarker(boolean value)

Specified by:

setReferenceMarker in interface MutableComplexTypeDefinition

setDefaultNamespace

public default void setDefaultNamespace(String namespace)

Specified by:

setDefaultNamespace in interface MutableComplexTypeDefinition

setIgnoredNamespaces

public default void setIgnoredNamespaces(@NotNull
                                         @NotNull List<String> ignoredNamespaces)

Specified by:

setIgnoredNamespaces in interface MutableComplexTypeDefinition

setXsdAnyMarker

public default void setXsdAnyMarker(boolean value)

Specified by:

setXsdAnyMarker in interface MutableComplexTypeDefinition

setListMarker

public default void setListMarker(boolean value)

Specified by:

setListMarker in interface MutableComplexTypeDefinition

setCompileTimeClass

public default void setCompileTimeClass(Class<?> compileTimeClass)

Specified by:

setCompileTimeClass in interface MutableComplexTypeDefinition

addSubstitution

public default void addSubstitution(ItemDefinition<?> itemDef,
                                    ItemDefinition<?> maybeSubst)

Specified by:

addSubstitution in interface MutableComplexTypeDefinition

addDiagram

public default void addDiagram(ItemDiagramSpecification diagram)

Specified by:

addDiagram in interface MutableDefinition