Package com.evolveum.midpoint.schema.util

Interface AbstractShadow

All Superinterfaces:

Cloneable, DebugDumpable, Serializable, ShadowLikeValue, ShortDumpable

All Known Implementing Classes:

AbstractShadow.Impl

public interface AbstractShadow
extends ShadowLikeValue, ShortDumpable, DebugDumpable, Cloneable

Either a resource object, or a repository shadow (after being adopted by provisioning, i.e. with the definitions applied). Conditions: . the definition is known (getObjectDefinition()) . the bean has the definitions applied . the bean has attributes container (which can be empty) See checkConsistence().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AbstractShadow.Impl	The default implementation.

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default AbstractShadow	addSimpleAttribute(QName attributeName, Object realValue)
default void	applyDefinition(@NotNull ResourceObjectDefinition newDefinition)
default void	applyDelta(@NotNull ItemDelta<?,?> itemDelta)
default void	checkAttributeDefinitions()
default void	checkConsistence()	These checks are to be executed even in production (at least when creating the object).
default void	checkConsistenceComplex(String desc)	TODO merge with checkConsistence()
AbstractShadow	clone()
default PolyString	determineShadowName()
default boolean	doesExist()
default <X> @Nullable ShadowSimpleAttribute<X>	findAttribute(@NotNull QName name)
default @NotNull Collection<ShadowSimpleAttribute<?>>	getAllIdentifiers()
default @NotNull Collection<ShadowAssociation>	getAssociations()
default @NotNull ShadowAssociationsCollection	getAssociationsCollection()
default @Nullable ShadowAssociationsContainer	getAssociationsContainer()
default @NotNull Collection<? extends ShadowAssociationValue>	getAssociationValues(QName assocName)
default <T> T	getAttributeRealValue(QName attrName)
default <T> @NotNull List<T>	getAttributeRealValues(QName attrName)
default @NotNull Collection<ShadowAttribute<?,?,?,?>>	getAttributes()
default @NotNull ShadowAttributesContainer	getAttributesContainer()
default @NotNull ShadowAttributesContainerDefinition	getAttributesContainerDefinition()	Should correspond to getObjectDefinition().
default <X> @NotNull Collection<PrismPropertyValue<X>>	getAttributeValues(@NotNull QName name)
@NotNull ShadowType	getBean()	Returns the ShadowType bean backing this object.
default @Nullable ShadowContentDescriptionType	getContentDescription()
default @NotNull ShadowContentDescriptionType	getContentDescriptionRequired()
default @NotNull ObjectOperationPolicyType	getEffectiveOperationPolicyRequired()
default Object	getHumanReadableNameLazily()
default @Nullable ResourceObjectIdentification<?>	getIdentification()
default @NotNull ResourceObjectIdentification<?>	getIdentificationRequired()
default @Nullable ResourceObjectIdentifiers	getIdentifiers()
default @NotNull ResourceObjectIdentifiers	getIdentifiersRequired()
default @Nullable ShadowKindType	getKind()
default PolyStringType	getName()
default @NotNull QName	getObjectClass()
default @NotNull QName	getObjectClassName()
default @NotNull ResourceObjectDefinition	getObjectDefinition()	Returns the definition corresponding to this shadow.
default @Nullable String	getOid()
default @NotNull String	getOidRequired()
default @NotNull ShadowAssociationsContainer	getOrCreateAssociationsContainer()
default ResourceObjectIdentification.WithPrimary	getPrimaryIdentification()
default <T> @Nullable ShadowSimpleAttribute<T>	getPrimaryIdentifierAttribute()
default <T> @NotNull ShadowSimpleAttribute<T>	getPrimaryIdentifierAttributeRequired()
default @Nullable Object	getPrimaryIdentifierValueFromAttributes()
default @NotNull PrismObject<ShadowType>	getPrismObject()
default @Nullable ObjectReferenceType	getRef()	Currently, returns "plain" reference (only type + OID).
default @Nullable ShadowReferenceAttribute	getReferenceAttribute(QName attrName)
default @NotNull Collection<ShadowReferenceAttribute>	getReferenceAttributes()	Returns a detached, immutable list.
default @NotNull ShadowReferenceAttributesCollection	getReferenceAttributesCollection()
default @Nullable ShadowReferenceAttributeValue	getReferenceAttributeSingleValue(QName attrName)
default @NotNull Collection<ShadowReferenceAttributeValue>	getReferenceAttributeValues(QName attrName)
default @NotNull ObjectReferenceType	getRefWithEmbeddedObject()
default @Nullable String	getResourceOid()
default @NotNull String	getResourceOidRequired()
default <T> @Nullable ShadowSimpleAttribute<T>	getSimpleAttribute(QName attrName)
default <T> @NotNull ShadowSimpleAttribute<T>	getSimpleAttributeRequired(QName attrName)
default @NotNull Collection<ShadowSimpleAttribute<?>>	getSimpleAttributes()
default ResourceObjectTypeIdentification	getTypeIdentification()
default boolean	hasAuxiliaryObjectClass(@NotNull QName name)
default boolean	hasPrimaryIdentifier()
default boolean	isClassified()
default boolean	isDead()
default boolean	isError()	True if the shadow could not be correctly fetched from the resource.
default boolean	isIdentificationOnly()
default boolean	isImmutable()
default boolean	isProtectedObject()
static AbstractShadow	of(@NotNull PrismObject<ShadowType> prismObject)
static AbstractShadow	of(@NotNull ShadowType bean)
default void	setIdentificationOnly()
default void	setObjectType(@Nullable ResourceObjectTypeIdentification typeIdentification)
default void	shortDump(StringBuilder sb)	Show the content of the object intended for diagnostics.
default void	updateWith(@NotNull Collection<? extends ItemDelta<?,?>> modifications)	Updates the in-memory representation.
@NotNull AbstractShadow	withNewContent(@NotNull ShadowType newBean)	Replaces the in-memory representation with the new content but the same definition.

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

shortDump, shortDumpLazily

Method Details

of

static AbstractShadow of(@NotNull
 @NotNull ShadowType bean)

of

static AbstractShadow of(@NotNull
 @NotNull PrismObject<ShadowType> prismObject)

getBean

@NotNull
@NotNull ShadowType getBean()

Returns the ShadowType bean backing this object. It should meet the criteria for individual subtypes.

getOid

@Nullable
default @Nullable String getOid()

getOidRequired

@NotNull
default @NotNull String getOidRequired()

getRef

@Nullable
default @Nullable ObjectReferenceType getRef()

Currently, returns "plain" reference (only type + OID). This may change in the future. Returns null if there's no OID.

getRefWithEmbeddedObject

@NotNull
default @NotNull ObjectReferenceType getRefWithEmbeddedObject()

getObjectDefinition

@NotNull
default @NotNull ResourceObjectDefinition getObjectDefinition()

Returns the definition corresponding to this shadow.

getPrismObject

@NotNull
default @NotNull PrismObject<ShadowType> getPrismObject()

isDead

default boolean isDead()

doesExist

default boolean doesExist()

isImmutable

default boolean isImmutable()

shortDump

default void shortDump(StringBuilder sb)

Description copied from interface: ShortDumpable

Show the content of the object intended for diagnostics. This method is supposed to append a compact, human-readable output in a single line. Unlike toString() method, there is no requirement to identify the actual class or type of the object. It is assumed that the class/type will be obvious from the context in which the output is used.

Specified by:

shortDump in interface ShortDumpable

Parameters:

sb - StringBuilder to which to a compact one-line content of the object intended for diagnostics by system administrator should be appended.

getIdentifiers

@Nullable
default @Nullable ResourceObjectIdentifiers getIdentifiers()
                                                    throws SchemaException

Throws:

SchemaException

getAllIdentifiers

@NotNull
default @NotNull Collection<ShadowSimpleAttribute<?>> getAllIdentifiers()

hasPrimaryIdentifier

default boolean hasPrimaryIdentifier()
                              throws SchemaException

Throws:

SchemaException

getIdentifiersRequired

@NotNull
default @NotNull ResourceObjectIdentifiers getIdentifiersRequired()
                                                           throws SchemaException

Throws:

SchemaException

getIdentificationRequired

@NotNull
default @NotNull ResourceObjectIdentification<?> getIdentificationRequired()
                                                                    throws SchemaException

Throws:

SchemaException

getPrimaryIdentifierAttribute

@Nullable
default <T> @Nullable ShadowSimpleAttribute<T> getPrimaryIdentifierAttribute()

getPrimaryIdentifierAttributeRequired

@NotNull
default <T> @NotNull ShadowSimpleAttribute<T> getPrimaryIdentifierAttributeRequired()

getPrimaryIdentification

@Nullable
default ResourceObjectIdentification.WithPrimary getPrimaryIdentification()
                                                                   throws SchemaException

Throws:

SchemaException

getPrimaryIdentifierValueFromAttributes

@Nullable
default @Nullable Object getPrimaryIdentifierValueFromAttributes()
                                                          throws SchemaException

Throws:

SchemaException

getIdentification

@Nullable
default @Nullable ResourceObjectIdentification<?> getIdentification()
                                                             throws SchemaException

Throws:

SchemaException

updateWith

default void updateWith(@NotNull
 @NotNull Collection<? extends ItemDelta<?,?>> modifications)
                 throws SchemaException

Updates the in-memory representation.

Throws:

SchemaException

withNewContent

@NotNull
@NotNull AbstractShadow withNewContent(@NotNull
 @NotNull ShadowType newBean)

Replaces the in-memory representation with the new content but the same definition. Returns a new instance.

getResourceOidRequired

@NotNull
default @NotNull String getResourceOidRequired()

getResourceOid

@Nullable
default @Nullable String getResourceOid()

getObjectClassName

@NotNull
default @NotNull QName getObjectClassName()
                                   throws SchemaException

Throws:

SchemaException

determineShadowName

default PolyString determineShadowName()
                                throws SchemaException

Throws:

SchemaException

getAttributesContainer

@NotNull
default @NotNull ShadowAttributesContainer getAttributesContainer()

getAttributes

@NotNull
default @NotNull Collection<ShadowAttribute<?,?,?,?>> getAttributes()

getSimpleAttributes

@NotNull
default @NotNull Collection<ShadowSimpleAttribute<?>> getSimpleAttributes()

getAssociations

@NotNull
default @NotNull Collection<ShadowAssociation> getAssociations()

getAttributesContainerDefinition

@NotNull
default @NotNull ShadowAttributesContainerDefinition getAttributesContainerDefinition()

Should correspond to getObjectDefinition().

findAttribute

@Nullable
default <X> @Nullable ShadowSimpleAttribute<X> findAttribute(@NotNull
 @NotNull QName name)

getAttributeValues

@NotNull
default <X>
@NotNull Collection<PrismPropertyValue<X>> getAttributeValues(@NotNull
 @NotNull QName name)

hasAuxiliaryObjectClass

default boolean hasAuxiliaryObjectClass(@NotNull
 @NotNull QName name)

checkConsistence

default void checkConsistence()

These checks are to be executed even in production (at least when creating the object).

checkConsistenceComplex

default void checkConsistenceComplex(String desc)

TODO merge with checkConsistence()

checkAttributeDefinitions

default void checkAttributeDefinitions()

clone

AbstractShadow clone()

applyDefinition

default void applyDefinition(@NotNull
 @NotNull ResourceObjectDefinition newDefinition)
                      throws SchemaException

Throws:

SchemaException

getName

default PolyStringType getName()

getAttributeRealValues

@NotNull
default <T> @NotNull List<T> getAttributeRealValues(QName attrName)

getAttributeRealValue

@Nullable
default <T> T getAttributeRealValue(QName attrName)

getSimpleAttribute

@Nullable
default <T> @Nullable ShadowSimpleAttribute<T> getSimpleAttribute(QName attrName)

getReferenceAttribute

@Nullable
default @Nullable ShadowReferenceAttribute getReferenceAttribute(QName attrName)

getReferenceAttributeSingleValue

@Nullable
default @Nullable ShadowReferenceAttributeValue getReferenceAttributeSingleValue(QName attrName)

getReferenceAttributeValues

@NotNull
default @NotNull Collection<ShadowReferenceAttributeValue> getReferenceAttributeValues(QName attrName)

getSimpleAttributeRequired

@NotNull
default <T> @NotNull ShadowSimpleAttribute<T> getSimpleAttributeRequired(QName attrName)

getAssociationsContainer

@Nullable
default @Nullable ShadowAssociationsContainer getAssociationsContainer()

See Also:

• ShadowUtil.getAssociationsContainer(ShadowType)

getOrCreateAssociationsContainer

@NotNull
default @NotNull ShadowAssociationsContainer getOrCreateAssociationsContainer()

getReferenceAttributes

@NotNull
default @NotNull Collection<ShadowReferenceAttribute> getReferenceAttributes()

Returns a detached, immutable list.

getReferenceAttributesCollection

@NotNull
default @NotNull ShadowReferenceAttributesCollection getReferenceAttributesCollection()

getKind

@Nullable
default @Nullable ShadowKindType getKind()

getObjectClass

@NotNull
default @NotNull QName getObjectClass()

isClassified

default boolean isClassified()

isProtectedObject

default boolean isProtectedObject()

applyDelta

default void applyDelta(@NotNull
 @NotNull ItemDelta<?,?> itemDelta)
                 throws SchemaException

Throws:

SchemaException

getHumanReadableNameLazily

default Object getHumanReadableNameLazily()

getAssociationValues

@NotNull
default @NotNull Collection<? extends ShadowAssociationValue> getAssociationValues(QName assocName)

getAssociationsCollection

@NotNull
default @NotNull ShadowAssociationsCollection getAssociationsCollection()

getTypeIdentification

default ResourceObjectTypeIdentification getTypeIdentification()

setObjectType

default void setObjectType(@Nullable
 @Nullable ResourceObjectTypeIdentification typeIdentification)

getContentDescriptionRequired

@NotNull
default @NotNull ShadowContentDescriptionType getContentDescriptionRequired()

getContentDescription

@Nullable
default @Nullable ShadowContentDescriptionType getContentDescription()

getEffectiveOperationPolicyRequired

@NotNull
default @NotNull ObjectOperationPolicyType getEffectiveOperationPolicyRequired()

addSimpleAttribute

default AbstractShadow addSimpleAttribute(QName attributeName,
 Object realValue)
                                   throws SchemaException

Throws:

SchemaException

isIdentificationOnly

default boolean isIdentificationOnly()

setIdentificationOnly

default void setIdentificationOnly()

isError

default boolean isError()

True if the shadow could not be correctly fetched from the resource. Beware, maintenance mode signals OperationResultStatusType.PARTIAL_ERROR here. TODO is it good that this method is overridden in the subclass?