Interface ResourceObjectDefinitionDelegator
-
- All Superinterfaces:
AssociationDefinitionStore,AttributeDefinitionStore,Cloneable,ComplexTypeDefinition,ComplexTypeDefinitionDelegator,DebugDumpable,Definition,DefinitionDelegator,Freezable,IdentifiersDefinitionStore,LayeredDefinition,LocalItemDefinitionStore,PrismContextSensitive,ResourceObjectDefinition,Revivable,Serializable,SmartVisitable<Definition>,TypeDefinition,TypeDefinitionDelegator,Visitable<Definition>
- All Known Subinterfaces:
CompositeObjectDefinitionDelegator,ResourceObjectClassDefinitionDelegator,ResourceObjectTypeDefinitionDelegator
- All Known Implementing Classes:
TransformableComplexTypeDefinition.TrCompositeObjectDefinition,TransformableComplexTypeDefinition.TrResourceObjectClassDefinition,TransformableComplexTypeDefinition.TrResourceObjectDefinition,TransformableComplexTypeDefinition.TrResourceObjectTypeDefinition
public interface ResourceObjectDefinitionDelegator extends ComplexTypeDefinitionDelegator, ResourceObjectDefinition
-
-
Field Summary
-
Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default PrismObject<ShadowType>createBlankShadow(String resourceOid, String tag)Creates a blankShadowTypeobject, with the attributes container having appropriate definition.default @NotNull ObjectQuerycreateShadowSearchQuery(String resourceOid)Creates a query for obtaining shadows related to this object class or object type.ResourceObjectDefinitiondelegate()default ResourceAttributeDefinition<?>findAttributeDefinition(String name)Finds attribute definition using local name only.default @Nullable ResourceAttributeDefinition<?>findAttributeDefinition(QName name, boolean caseInsensitive)Finds a attribute definition by looking at the property name.default ResourceObjectDefinitionforLayer(@NotNull LayerType layer)Creates a layer-specific version of this definition.default ResourceActivationDefinitionTypegetActivationSchemaHandling()default @NotNull Collection<ResourceAssociationDefinition>getAssociationDefinitions()Returns definitions of all associations as an unmodifiable collection.default @NotNull List<? extends ResourceAttributeDefinition<?>>getAttributeDefinitions()Returns all attribute definitions as an unmodifiable collection.default ResourceBidirectionalMappingAndDefinitionTypegetAuxiliaryObjectClassMappings()default ResourceObjectReferenceTypegetBaseContext()The definition of base context (resource object container).default Collection<QName>getConfiguredAuxiliaryObjectClassNames()Returns the names of auxiliary object classes that are "statically" defined for this object type (or object class, in the future).default @NotNull LayerTypegetCurrentLayer()Gets the current point-of-view: on which layer do we look at the data?default StringgetDebugDumpClassName()Return a human readable name of this class suitable for logs.default @Nullable DefaultInboundMappingEvaluationPhasesTypegetDefaultInboundMappingEvaluationPhases()Returns the phases in which inbound mappings are evaluated by default.default @NotNull ResourceObjectTypeDefinitionTypegetDefinitionBean()Returns the "raw" configuration bean for this object type.default @NotNull ResourceObjectTypeDelineationgetDelineation()Returns the delineation of the set of objects belonging to this object type.default StringgetDescription()Free-form textual description of the object.default ResourceAttributeDefinition<?>getDescriptionAttribute()Returns the definition of description attribute of a resource object.default @Nullable QNamegetDescriptionAttributeName()Returns name of the description attribute.default ResourceAttributeDefinition<?>getDisplayNameAttribute()Returns the definition of display name attribute.default @Nullable QNamegetDisplayNameAttributeName()Returns name of the display name attribute.default <T extends CapabilityType>
TgetEnabledCapability(@NotNull Class<T> capabilityClass, ResourceType resource)Checks the presence of capability in: 1.default StringgetHumanReadableName()TODOdefault @Nullable StringgetLifecycleState()What lifecycle state is the (refined) object class or object type definition? Raw object class definition should always return `null` here.default ResourceAttributeDefinition<?>getNamingAttribute()Returns the attribute used as a visible name of the resource object.default @Nullable QNamegetNamingAttributeName()Returns name of the naming attribute.default @NotNull ResourceObjectClassDefinitiongetObjectClassDefinition()Returns the (raw or refined) object class definition.default @NotNull QNamegetObjectClassName()Returns the name of the object class.default ResourceObjectMultiplicityTypegetObjectMultiplicity()default @Nullable ResourcePasswordDefinitionTypegetPasswordDefinition()default @NotNull Collection<? extends ResourceAttributeDefinition<?>>getPrimaryIdentifiers()Returns the definition of primary identifier attributes of a resource object.default @NotNull Collection<QName>getPrimaryIdentifiersNames()Returns names of primary identifiers.default PrismObjectDefinition<ShadowType>getPrismObjectDefinition()Returns a prism definition for the prism object/objects carrying the resource object/objects.default ProjectionPolicyTypegetProjectionPolicy()default @NotNull Collection<ResourceObjectPattern>getProtectedObjectPatterns()Returns compiled patterns denoting protected objects.default @NotNull ResourceObjectClassDefinitiongetRawObjectClassDefinition()Returns the raw object class definition.default StringgetResourceOid()This is currently used only to pass information about association in the model-impl TODO consider removal!default SearchHierarchyScopegetSearchHierarchyScope()Definition of search hierarchy scope.default @NotNull Collection<? extends ResourceAttributeDefinition<?>>getSecondaryIdentifiers()Returns the definition of secondary identifier attributes of a resource object.default @NotNull Collection<QName>getSecondaryIdentifiersNames()Returns names of secondary identifiers.default ObjectReferenceTypegetSecurityPolicyRef()default @Nullable ResourceObjectTypeDefinitiongetTypeDefinition()Is this definition bound to a specific resource type? If yes, this method returns its definition.default @Nullable ResourceObjectTypeIdentificationgetTypeIdentification()Is this definition bound to a specific resource type? If yes, this method returns its identification.default @NotNull ResourceObjectVolatilityTypegetVolatility()Specifies volatility of this type of resource objects, i.e.default booleanhasAuxiliaryObjectClass(QName expectedObjectClassName)TODO define semantics (it's different forCompositeObjectDefinitionand the others!default booleanisDefaultFor(@NotNull ShadowKindType kind)Returns true if this definition can be considered as a default for the specified kind.default booleanisPrimaryIdentifier(QName attrName)Returns true if the attribute with a given name is among primary identifiers.default booleanisSecondaryIdentifier(QName attrName)Returns true if the attribute with a given name is among secondary identifiers.default voidreplaceDefinition(@NotNull QName itemName, @Nullable ItemDefinition<?> newDefinition)Replaces a definition for given item name with a provided one.default ResourceAttributeContainerDefinitiontoResourceAttributeContainerDefinition()CreatesResourceAttributeContainerDefinitionwith this definition as a complex type definition.default ResourceAttributeContainerDefinitiontoResourceAttributeContainerDefinition(QName elementName)CreatesResourceAttributeContainerDefinition(with given item name) with this definition as a complex type definition.default voidvalidate()Executes some basic checks on this object type.-
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, isItemDefinitionRemoved, isStrictAnyMarker, toMutable
-
Methods inherited from interface com.evolveum.midpoint.prism.deleg.ComplexTypeDefinitionDelegator
findContainerDefinition, findItemDefinition, findItemDefinition, findReferenceDefinition, getDefaultNamespace, getDefinitions, getDiagrams, getExtensionForType, getIgnoredNamespaces, hasOperationalOnlyItems, hasSubstitutions, isContainerMarker, isEmpty, isListMarker, isObjectMarker, isReferenceMarker, isXsdAnyMarker, itemOrSubstitution, merge, substitution, trimTo
-
Methods inherited from interface com.evolveum.midpoint.prism.deleg.DefinitionDelegator
accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getPrismContext, getProcessing, getSchemaMigrations, getSchemaRegistry, getTypeClass, 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, getPrimaryIdentifierRequired, isIdentifier
-
Methods inherited from interface com.evolveum.midpoint.prism.LocalItemDefinitionStore
containsItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition
-
Methods inherited from interface com.evolveum.midpoint.schema.processor.ResourceObjectDefinition
clone, deepClone, getActivationBidirectionalMappingType, getActivationFetchStrategy, getAuxiliaryDefinitions, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, instantiate, matchesObjectClassName, replaceDefinition
-
Methods inherited from interface com.evolveum.midpoint.prism.TypeDefinition
isAssignableFrom
-
Methods inherited from interface com.evolveum.midpoint.prism.deleg.TypeDefinitionDelegator
canRepresent, getCompileTimeClass, getInstantiationOrder, getStaticSubTypes, getSuperType
-
-
-
-
Method Detail
-
delegate
ResourceObjectDefinition delegate()
- Specified by:
delegatein interfaceComplexTypeDefinitionDelegator- Specified by:
delegatein interfaceDefinitionDelegator- Specified by:
delegatein interfaceTypeDefinitionDelegator
-
getAttributeDefinitions
@NotNull default @NotNull List<? extends ResourceAttributeDefinition<?>> getAttributeDefinitions()
Description copied from interface:AttributeDefinitionStoreReturns all attribute definitions as an unmodifiable collection. Should be the same content as returned by `getDefinitions`. The returned value is aListbecause of the contract ofComplexTypeDefinition.getDefinitions().- Specified by:
getAttributeDefinitionsin interfaceAttributeDefinitionStore
-
findAttributeDefinition
@Nullable default @Nullable ResourceAttributeDefinition<?> findAttributeDefinition(QName name, boolean caseInsensitive)
Description copied from interface:AttributeDefinitionStoreFinds a attribute definition by looking at the property name. Returns null if nothing is found.- Specified by:
findAttributeDefinitionin interfaceAttributeDefinitionStore- Parameters:
name- property definition namecaseInsensitive- if true, ignoring the case- Returns:
- found property definition or null
-
findAttributeDefinition
default ResourceAttributeDefinition<?> findAttributeDefinition(String name)
Description copied from interface:AttributeDefinitionStoreFinds attribute definition using local name only. BEWARE: Ignores attributes in namespaces other than "ri:" (e.g. icfs:uid and icfs:name).- Specified by:
findAttributeDefinitionin interfaceAttributeDefinitionStore
-
getPrimaryIdentifiers
@NotNull default @NotNull Collection<? extends ResourceAttributeDefinition<?>> getPrimaryIdentifiers()
Description copied from interface:IdentifiersDefinitionStoreReturns 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:
getPrimaryIdentifiersin interfaceIdentifiersDefinitionStore- Returns:
- definition of identifier attributes
-
isPrimaryIdentifier
default boolean isPrimaryIdentifier(QName attrName)
Description copied from interface:IdentifiersDefinitionStoreReturns 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:
isPrimaryIdentifierin interfaceIdentifiersDefinitionStore
-
getSecondaryIdentifiers
@NotNull default @NotNull Collection<? extends ResourceAttributeDefinition<?>> getSecondaryIdentifiers()
Description copied from interface:IdentifiersDefinitionStoreReturns 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:
getSecondaryIdentifiersin interfaceIdentifiersDefinitionStore- Returns:
- definition of secondary identifier attributes
-
isSecondaryIdentifier
default boolean isSecondaryIdentifier(QName attrName)
Description copied from interface:IdentifiersDefinitionStoreReturns 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:
isSecondaryIdentifierin interfaceIdentifiersDefinitionStore
-
getDescriptionAttribute
default ResourceAttributeDefinition<?> getDescriptionAttribute()
Description copied from interface:ResourceObjectDefinitionReturns 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. NOTE: Currently seems to be not used. (Neither not set nor used.)- Specified by:
getDescriptionAttributein interfaceResourceObjectDefinition
-
getNamingAttribute
default ResourceAttributeDefinition<?> getNamingAttribute()
Description copied from interface:ResourceObjectDefinitionReturns the attribute used as a visible name of the resource object.- Specified by:
getNamingAttributein interfaceResourceObjectDefinition
-
getDisplayNameAttribute
default ResourceAttributeDefinition<?> getDisplayNameAttribute()
Description copied from interface:ResourceObjectDefinitionReturns 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. NOTE: Currently seems to be not used. (Neither not set nor used.)- Specified by:
getDisplayNameAttributein interfaceResourceObjectDefinition
-
toResourceAttributeContainerDefinition
default ResourceAttributeContainerDefinition toResourceAttributeContainerDefinition()
Description copied from interface:ResourceObjectDefinitionCreatesResourceAttributeContainerDefinitionwith this definition as a complex type definition.- Specified by:
toResourceAttributeContainerDefinitionin interfaceResourceObjectDefinition
-
toResourceAttributeContainerDefinition
default ResourceAttributeContainerDefinition toResourceAttributeContainerDefinition(QName elementName)
Description copied from interface:ResourceObjectDefinitionCreatesResourceAttributeContainerDefinition(with given item name) with this definition as a complex type definition.- Specified by:
toResourceAttributeContainerDefinitionin interfaceResourceObjectDefinition
-
getPrismObjectDefinition
default PrismObjectDefinition<ShadowType> getPrismObjectDefinition()
Description copied from interface:ResourceObjectDefinitionReturns a prism definition for the prism object/objects carrying the resource object/objects.- Specified by:
getPrismObjectDefinitionin interfaceResourceObjectDefinition
-
getPasswordDefinition
@Nullable default @Nullable ResourcePasswordDefinitionType getPasswordDefinition()
Description copied from interface:ResourceObjectDefinition- Specified by:
getPasswordDefinitionin interfaceResourceObjectDefinition
-
getObjectClassDefinition
@NotNull default @NotNull ResourceObjectClassDefinition getObjectClassDefinition()
Description copied from interface:ResourceObjectDefinitionReturns the (raw or refined) object class definition. It is either this object itself (for object classes), or the linked object class definition (for object types).- Specified by:
getObjectClassDefinitionin interfaceResourceObjectDefinition
-
getObjectClassName
@NotNull default @NotNull QName getObjectClassName()
Description copied from interface:ResourceObjectDefinitionReturns the name of the object class.- Specified by:
getObjectClassNamein interfaceResourceObjectDefinition
-
getDescriptionAttributeName
@Nullable default @Nullable QName getDescriptionAttributeName()
Description copied from interface:ResourceObjectDefinitionReturns name of the description attribute.- Specified by:
getDescriptionAttributeNamein interfaceResourceObjectDefinition- See Also:
ResourceObjectDefinition.getDescriptionAttribute()
-
getNamingAttributeName
@Nullable default @Nullable QName getNamingAttributeName()
Description copied from interface:ResourceObjectDefinitionReturns name of the naming attribute.- Specified by:
getNamingAttributeNamein interfaceResourceObjectDefinition- See Also:
ResourceObjectDefinition.getNamingAttributeName()
-
getDisplayNameAttributeName
@Nullable default @Nullable QName getDisplayNameAttributeName()
Description copied from interface:ResourceObjectDefinitionReturns name of the display name attribute.- Specified by:
getDisplayNameAttributeNamein interfaceResourceObjectDefinition- See Also:
ResourceObjectDefinition.getDisplayNameAttribute()
-
createBlankShadow
default PrismObject<ShadowType> createBlankShadow(String resourceOid, String tag)
Description copied from interface:ResourceObjectDefinitionCreates a blankShadowTypeobject, with the attributes container having appropriate definition.- Specified by:
createBlankShadowin interfaceResourceObjectDefinition
-
getEnabledCapability
default <T extends CapabilityType> T getEnabledCapability(@NotNull @NotNull Class<T> capabilityClass, ResourceType resource)
Description copied from interface:ResourceObjectDefinitionChecks the presence of capability in: 1. resource object definition (applicable only to resource object _type_ definitions), 2. additional connectors in resource (only if enabled there), 3. the main connector. Returns the present capability, but only if it's enabled.- Specified by:
getEnabledCapabilityin interfaceResourceObjectDefinition
-
getHumanReadableName
default String getHumanReadableName()
Description copied from interface:ResourceObjectDefinitionTODO- Specified by:
getHumanReadableNamein interfaceResourceObjectDefinition
-
getAssociationDefinitions
@NotNull default @NotNull Collection<ResourceAssociationDefinition> getAssociationDefinitions()
Description copied from interface:AssociationDefinitionStoreReturns 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:
getAssociationDefinitionsin interfaceAssociationDefinitionStore
-
getPrimaryIdentifiersNames
@NotNull default @NotNull Collection<QName> getPrimaryIdentifiersNames()
Description copied from interface:IdentifiersDefinitionStoreReturns names of primary identifiers.- Specified by:
getPrimaryIdentifiersNamesin interfaceIdentifiersDefinitionStore- See Also:
IdentifiersDefinitionStore.getPrimaryIdentifiers()
-
getSecondaryIdentifiersNames
@NotNull default @NotNull Collection<QName> getSecondaryIdentifiersNames()
Description copied from interface:IdentifiersDefinitionStoreReturns names of secondary identifiers.- Specified by:
getSecondaryIdentifiersNamesin interfaceIdentifiersDefinitionStore- See Also:
()
-
getDebugDumpClassName
default String getDebugDumpClassName()
Description copied from interface:ResourceObjectDefinitionReturn a human readable name of this class suitable for logs.- Specified by:
getDebugDumpClassNamein interfaceResourceObjectDefinition
-
forLayer
default ResourceObjectDefinition forLayer(@NotNull @NotNull LayerType layer)
Description copied from interface:ResourceObjectDefinitionCreates a layer-specific version of this definition.- Specified by:
forLayerin interfaceResourceObjectDefinition
-
getSecurityPolicyRef
default ObjectReferenceType getSecurityPolicyRef()
- Specified by:
getSecurityPolicyRefin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getSecurityPolicyRef()
-
replaceDefinition
default void replaceDefinition(@NotNull @NotNull QName itemName, @Nullable @Nullable ItemDefinition<?> newDefinition)Description copied from interface:ResourceObjectDefinitionReplaces a definition for given item name with a provided one.- Specified by:
replaceDefinitionin interfaceResourceObjectDefinition
-
getCurrentLayer
@NotNull default @NotNull LayerType getCurrentLayer()
Description copied from interface:LayeredDefinitionGets the current point-of-view: on which layer do we look at the data?- Specified by:
getCurrentLayerin interfaceLayeredDefinition
-
getDescription
default String getDescription()
Description copied from interface:ResourceObjectDefinitionFree-form textual description of the object. It is supposed to describe the object or a construct that it is attached to.- Specified by:
getDescriptionin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getDescription()
-
getResourceOid
default String getResourceOid()
Description copied from interface:ResourceObjectDefinitionThis is currently used only to pass information about association in the model-impl TODO consider removal!- Specified by:
getResourceOidin interfaceResourceObjectDefinition
-
getObjectMultiplicity
default ResourceObjectMultiplicityType getObjectMultiplicity()
- Specified by:
getObjectMultiplicityin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getMultiplicity()
-
getProjectionPolicy
default ProjectionPolicyType getProjectionPolicy()
- Specified by:
getProjectionPolicyin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getProjection()
-
hasAuxiliaryObjectClass
default boolean hasAuxiliaryObjectClass(QName expectedObjectClassName)
Description copied from interface:ResourceObjectDefinitionTODO define semantics (it's different forCompositeObjectDefinitionand the others!- Specified by:
hasAuxiliaryObjectClassin interfaceResourceObjectDefinition
-
getAuxiliaryObjectClassMappings
default ResourceBidirectionalMappingAndDefinitionType getAuxiliaryObjectClassMappings()
- Specified by:
getAuxiliaryObjectClassMappingsin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getAuxiliaryObjectClassMappings()
-
getProtectedObjectPatterns
@NotNull default @NotNull Collection<ResourceObjectPattern> getProtectedObjectPatterns()
Description copied from interface:ResourceObjectDefinitionReturns compiled patterns denoting protected objects.- Specified by:
getProtectedObjectPatternsin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getProtected()
-
getActivationSchemaHandling
default ResourceActivationDefinitionType getActivationSchemaHandling()
- Specified by:
getActivationSchemaHandlingin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getActivation()
-
getDelineation
@NotNull default @NotNull ResourceObjectTypeDelineation getDelineation()
Description copied from interface:ResourceObjectDefinitionReturns the delineation of the set of objects belonging to this object type. Note that this tells only about information stored right in the definition bean, i.e. legacy configuration is not provided here. The complete picture is provided bySynchronizationPolicy.getDelineation().- Specified by:
getDelineationin interfaceResourceObjectDefinition
-
getBaseContext
default ResourceObjectReferenceType getBaseContext()
Description copied from interface:ResourceObjectDefinitionThe definition of base context (resource object container). This object will be used as a base for searches for objects of this type.- Specified by:
getBaseContextin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getBaseContext()
-
getSearchHierarchyScope
default SearchHierarchyScope getSearchHierarchyScope()
Description copied from interface:ResourceObjectDefinitionDefinition of search hierarchy scope. It specifies how "deep" the search should go into the object hierarchy.- Specified by:
getSearchHierarchyScopein interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getSearchHierarchyScope()
-
getVolatility
@NotNull default @NotNull ResourceObjectVolatilityType getVolatility()
Description copied from interface:ResourceObjectDefinitionSpecifies volatility of this type of resource objects, i.e. whether such an object can change when midPoint is not looking.- Specified by:
getVolatilityin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getVolatility()
-
getDefaultInboundMappingEvaluationPhases
@Nullable default @Nullable DefaultInboundMappingEvaluationPhasesType getDefaultInboundMappingEvaluationPhases()
Description copied from interface:ResourceObjectDefinitionReturns the phases in which inbound mappings are evaluated by default.- Specified by:
getDefaultInboundMappingEvaluationPhasesin interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getMappingsEvaluation()
-
getLifecycleState
@Nullable default @Nullable String getLifecycleState()
Description copied from interface:ResourceObjectDefinitionWhat lifecycle state is the (refined) object class or object type definition? Raw object class definition should always return `null` here.- Specified by:
getLifecycleStatein interfaceResourceObjectDefinition- See Also:
ResourceObjectTypeDefinitionType.getLifecycleState()
-
getConfiguredAuxiliaryObjectClassNames
default Collection<QName> getConfiguredAuxiliaryObjectClassNames()
Description copied from interface:ResourceObjectDefinitionReturns the names of auxiliary object classes that are "statically" defined for this object type (or object class, in the future). For dynamically composed definitions (CompositeObjectDefinitiononly the statically-defined ones (i.e. those from the structural definition) are returned.- Specified by:
getConfiguredAuxiliaryObjectClassNamesin interfaceResourceObjectDefinition
-
validate
default void validate() throws SchemaExceptionDescription copied from interface:ResourceObjectDefinitionExecutes some basic checks on this object type. Moved from `validateObjectClassDefinition()` method inResourceTypeUtil. TODO review this method- Specified by:
validatein interfaceResourceObjectDefinition- Throws:
SchemaException
-
getDefinitionBean
@NotNull default @NotNull ResourceObjectTypeDefinitionType getDefinitionBean()
Description copied from interface:ResourceObjectDefinitionReturns the "raw" configuration bean for this object type. BEWARE: In the case of inherited object types, this is only the partial information. (Parts inherited from the parents are not returned.)- Specified by:
getDefinitionBeanin interfaceResourceObjectDefinition
-
getRawObjectClassDefinition
@NotNull default @NotNull ResourceObjectClassDefinition getRawObjectClassDefinition()
Description copied from interface:ResourceObjectDefinitionReturns the raw object class definition.- Specified by:
getRawObjectClassDefinitionin interfaceResourceObjectDefinition
-
createShadowSearchQuery
@NotNull default @NotNull ObjectQuery createShadowSearchQuery(String resourceOid) throws SchemaException
Description copied from interface:ResourceObjectDefinitionCreates 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:
createShadowSearchQueryin interfaceResourceObjectDefinition- Throws:
SchemaException
-
getTypeIdentification
@Nullable default @Nullable ResourceObjectTypeIdentification getTypeIdentification()
Description copied from interface:ResourceObjectDefinitionIs this definition bound to a specific resource type? If yes, this method returns its identification.- Specified by:
getTypeIdentificationin interfaceResourceObjectDefinition
-
getTypeDefinition
@Nullable default @Nullable ResourceObjectTypeDefinition getTypeDefinition()
Description copied from interface:ResourceObjectDefinitionIs this definition bound to a specific resource type? If yes, this method returns its definition.- Specified by:
getTypeDefinitionin interfaceResourceObjectDefinition
-
isDefaultFor
default boolean isDefaultFor(@NotNull @NotNull ShadowKindType kind)Description copied from interface:ResourceObjectDefinitionReturns 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 ofResourceObjectClassDefinitionwithResourceObjectClassDefinition.isDefaultAccountDefinition()being `true`. It is considered to be the default forShadowKindType.ACCOUNT. Use with care!- Specified by:
isDefaultForin interfaceResourceObjectDefinition
-
-