Package com.evolveum.midpoint.schema.processor

Class ShadowReferenceAttributeValue

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.PrismValueImpl

com.evolveum.midpoint.prism.impl.PrismReferenceValueImpl

com.evolveum.midpoint.schema.processor.ShadowReferenceAttributeValue

All Implemented Interfaces:

Freezable, ItemDefinitionTransformer.TransformableValue, MidpointOriginMetadata, PathVisitable, PrismReferenceValue, PrismValue, PrismVisitable, Revivable, SchemaLookup.Aware, Visitable, DebugDumpable, ShortDumpable, Serializable

public class ShadowReferenceAttributeValue
extends com.evolveum.midpoint.prism.impl.PrismReferenceValueImpl

Represents a value of a 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. Any places where this is checked, will throw IllegalStateException instead of SchemaException. We will simply not allow creating a non-compliant reference attribute value. At least we'll try to do this. The exception are situations where the object exists between instantiation and providing the data.

See Also:

• Serialized Form

Field Summary

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
@NotNull ObjectReferenceType	asObjectReferenceType()
ShadowReferenceAttributeValue	clone()	Literal clone.
ShadowReferenceAttributeValue	cloneComplex(@NotNull CloneStrategy strategy)	Complex clone with different cloning strategies.
static ShadowReferenceAttributeValue	empty()
static @NotNull ShadowReferenceAttributeValue	fromReferencable(@NotNull Referencable referencable)
static @NotNull ShadowReferenceAttributeValue	fromRefValue(@NotNull PrismReferenceValue refVal)	Converts (potentially raw) PrismReferenceValue to wrapped ShadowReferenceAttributeValue.
static @NotNull ShadowReferenceAttributeValue	fromShadow(@NotNull AbstractShadow shadow)	Creates a new value from the full or ID-only shadow.
static @NotNull ShadowReferenceAttributeValue	fromShadowOid(@NotNull String oid)
@Nullable ResourceObjectDefinition	getAssociatedObjectDefinitionIfPresent()
ShadowAttributesContainer	getAttributesContainerIfPresent()
@NotNull ShadowAttributesContainer	getAttributesContainerRequired()
@NotNull ShadowReferenceAttributeDefinition	getDefinitionRequired()
@NotNull ResourceObjectIdentification<?>	getIdentification()
@NotNull String	getOidRequired()
@NotNull AbstractShadow	getShadow()
@NotNull ShadowType	getShadowBean()	Target object or its reference.
@Nullable AbstractShadow	getShadowIfPresent()
@NotNull AbstractShadow	getShadowRequired()
@NotNull PrismPropertyValue<?>	getSingleIdentifierValueRequired(@NotNull QName attrName, Object errorCtx)
QName	getTargetObjectClassName()
@NotNull ResourceObjectDefinition	getTargetObjectDefinition()
boolean	matches(ShadowReferenceAttributeValue other)
static @NotNull EqualsChecker<ShadowReferenceAttributeValue>	semanticEqualsChecker()	Returns an equals checker that compares two reference attribute values, i.e., two shadows that they point to.
void	setShadow(@NotNull AbstractShadow shadow)
void	shortDump(StringBuilder sb)	Show the content of the object intended for diagnostics.
String	toHumanReadableString()
String	toString()

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

accept, applyDefinition, applyDefinition, asReferencable, asReferencables, asReferenceValues, checkConsistenceInternal, containsOid, copyValues, createImmutableClone, debugDump, debugDump, debugDump, equals, equals, find, findPartial, findReferencedItem, getAllValues, getDefinition, getDescription, getFilter, getObject, getOid, getRealClass, getRealValue, getReferentialIntegrity, getRelation, getResolutionTime, getSchemaContext, getTargetName, getTargetType, getTargetTypeCompileTimeClass, hashCode, isEmpty, isRaw, recompute, relation, revive, setDescription, setFilter, setObject, setOid, setReferentialIntegrity, setRelation, setResolutionTime, setTargetName, setTargetName, setTargetType, setTargetType, toCanonical, transformDefinition

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

accept, appendOriginDump, clearParent, copyValues, diff, diffMatchingRepresentation, diffMatchingRepresentation, equals, equals, getAllItems, getOriginObject, getOriginType, getParent, getParentContainerValue, getPath, getPathComponent, getRootValue, getTypeName, getUserData, getUserData, getValueMetadata, getValueMetadataIfExists, hashCode, hashCode, hasValueMetadata, isTransient, normalize, performFreeze, recompute, representsSameValue, 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

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.PrismReferenceValue

acceptVisitor, determineTargetTypeName, getEffectiveResolutionTime, getObjectable

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

accept, applyDefinition, applyDefinitionLegacy, applyDefinitionLegacy, clearParent, cloneIfImmutable, deleteValueMetadata, diff, equals, getAllItems, getNearestValueOfType, getParent, getParentContainerValue, getPath, getRealValueIfExists, getRealValueOrRawType, getRootObjectable, getRootValue, getTypeName, getUserData, getUserData, getValueMetadata, getValueMetadataAsContainer, getValueMetadataIfExists, hashCode, hasRealClass, hasValueMetadata, isObjectable, isOfType, isTransient, normalize, recompute, representsSameValue, schemaLookup, setParent, setTransient, setUserData, setValueMetadata, setValueMetadata, setValueMetadata

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

shortDump, shortDumpLazily

Method Details

fromRefValue

@NotNull
public static @NotNull ShadowReferenceAttributeValue fromRefValue(@NotNull
 @NotNull PrismReferenceValue refVal)
                                                           throws SchemaException

Converts (potentially raw) PrismReferenceValue to wrapped ShadowReferenceAttributeValue. We should not use the original value any more, e.g. because of values being copied.

Throws:

SchemaException

fromReferencable

@NotNull
public static @NotNull ShadowReferenceAttributeValue fromReferencable(@NotNull
 @NotNull Referencable referencable)
                                                               throws SchemaException

Throws:

SchemaException

fromShadow

@NotNull
public static @NotNull ShadowReferenceAttributeValue fromShadow(@NotNull
 @NotNull AbstractShadow shadow)
                                                         throws SchemaException

Creates a new value from the full or ID-only shadow. No cloning here.

Throws:

SchemaException

fromShadowOid

@NotNull
public static @NotNull ShadowReferenceAttributeValue fromShadowOid(@NotNull
 @NotNull String oid)
                                                            throws SchemaException

Throws:

SchemaException

semanticEqualsChecker

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

Returns an equals checker that compares two reference attribute values, i.e., two shadows that they point to. - We use OIDs for comparison, if available. - If not, we compare shadows by their content - in a relaxed way, see ShadowUtil.equalsByContent(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType, com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType).

empty

public static ShadowReferenceAttributeValue empty()

clone

public ShadowReferenceAttributeValue clone()

Description copied from interface: PrismValue

Literal clone.

Specified by:

clone in interface PrismReferenceValue

Specified by:

clone in interface PrismValue

Overrides:

clone in class com.evolveum.midpoint.prism.impl.PrismReferenceValueImpl

cloneComplex

public ShadowReferenceAttributeValue cloneComplex(@NotNull
 @NotNull CloneStrategy strategy)

Description copied from interface: PrismValue

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface PrismReferenceValue

Specified by:

cloneComplex in interface PrismValue

Overrides:

cloneComplex in class com.evolveum.midpoint.prism.impl.PrismReferenceValueImpl

See Also:

• CloneStrategy

getAttributesContainerRequired

@NotNull
public @NotNull ShadowAttributesContainer getAttributesContainerRequired()

getShadowBean

@NotNull
public @NotNull ShadowType getShadowBean()

Target object or its reference. TODO better name.

getShadow

@NotNull
public @NotNull AbstractShadow getShadow()

getTargetObjectClassName

public QName getTargetObjectClassName()

getDefinitionRequired

@NotNull
public @NotNull ShadowReferenceAttributeDefinition getDefinitionRequired()

getIdentification

@NotNull
public @NotNull ResourceObjectIdentification<?> getIdentification()

asObjectReferenceType

@NotNull
public @NotNull ObjectReferenceType asObjectReferenceType()

getShadowIfPresent

@Nullable
public @Nullable AbstractShadow getShadowIfPresent()

getShadowRequired

@NotNull
public @NotNull AbstractShadow getShadowRequired()

getAssociatedObjectDefinitionIfPresent

@Nullable
public @Nullable ResourceObjectDefinition getAssociatedObjectDefinitionIfPresent()

getTargetObjectDefinition

@NotNull
public @NotNull ResourceObjectDefinition getTargetObjectDefinition()

getAttributesContainerIfPresent

public ShadowAttributesContainer getAttributesContainerIfPresent()

setShadow

public void setShadow(@NotNull
 @NotNull AbstractShadow shadow)

matches

public boolean matches(ShadowReferenceAttributeValue other)

getSingleIdentifierValueRequired

@NotNull
public @NotNull PrismPropertyValue<?> getSingleIdentifierValueRequired(@NotNull
 @NotNull QName attrName,
 Object errorCtx)
                                                                throws SchemaException

Throws:

SchemaException

getOidRequired

@NotNull
public @NotNull String getOidRequired()

toString

public String toString()

Overrides:

toString in class com.evolveum.midpoint.prism.impl.PrismReferenceValueImpl

shortDump

public 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

Overrides:

shortDump in class com.evolveum.midpoint.prism.impl.PrismReferenceValueImpl

Parameters:

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

toHumanReadableString

public String toHumanReadableString()

Specified by:

toHumanReadableString in interface PrismValue

Overrides:

toHumanReadableString in class com.evolveum.midpoint.prism.impl.PrismReferenceValueImpl