Package com.evolveum.midpoint.prism.impl

Class PrismObjectImpl<O extends Objectable>

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.ItemImpl<PrismContainerValue<C>,PrismContainerDefinition<C>>

com.evolveum.midpoint.prism.impl.PrismContainerImpl<O>

com.evolveum.midpoint.prism.impl.PrismObjectImpl<O>

All Implemented Interfaces:

Freezable, Item<PrismContainerValue<O>,PrismContainerDefinition<O>>, Itemable, ItemDefinitionTransformer.TransformableItem, ParentVisitable, PathVisitable, PrismContainer<O>, PrismContainerable<O>, PrismObject<O>, PrismVisitable, Revivable, Visitable, DebugDumpable, Serializable, Cloneable

public class PrismObjectImpl<O extends Objectable>
extends PrismContainerImpl<O>
implements PrismObject<O>

Common supertype for all identity objects. Defines basic properties that each object must have to live in our system (identifier, name). Objects consists of identifier and name (see definition below) and a set of properties represented as XML elements in the object's body. The attributes are represented as first-level XML elements (tags) of the object XML representation and may be also contained in other tags (e.g. extension, attributes). The QName (namespace and local name) of the element holding the property is considered to be a property name. This class is named PrismObject instead of Object to avoid confusion with java.lang.Object.

Author:

Radovan Semancik Class invariant: has at most one value (potentially empty). When making this object immutable and there's no value, we create one; in order to prevent exceptions on later getValue calls.

See Also:

• Serialized Form

Field Summary

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

compileTimeClass

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

definition, elementName, incomplete, parent, values

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

INDENT_STRING

Fields inherited from interface com.evolveum.midpoint.prism.Item

KEY_NAMESPACE_CONTEXT

Constructor Summary

Constructors

Constructor	Description
PrismObjectImpl(QName name, @NotNull Class<O> compileTimeClass, @NotNull PrismObjectValue<O> value)
PrismObjectImpl(QName name, PrismObjectDefinition<O> definition)
PrismObjectImpl(QName name, Class<O> compileTimeClass)

Method Summary

Modifier and Type	Method	Description
<I extends Item<?, ?>> void	addExtensionItem(I item)
protected ItemModifyResult<PrismContainerValue<O>>	addInternal(@NotNull PrismContainerValue newValue, boolean checkEquivalents, EquivalenceStrategy strategy)
void	addReplaceExisting(Item<?,?> item)
protected void	appendDebugDumpSuffix(StringBuilder sb)
O	asObjectable()
static <T extends Objectable> @NotNull List<T>	asObjectableList(@NotNull List<PrismObjectImpl<T>> objects)
void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
protected void	checkDefinition(@NotNull PrismContainerDefinition<O> def)	This is a separate method, as it is used at various places, e.g.
PrismObject<O>	clone()	Literal clone.
PrismObjectImpl<O>	cloneComplex(CloneStrategy strategy)	Complex clone with different cloning strategies.
PrismObject<O>	cloneIfImmutable()
protected void	copyValues(CloneStrategy strategy, PrismObjectImpl<O> clone)
ObjectDelta<O>	createAddDelta()
ObjectDelta<O>	createDeleteDelta()
ObjectDelta<O>	createDelta(ChangeType changeType)
PrismContainer<?>	createExtension()
PrismObject<O>	createImmutableClone()
ObjectDelta<O>	createModifyDelta()
PrismObjectValue<O>	createNewValue()
PrismObjectDefinition<O>	deepCloneDefinition(@NotNull DeepCloneOperation operation)
@NotNull ObjectDelta<O>	diff(PrismObject<O> other)
@NotNull ObjectDelta<O>	diff(PrismObject<O> other, ParameterizedEquivalenceStrategy strategy)
<I extends Item<?, ?>> I	findExtensionItem(@NotNull QName elementName)
<I extends Item<?, ?>> I	findExtensionItem(String elementLocalName)
String	getBusinessDisplayName()	Return display name intended for business users of midPoint
protected String	getDebugDumpClassName()	Return a human readable name of this class suitable for logs.
PrismObjectDefinition<O>	getDefinition()	Returns applicable property container definition.
PrismContainer<?>	getExtension()
PrismContainerValue<?>	getExtensionContainerValue()
PolyString	getName()
String	getOid()	Returns Object ID (OID).
PrismContainer<?>	getOrCreateExtension()
PrismContainerValue<?>	getParent()	Returns the parent of this item (if exists).
@NotNull ItemPath	getPath()	Returns the path of this item (sequence of names from the "root" container or similar object to this item).
protected Object	getPathComponent()
@NotNull PrismObjectValue<O>	getValue()	Returns the value, if there is only one.
String	getVersion()
Collection<? extends ItemDelta<?,?>>	narrowModifications(Collection<? extends ItemDelta<?,?>> modifications, @NotNull ParameterizedEquivalenceStrategy plusStrategy, @NotNull ParameterizedEquivalenceStrategy minusStrategy, boolean assumeMissingItems)	See description of ItemDelta.narrow(PrismObject, Comparator, Comparator, boolean) method.
void	performFreeze()
<IV extends PrismValue, ID extends ItemDefinition<?>, I extends Item<IV, ID>> void	removeItem(ItemPath path, Class<I> itemType)
void	setOid(String oid)
void	setParent(PrismContainerValue<?> parentValue)	Sets the parent of this item.
void	setValue(@NotNull PrismContainerValue<O> value)
void	setVersion(String version)
String	toDebugName()	Returns short string representing identity of this object.
String	toDebugType()	Returns short string identification of object type.
String	toString()

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

accept, add, addInternalExecution, applyDefinition, assertDefinitions, canRepresent, canRepresent, containsItem, copyValues, createDelta, createDelta, createNewValueInternal, createParentIfNeeded, debugDump, diff, diff, diffModifications, equivalent, find, findContainer, findContainer, findCreateItem, findCreateItem, findItem, findItem, findItem, findOrCreateContainer, findOrCreateItem, findOrCreateItem, findOrCreateProperty, findOrCreateReference, findPartial, findProperty, findReference, findValue, getAllItems, getAllValues, getCompileTimeClass, getPropertyRealValue, getRealValue, getRealValues, getValue, hasCompleteDefinition, isEmpty, mergeValue, mergeValues, mergeValues, propagateDeepCloneDefinition, remove, removeContainer, removeProperty, removeReference, setContainerRealValue, setDefinition, setDefinitionHack, setPropertyRealValue, setPropertyRealValues, setRealValue, startStrictModifications, stopStrictModifications, trim, trimDefinitionTree, useIdentifierIndex

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

accept, acceptParentVisitor, add, addAll, addForced, addIgnoringEquivalents, addRespectingMetadataAndCloning, addWithResult, applyDefinitionToValues, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, clear, copyValues, diff, equals, equals, equals, fixupDelta, getElementName, getHighestId, getRealValue, getRealValuesArray, getUserData, getUserData, getValues, hashCode, hashCode, hashCode, isIncomplete, merge, normalize, recomputeAllValues, remove, remove, removeAll, removeRespectingMetadata, removeWithResult, replace, replaceAll, revive, setElementName, setIncomplete, setUserData, transformDefinition, valueRemoved

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, debugDump, debugDumpLazily, debugDumpLazily

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

checkImmutable, checkMutable, freeze, isImmutable

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

acceptParentVisitor, acceptVisitor, add, add, addAll, addAll, addIgnoringEquivalents, addRespectingMetadataAndCloning, applyDefinition, applyDefinition, applyDefinitionIfMissing, assertDefinitions, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, clear, contains, contains, copy, diff, diff, equals, equals, equals, filterValues, filterYields, find, findValue, findValue, getAllItems, getAllValues, getAnyValue, getAnyValue, getClonedValues, getDisplayName, getElementName, getHelp, getHighestId, getNamespaceContext, getRealValue, getRealValues, getRealValuesArray, getRealValuesOrRawTypes, getUserData, getUserData, hasAnyValue, hasCompleteDefinition, hashCode, hashCode, hashCode, hasNoValues, hasRaw, isEmpty, isIncomplete, isOperational, isRaw, isSingleValue, isSingleValueByDefinition, merge, normalize, recomputeAllValues, remove, remove, removeAll, removeIf, removeRespectingMetadata, replace, replaceAll, setDefinition, setElementName, setIncomplete, setUserData, size, valuesStream

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

accept, add, canRepresent, canRepresent, containsItem, createDelta, createDelta, diff, diff, diffModifications, findContainer, findCreateItem, findCreateItem, findItem, findItem, findItem, findOrCreateContainer, findOrCreateItem, findOrCreateItem, findOrCreateProperty, findOrCreateReference, findPartial, findProperty, findReference, findValue, getCompileTimeClass, getPropertyRealValue, getRealValue, getRealValues, getValue, getValues, mergeValue, mergeValues, mergeValues, remove, removeContainer, removeProperty, removeReference, setContainerRealValue, setPropertyRealValue, setPropertyRealValues, setRealValue, trim, trimDefinitionTree

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

getComplexTypeDefinition

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

equivalent, isOfType

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

revive

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

accept

Constructor Details

PrismObjectImpl

public PrismObjectImpl(QName name,
 Class<O> compileTimeClass)

PrismObjectImpl

public PrismObjectImpl(QName name,
 PrismObjectDefinition<O> definition)

PrismObjectImpl

public PrismObjectImpl(QName name,
 @NotNull
 @NotNull Class<O> compileTimeClass,
 @NotNull
 @NotNull PrismObjectValue<O> value)

Method Details

createNewValue

public PrismObjectValue<O> createNewValue()

Specified by:

createNewValue in interface PrismContainer<O extends Objectable>

Specified by:

createNewValue in interface PrismObject<O extends Objectable>

Overrides:

createNewValue in class PrismContainerImpl<O extends Objectable>

getValue

@NotNull
public @NotNull PrismObjectValue<O> getValue()

Description copied from interface: Item

Returns the value, if there is only one. Throws exception if there are more values. If there is no value, this method either: - returns null (for properties) - throws an exception (for items that can hold multiple values) - creates an empty value (for containers and references). TODO think again whether getOrCreateValue would not be better

Specified by:

getValue in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getValue in interface PrismContainer<O extends Objectable>

Specified by:

getValue in interface PrismObject<O extends Objectable>

Overrides:

getValue in class PrismContainerImpl<O extends Objectable>

setValue

public void setValue(@NotNull
 @NotNull PrismContainerValue<O> value)
              throws SchemaException

Specified by:

setValue in interface PrismContainer<O extends Objectable>

Specified by:

setValue in interface PrismObject<O extends Objectable>

Overrides:

setValue in class PrismContainerImpl<O extends Objectable>

Throws:

SchemaException

addInternal

protected ItemModifyResult<PrismContainerValue<O>> addInternal(@NotNull
 @NotNull PrismContainerValue newValue,
 boolean checkEquivalents,
 EquivalenceStrategy strategy)
                                                        throws SchemaException

Overrides:

addInternal in class PrismContainerImpl<O extends Objectable>

Throws:

SchemaException

getOid

public String getOid()

Returns Object ID (OID). May return null if the object does not have an OID.

Specified by:

getOid in interface PrismObject<O extends Objectable>

Returns:

Object ID (OID)

setOid

public void setOid(String oid)

Specified by:

setOid in interface PrismObject<O extends Objectable>

getVersion

public String getVersion()

Specified by:

getVersion in interface PrismObject<O extends Objectable>

setVersion

public void setVersion(String version)

Specified by:

setVersion in interface PrismObject<O extends Objectable>

getDefinition

public PrismObjectDefinition<O> getDefinition()

Description copied from class: PrismContainerImpl

Returns applicable property container definition.

May return null if no definition is applicable or the definition is not know.

Specified by:

getDefinition in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getDefinition in interface Itemable

Specified by:

getDefinition in interface PrismContainer<O extends Objectable>

Specified by:

getDefinition in interface PrismContainerable<O extends Objectable>

Specified by:

getDefinition in interface PrismObject<O extends Objectable>

Overrides:

getDefinition in class PrismContainerImpl<O extends Objectable>

Returns:

applicable property container definition

asObjectable

@NotNull
public O asObjectable()

Specified by:

asObjectable in interface PrismObject<O extends Objectable>

getName

public PolyString getName()

Specified by:

getName in interface PrismObject<O extends Objectable>

getExtension

public PrismContainer<?> getExtension()

Specified by:

getExtension in interface PrismObject<O extends Objectable>

getOrCreateExtension

public PrismContainer<?> getOrCreateExtension()
                                       throws SchemaException

Specified by:

getOrCreateExtension in interface PrismObject<O extends Objectable>

Throws:

SchemaException

getExtensionContainerValue

public PrismContainerValue<?> getExtensionContainerValue()

Specified by:

getExtensionContainerValue in interface PrismObject<O extends Objectable>

findExtensionItem

public <I extends Item<?,
?>> I findExtensionItem(String elementLocalName)

Specified by:

findExtensionItem in interface PrismObject<O extends Objectable>

findExtensionItem

public <I extends Item<?,
?>> I findExtensionItem(@NotNull
 @NotNull QName elementName)

Specified by:

findExtensionItem in interface PrismObject<O extends Objectable>

addExtensionItem

public <I extends Item<?,
?>> void addExtensionItem(I item)
                                            throws SchemaException

Specified by:

addExtensionItem in interface PrismObject<O extends Objectable>

Throws:

SchemaException

createExtension

public PrismContainer<?> createExtension()
                                  throws SchemaException

Specified by:

createExtension in interface PrismObject<O extends Objectable>

Throws:

SchemaException

checkDefinition

protected void checkDefinition(@NotNull
 @NotNull PrismContainerDefinition<O> def)

Description copied from class: ItemImpl

This is a separate method, as it is used at various places, e.g. - in ItemImpl.applyDefinition(ItemDefinition, boolean) - in ItemImpl.setDefinition(ItemDefinition) - when checking the consistence

Overrides:

checkDefinition in class ItemImpl<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

removeItem

public <IV extends PrismValue,
ID extends ItemDefinition<?>,
I extends Item<IV,
ID>>
void removeItem(ItemPath path,
 Class<I> itemType)

Specified by:

removeItem in interface PrismContainer<O extends Objectable>

Specified by:

removeItem in interface PrismObject<O extends Objectable>

Overrides:

removeItem in class PrismContainerImpl<O extends Objectable>

addReplaceExisting

public void addReplaceExisting(Item<?,?> item)
                        throws SchemaException

Specified by:

addReplaceExisting in interface PrismObject<O extends Objectable>

Throws:

SchemaException

clone

public PrismObject<O> clone()

Description copied from interface: Item

Literal clone.

Specified by:

clone in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

clone in interface PrismContainer<O extends Objectable>

Specified by:

clone in interface PrismObject<O extends Objectable>

Overrides:

clone in class PrismContainerImpl<O extends Objectable>

createImmutableClone

public PrismObject<O> createImmutableClone()

Specified by:

createImmutableClone in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

createImmutableClone in interface PrismContainer<O extends Objectable>

Specified by:

createImmutableClone in interface PrismObject<O extends Objectable>

Overrides:

createImmutableClone in class PrismContainerImpl<O extends Objectable>

cloneComplex

public PrismObjectImpl<O> cloneComplex(CloneStrategy strategy)

Description copied from interface: Item

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

cloneComplex in interface PrismContainer<O extends Objectable>

Specified by:

cloneComplex in interface PrismObject<O extends Objectable>

Overrides:

cloneComplex in class PrismContainerImpl<O extends Objectable>

See Also:

• CloneStrategy

copyValues

protected void copyValues(CloneStrategy strategy,
 PrismObjectImpl<O> clone)

deepCloneDefinition

public PrismObjectDefinition<O> deepCloneDefinition(@NotNull
 @NotNull DeepCloneOperation operation)

Specified by:

deepCloneDefinition in interface PrismContainer<O extends Objectable>

Specified by:

deepCloneDefinition in interface PrismObject<O extends Objectable>

Overrides:

deepCloneDefinition in class PrismContainerImpl<O extends Objectable>

diff

@NotNull
public @NotNull ObjectDelta<O> diff(PrismObject<O> other)

Specified by:

diff in interface PrismObject<O extends Objectable>

diff

@NotNull
public @NotNull ObjectDelta<O> diff(PrismObject<O> other,
 ParameterizedEquivalenceStrategy strategy)

Specified by:

diff in interface PrismObject<O extends Objectable>

narrowModifications

public Collection<? extends ItemDelta<?,?>> narrowModifications(Collection<? extends ItemDelta<?,?>> modifications,
 @NotNull
 @NotNull ParameterizedEquivalenceStrategy plusStrategy,
 @NotNull
 @NotNull ParameterizedEquivalenceStrategy minusStrategy,
 boolean assumeMissingItems)

Description copied from interface: PrismObject

See description of ItemDelta.narrow(PrismObject, Comparator, Comparator, boolean) method.

Specified by:

narrowModifications in interface PrismObject<O extends Objectable>

createDelta

public ObjectDelta<O> createDelta(ChangeType changeType)

Specified by:

createDelta in interface PrismObject<O extends Objectable>

createAddDelta

public ObjectDelta<O> createAddDelta()

Specified by:

createAddDelta in interface PrismObject<O extends Objectable>

createModifyDelta

public ObjectDelta<O> createModifyDelta()

Specified by:

createModifyDelta in interface PrismObject<O extends Objectable>

createDeleteDelta

public ObjectDelta<O> createDeleteDelta()

Specified by:

createDeleteDelta in interface PrismObject<O extends Objectable>

setParent

public void setParent(PrismContainerValue<?> parentValue)

Description copied from interface: Item

Sets the parent of this item.

Specified by:

setParent in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

setParent in interface PrismObject<O extends Objectable>

Overrides:

setParent in class ItemImpl<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Parameters:

parentValue - The new parent

getParent

public PrismContainerValue<?> getParent()

Description copied from interface: Item

Returns the parent of this item (if exists). Currently this has to be a PrismContainerValue.

Specified by:

getParent in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getParent in interface PrismObject<O extends Objectable>

Overrides:

getParent in class ItemImpl<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Returns:

The parent if exists

getPath

@NotNull
public @NotNull ItemPath getPath()

Description copied from interface: Item

Returns the path of this item (sequence of names from the "root" container or similar object to this item). Note that if the containing object is a delta (usually a container delta), then the path

Specified by:

getPath in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getPath in interface Itemable

Overrides:

getPath in class ItemImpl<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Returns:

the path

getPathComponent

protected Object getPathComponent()

Overrides:

getPathComponent in class ItemImpl<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

toString

public String toString()

Overrides:

toString in class PrismContainerImpl<O extends Objectable>

toDebugName

public String toDebugName()

Returns short string representing identity of this object. It should container object type, OID and name. It should be presented in a form suitable for log and diagnostic messages (understandable for system administrator).

Specified by:

toDebugName in interface PrismObject<O extends Objectable>

toDebugType

public String toDebugType()

Returns short string identification of object type. It should be in a form suitable for log messages. There is no requirement for the type name to be unique, but it rather has to be compact. E.g. short element names are preferred to long QNames or URIs.

Specified by:

toDebugType in interface PrismObject<O extends Objectable>

getDebugDumpClassName

protected String getDebugDumpClassName()

Return a human readable name of this class suitable for logs.

Overrides:

getDebugDumpClassName in class PrismContainerImpl<O extends Objectable>

appendDebugDumpSuffix

protected void appendDebugDumpSuffix(StringBuilder sb)

Overrides:

appendDebugDumpSuffix in class ItemImpl<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

getBusinessDisplayName

public String getBusinessDisplayName()

Return display name intended for business users of midPoint

Specified by:

getBusinessDisplayName in interface PrismObject<O extends Objectable>

checkConsistenceInternal

public void checkConsistenceInternal(Itemable rootItem,
 boolean requireDefinitions,
 boolean prohibitRaw,
 ConsistencyCheckScope scope)

Specified by:

checkConsistenceInternal in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Overrides:

checkConsistenceInternal in class PrismContainerImpl<O extends Objectable>

performFreeze

public void performFreeze()

Overrides:

performFreeze in class ItemImpl<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

cloneIfImmutable

public PrismObject<O> cloneIfImmutable()

Specified by:

cloneIfImmutable in interface PrismObject<O extends Objectable>

asObjectableList

@NotNull
public static <T extends Objectable>
@NotNull List<T> asObjectableList(@NotNull
 @NotNull List<PrismObjectImpl<T>> objects)