Package com.evolveum.midpoint.schema.processor

Class ShadowAssociationValue

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.PrismValueImpl

com.evolveum.midpoint.prism.impl.PrismContainerValueImpl<ShadowAssociationValueType>

com.evolveum.midpoint.schema.processor.ShadowAssociationValue

All Implemented Interfaces:

Freezable, ItemDefinitionTransformer.TransformableValue, MidpointOriginMetadata, ParentVisitable, PathVisitable, PrismContainerValue<ShadowAssociationValueType>, PrismValue, PrismVisitable, Revivable, SchemaLookup.Aware, Visitable, ShadowLikeValue, DebugDumpable, Serializable

@Experimental
public class ShadowAssociationValue
extends com.evolveum.midpoint.prism.impl.PrismContainerValueImpl<ShadowAssociationValueType>
implements ShadowLikeValue

Represents a specific shadow association value - i.e. something that is put into ShadowReferenceAttribute. For example, a single group membership for a given account: `joe` is a member of `admins`. NOTE: As an experiment, we try to keep instances as consistent as possible. E.g., we require correct `shadowRef` etc. Any places where this is checked, will throw IllegalStateException instead of SchemaException. We will simply not allow creating a non-compliant association object. At least we'll try to do this. The exception are situations where the object exists between instantiation and providing the data. *Instantiation* In particular, we must provide reasonable CTD when instantiating this object. Otherwise, PrismContainerValue.asContainerable() will fail. TODO check if it's possible to implement this approach regarding createNewValue in ShadowAssociation

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismContainerValue

PrismContainerValue.RemovedItemDefinitionException

Field Summary

Fields inherited from class com.evolveum.midpoint.prism.impl.PrismContainerValueImpl

complexTypeDefinition, DIFFERENT_ITEMS_EXCEPTION, items, unqualifiedItemNames

Fields inherited from class com.evolveum.midpoint.prism.impl.PrismValueImpl

defaultEquivalenceStrategy

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
protected boolean	appendExtraHeaderDump(StringBuilder sb, int indent, boolean wasIndent)
ShadowAssociationValue	clone()	Literal clone.
ShadowAssociationValue	cloneComplex(CloneStrategy strategy)	Complex clone with different cloning strategies.
protected void	copyValues(CloneStrategy strategy, ShadowAssociationValue clone)
String	debugDump(int indent)
static ShadowAssociationValue	empty(@NotNull ShadowAssociationDefinition definition)	We need the definition to provide correct CTD.
protected boolean	equalsItems(PrismContainerValue<ShadowAssociationValueType> other, ParameterizedEquivalenceStrategy strategy)	Custom logic of comparing the content of an association value - applies to all equivalence strategies, except for the "more literal" ones.
ShadowAssociationValue	fillFromReferenceAttributeValue(@NotNull ShadowReferenceAttributeValue refAttrValue)	Fills-in this value from a (fully resolved) ShadowReferenceAttributeValue.
static @NotNull ShadowAssociationValue	fromAssociationDataObject(@NotNull AbstractShadow associationObject, @NotNull ShadowAssociationDefinition associationDefinition)	Creates a new value from the association object.
static @NotNull ShadowAssociationValue	fromBean(@NotNull ShadowAssociationValueType bean, @NotNull ShadowAssociationDefinition definition)	Converts association value bean to wrapped ShadowAssociationValue basically by cloning its content and selected properties (e.g., parent and ID).
ActivationType	getActivation()
@NotNull AbstractShadow	getAssociationDataObject()	Returns the associated object as an AbstractShadow.
@NotNull Collection<ShadowSimpleAttribute<?>>	getAttributes()	Note that these attributes are always simple.
@Nullable ShadowAttributesContainer	getAttributesContainer()
@NotNull ShadowAttributesContainer	getAttributesContainerRequired()
@NotNull PrismContainerDefinition<ShadowAssociationValueType>	getDefinition()
@NotNull ShadowAssociationDefinition	getDefinitionRequired()
@NotNull Collection<ShadowReferenceAttribute>	getObjectReferences()
@Nullable ShadowAttributesContainer	getObjectsContainer()
@NotNull ShadowAttributesContainer	getObjectsContainerRequired()
@NotNull ShadowAttributesContainer	getOrCreateAttributesContainer()
@NotNull ShadowAttributesContainer	getOrCreateObjectsContainer()
@Nullable ObjectReferenceType	getSingleObjectRefRelaxed()
@NotNull ObjectReferenceType	getSingleObjectRefRequired()
@NotNull ShadowReferenceAttributeValue	getSingleObjectRefValueRequired()
@NotNull ShadowType	getSingleObjectShadowBeanRequired()
@NotNull AbstractShadow	getSingleObjectShadowRequired()
boolean	hasAssociationObject()
boolean	isInboundMembershipSynchronizationDisabled()
boolean	matches(ShadowAssociationValue other)
static @NotNull EqualsChecker<ShadowAssociationValue>	semanticEqualsChecker()	Returns an equals checker that compares two association values by their meaning.
@NotNull ShadowReferenceAttributeValue	toReferenceAttributeValue()	Converts this value into the low-level representation by a reference attribute.
@NotNull ShadowReferenceAttributeValue	toReferenceAttributeValueUnchecked()

Methods inherited from class com.evolveum.midpoint.prism.impl.PrismContainerValueImpl

accept, accept, acceptParentVisitor, add, add, addAll, addAllReplaceExisting, addRawElement, addReplaceExisting, applyDefinition, applyDefinition, applyDefinition, asContainerable, asContainerable, asContainerable, asContainerables, asContainerables, asPrismContainerValues, assertDefinitions, assertDefinitions, asSingleValuedContainer, canRepresent, checkConsistenceInternal, clear, contains, contains, containsItem, containsRealValue, copyValues, createDetachedSubItem, createImmutableClone, createProperty, createProperty, debugDumpIdentifiers, deleteRawElement, detailedDebugDumpStart, diffMatchingRepresentation, equals, equivalent, find, findContainer, findItem, findItem, findOrCreateContainer, findOrCreateItem, findOrCreateItem, findOrCreateItem, findOrCreateProperty, findOrCreateProperty, findOrCreateReference, findPartial, findProperty, findProperty, findReference, getAllItems, getAllValues, getCompileTimeClass, getComplexTypeDefinition, getContainer, getId, getIdentifier, getItemNames, getItems, getItems, getParent, getPath, getPathComponent, getProperties, getPropertyRealValue, getRealClass, getRealValue, getRootValue, getTypeName, getValue, hasCompleteDefinition, hashCode, hasNoItems, isEmpty, isIdOnly, isRaw, keepPaths, merge, mergeContent, normalize, performFreeze, recompute, remove, removeAll, removeContainer, removeItem, removeItems, removeOperationalItems, removePaths, removeProperty, removeRawElement, removeReference, replace, representsSameValue, revive, setId, setOriginTypeRecursive, setPropertyRealValue, simpleAdd, size, subtract, toHumanReadableString, toPcvList, toString, transformDefinition

Methods inherited from class com.evolveum.midpoint.prism.impl.PrismValueImpl

appendOriginDump, clearParent, copyValues, diff, diffMatchingRepresentation, equals, equals, getOriginObject, getOriginType, getParentContainerValue, getSchemaContext, getUserData, getUserData, getValueMetadata, getValueMetadataIfExists, hashCode, hashCode, hasValueMetadata, isTransient, recompute, schemaLookup, setOriginObject, setOriginType, setParent, setTransient, setUserData, setValueMetadata, setValueMetadata, setValueMetadata

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.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

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

checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.metadata.MidpointOriginMetadata

getOriginObject, getOriginType, setOriginObject, setOriginType

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

acceptVisitor, checkNothingExceptFor, findItem, getItemRealValue, schemaLookup

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

applyDefinitionLegacy, applyDefinitionLegacy, clearParent, cloneIfImmutable, deleteValueMetadata, diff, equals, getNearestValueOfType, getParentContainerValue, getRealValueIfExists, getRealValueOrRawType, getRootObjectable, getSchemaContext, getUserData, getUserData, getValueMetadata, getValueMetadataAsContainer, getValueMetadataIfExists, hashCode, hasRealClass, hasValueMetadata, isObjectable, isOfType, isTransient, recompute, setParent, setTransient, setUserData, setValueMetadata, setValueMetadata, setValueMetadata

Method Details

fromBean

@NotNull
public static @NotNull ShadowAssociationValue fromBean(@NotNull
 @NotNull ShadowAssociationValueType bean,
 @NotNull
 @NotNull ShadowAssociationDefinition definition)
                                                throws SchemaException

Converts association value bean to wrapped ShadowAssociationValue basically by cloning its content and selected properties (e.g., parent and ID). We should not use the original value any more, e.g. because of the copied "parent" value.

Throws:

SchemaException

fromAssociationDataObject

@NotNull
public static @NotNull ShadowAssociationValue fromAssociationDataObject(@NotNull
 @NotNull AbstractShadow associationObject,
 @NotNull
 @NotNull ShadowAssociationDefinition associationDefinition)
                                                                 throws SchemaException

Creates a new value from the association object.

Throws:

SchemaException

empty

public static ShadowAssociationValue empty(@NotNull
 @NotNull ShadowAssociationDefinition definition)

We need the definition to provide correct CTD.

clone

public ShadowAssociationValue clone()

Description copied from interface: PrismValue

Literal clone.

Specified by:

clone in interface PrismContainerValue<ShadowAssociationValueType>

Specified by:

clone in interface PrismValue

Overrides:

clone in class com.evolveum.midpoint.prism.impl.PrismContainerValueImpl<ShadowAssociationValueType>

cloneComplex

public ShadowAssociationValue cloneComplex(CloneStrategy strategy)

Description copied from interface: PrismValue

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface PrismContainerValue<ShadowAssociationValueType>

Specified by:

cloneComplex in interface PrismValue

Overrides:

cloneComplex in class com.evolveum.midpoint.prism.impl.PrismContainerValueImpl<ShadowAssociationValueType>

See Also:

• CloneStrategy

copyValues

protected void copyValues(CloneStrategy strategy,
 ShadowAssociationValue clone)

getDefinition

@NotNull
public @NotNull PrismContainerDefinition<ShadowAssociationValueType> getDefinition()

Specified by:

getDefinition in interface PrismContainerValue<ShadowAssociationValueType>

Overrides:

getDefinition in class com.evolveum.midpoint.prism.impl.PrismContainerValueImpl<ShadowAssociationValueType>

getDefinitionRequired

@NotNull
public @NotNull ShadowAssociationDefinition getDefinitionRequired()

appendExtraHeaderDump

protected boolean appendExtraHeaderDump(StringBuilder sb,
 int indent,
 boolean wasIndent)

Overrides:

appendExtraHeaderDump in class com.evolveum.midpoint.prism.impl.PrismContainerValueImpl<ShadowAssociationValueType>

getAttributesContainer

@Nullable
public @Nullable ShadowAttributesContainer getAttributesContainer()

getAttributesContainerRequired

@NotNull
public @NotNull ShadowAttributesContainer getAttributesContainerRequired()

getAttributes

@NotNull
public @NotNull Collection<ShadowSimpleAttribute<?>> getAttributes()

Note that these attributes are always simple.

getOrCreateAttributesContainer

@NotNull
public @NotNull ShadowAttributesContainer getOrCreateAttributesContainer()

getObjectsContainerRequired

@NotNull
public @NotNull ShadowAttributesContainer getObjectsContainerRequired()

getObjectsContainer

@Nullable
public @Nullable ShadowAttributesContainer getObjectsContainer()

getObjectReferences

@NotNull
public @NotNull Collection<ShadowReferenceAttribute> getObjectReferences()

getOrCreateObjectsContainer

@NotNull
public @NotNull ShadowAttributesContainer getOrCreateObjectsContainer()

getSingleObjectRefRequired

@NotNull
public @NotNull ObjectReferenceType getSingleObjectRefRequired()

getSingleObjectRefRelaxed

@Nullable
public @Nullable ObjectReferenceType getSingleObjectRefRelaxed()

getSingleObjectRefValueRequired

@NotNull
public @NotNull ShadowReferenceAttributeValue getSingleObjectRefValueRequired()

getSingleObjectShadowRequired

@NotNull
public @NotNull AbstractShadow getSingleObjectShadowRequired()

getSingleObjectShadowBeanRequired

@NotNull
public @NotNull ShadowType getSingleObjectShadowBeanRequired()

toReferenceAttributeValue

@NotNull
public @NotNull ShadowReferenceAttributeValue toReferenceAttributeValue()
                                                                 throws SchemaException

Converts this value into the low-level representation by a reference attribute. Returns a free (parent-less) object.

Throws:

SchemaException

toReferenceAttributeValueUnchecked

@TestOnly
@NotNull
public @NotNull ShadowReferenceAttributeValue toReferenceAttributeValueUnchecked()

fillFromReferenceAttributeValue

public ShadowAssociationValue fillFromReferenceAttributeValue(@NotNull
 @NotNull ShadowReferenceAttributeValue refAttrValue)
                                                       throws SchemaException

Fills-in this value from a (fully resolved) ShadowReferenceAttributeValue. This is an inversion of toReferenceAttributeValue().

Throws:

SchemaException

equalsItems

protected boolean equalsItems(PrismContainerValue<ShadowAssociationValueType> other,
 ParameterizedEquivalenceStrategy strategy)

Custom logic of comparing the content of an association value - applies to all equivalence strategies, except for the "more literal" ones. It is useful e.g. when doing computations in the projector (e.g., IDI->triple conversion, value matching, etc). I am not sure if the current mode selection (literal DOM & operational data) is 100% correct. But it's a good start. We can adapt it when needed.

Overrides:

equalsItems in class com.evolveum.midpoint.prism.impl.PrismContainerValueImpl<ShadowAssociationValueType>

semanticEqualsChecker

@NotNull
public static @NotNull EqualsChecker<ShadowAssociationValue> semanticEqualsChecker()

Returns an equals checker that compares two association values by their meaning. It takes care of the fact that `icfs:uid` is generated by the connector and its existence/non-existence should pose no difference to the comparison result. Less intuitive fact is that `icfs:name` can be generated for embedded objects as well - this is a work-around to the fact that ConnId requires `icfs:name` to be present on all objects. So the comparison code ignores the presence of `icfs:name` as well.

See Also:

• ShadowUtil.simpleAttributesEqualRelaxed(Collection, Collection)
• ShadowReferenceAttributeValue.semanticEqualsChecker()

matches

public boolean matches(ShadowAssociationValue other)

getActivation

public ActivationType getActivation()

getAssociationDataObject

@NotNull
public @NotNull AbstractShadow getAssociationDataObject()

Returns the associated object as an AbstractShadow. Fails if there's none.

hasAssociationObject

public boolean hasAssociationObject()

isInboundMembershipSynchronizationDisabled

public boolean isInboundMembershipSynchronizationDisabled()

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class com.evolveum.midpoint.prism.impl.PrismContainerValueImpl<ShadowAssociationValueType>