Package com.evolveum.midpoint.model.common.mapping

Class AbstractMappingImpl<V extends PrismValue,D extends ItemDefinition<?>,MBT extends AbstractMappingType>

java.lang.Object

com.evolveum.midpoint.model.common.mapping.AbstractMappingImpl<V,D,MBT>

Type Parameters:

V - type of mapping output value

D - type of mapping output value definition (property, container, ...)

MBT - mapping bean type: MappingType or MetadataMappingType

All Implemented Interfaces:

Mapping<V,D>, PrismValueDeltaSetTripleProducer<V,D>, DebugDumpable, HumanReadableDescribable, Serializable

Direct Known Subclasses:

MappingImpl, MetadataMappingImpl

public abstract class AbstractMappingImpl<V extends PrismValue,D extends ItemDefinition<?>,MBT extends AbstractMappingType>
extends Object
implements Mapping<V,D>, DebugDumpable, PrismValueDeltaSetTripleProducer<V,D>

Evaluation of a mapping. It is non-recyclable single-use object. Once evaluated it should not be evaluated again. It will retain its original inputs and outputs that can be read again and again. But these should not be changed after evaluation. TODO document evaluation of time constraints ... Configuration properties are unmodifiable. They are to be set via Mapping.Builder. Serializability: The mapping is technically serializable. However, it is NOT expected to be evaluable after deserialization. Only already computed results are to be fetched from such mapping object.

Author:

Radovan Semancik

See Also:

• Serialized Form

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMappingImpl(AbstractMappingBuilder<V,D,MBT,?> builder)
protected	AbstractMappingImpl(AbstractMappingImpl<V,D,MBT> prototype)

Method Summary

Modifier and Type	Method	Description
abstract AbstractMappingImpl<V,D,MBT>	clone()	Shallow clone.
protected abstract TransformationValueMetadataComputer	createValueMetadataComputer(OperationResult result)
String	debugDump(int indent)
protected abstract boolean	determinePushChangesRequested()
boolean	equals(Object obj)
void	evaluate(Task task, OperationResult parentResult)	Evaluate the mapping.
void	evaluateTimeValidity(Task task, OperationResult parentResult)	Evaluate the time validity.
@NotNull ModelCommonBeans	getBeans()
PrismValueDeltaSetTriple<PrismPropertyValue<Boolean>>	getConditionOutputTriple()
String	getContextDescription()
Source<?,?>	getDefaultSource()
Long	getEtime()	Returns elapsed time in milliseconds.
@NotNull ExpressionProfile	getExpressionProfile()	Should be called on prepared mapping.
String	getIdentifier()	Identifier of this producer; e.g. mapping name.
QName	getItemName()
MBT	getMappingBean()
String	getMappingContextDescription()
@NotNull MappingSpecificationType	getMappingSpecification()
XMLGregorianCalendar	getNextRecomputeTime()
XMLGregorianCalendar	getNow()
ObjectResolver	getObjectResolver()
ObjectType	getOriginObject()
Item<V,D>	getOutput()
D	getOutputDefinition()
ItemPath	getOutputPath()
PrismValueDeltaSetTriple<V>	getOutputTriple()	Null output triple means "the mapping is not applicable", e.g. due to the condition being false.
List<QName>	getSourceNames()
<T extends Serializable> T	getStateProperty(String propertyName)
@NotNull MappingStrengthType	getStrength()
static MappingStrengthType	getStrength(AbstractMappingType mappingBean)
D	getTargetItemDefinition()	Returns the definition for the target item.
QName	getTargetItemName()
@NotNull Task	getTask()	Available only during mapping evaluation.
int	hashCode()
boolean	hasTargetRange()
boolean	isActivated()
static boolean	isApplicableToChannel(AbstractMappingType mappingBean, String channelUri)
boolean	isAuthoritative()
boolean	isConditionSatisfied()	Returns true if the condition is at least partially satisfied, i.e. it is not "false -> false".
boolean	isEnabled()
boolean	isExclusive()
boolean	isProfiling()
boolean	isPushChanges()
boolean	isSourceless()	Returns true if the mapping has no source.
boolean	isTimeConstraintValid()
void	prepare(OperationResult parentResult)	Prepare mapping for evaluation.
<T extends Serializable> T	setStateProperty(String propertyName, T value)
String	toHumanReadableDescription()
String	toString()

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.model.common.mapping.PrismValueDeltaSetTripleProducer

isNormal, isStrong, isWeak

Constructor Details

AbstractMappingImpl

protected AbstractMappingImpl(AbstractMappingBuilder<V,D,MBT,?> builder)

AbstractMappingImpl

protected AbstractMappingImpl(AbstractMappingImpl<V,D,MBT> prototype)

Method Details

getObjectResolver

public ObjectResolver getObjectResolver()

getItemName

public QName getItemName()

getOriginObject

public ObjectType getOriginObject()

getDefaultSource

public Source<?,?> getDefaultSource()

getContextDescription

public String getContextDescription()

getMappingContextDescription

public String getMappingContextDescription()

getMappingBean

@NotNull
public MBT getMappingBean()

getExpressionProfile

@NotNull
public @NotNull ExpressionProfile getExpressionProfile()

Should be called on prepared mapping.

isSourceless

public boolean isSourceless()

Description copied from interface: PrismValueDeltaSetTripleProducer

Returns true if the mapping has no source. That means it has to be evaluated for any delta. This really applies only to normal-strength mappings.

Specified by:

isSourceless in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

getStrength

@NotNull
public @NotNull MappingStrengthType getStrength()

Specified by:

getStrength in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

getStrength

public static MappingStrengthType getStrength(AbstractMappingType mappingBean)

isAuthoritative

public boolean isAuthoritative()

Specified by:

isAuthoritative in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

isExclusive

public boolean isExclusive()

Specified by:

isExclusive in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

hasTargetRange

public boolean hasTargetRange()

isApplicableToChannel

public static boolean isApplicableToChannel(AbstractMappingType mappingBean,
 String channelUri)

getNow

public XMLGregorianCalendar getNow()

getNextRecomputeTime

public XMLGregorianCalendar getNextRecomputeTime()

isTimeConstraintValid

public boolean isTimeConstraintValid()

isProfiling

public boolean isProfiling()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

getEtime

public Long getEtime()

Description copied from interface: Mapping

Returns elapsed time in milliseconds.

Specified by:

getEtime in interface Mapping<V extends PrismValue,D extends ItemDefinition<?>>

getTargetItemName

public QName getTargetItemName()

Specified by:

getTargetItemName in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

getStateProperty

public <T extends Serializable> T getStateProperty(String propertyName)

Specified by:

getStateProperty in interface Mapping<V extends PrismValue,D extends ItemDefinition<?>>

setStateProperty

public <T extends Serializable> T setStateProperty(String propertyName,
 T value)

Specified by:

setStateProperty in interface Mapping<V extends PrismValue,D extends ItemDefinition<?>>

evaluate

public void evaluate(Task task,
 OperationResult parentResult)
              throws ExpressionEvaluationException,
ObjectNotFoundException,
SchemaException,
SecurityViolationException,
ConfigurationException,
CommunicationException

Evaluate the mapping. Can be called in UNINITIALIZED or PREPARED states only.

Throws:

ExpressionEvaluationException

ObjectNotFoundException

SchemaException

SecurityViolationException

ConfigurationException

CommunicationException

evaluateTimeValidity

public void evaluateTimeValidity(Task task,
 OperationResult parentResult)
                          throws ExpressionEvaluationException,
ObjectNotFoundException,
SchemaException,
SecurityViolationException,
ConfigurationException,
CommunicationException

Evaluate the time validity. Can be called in UNINITIALIZED or PREPARED states only.

Throws:

ExpressionEvaluationException

ObjectNotFoundException

SchemaException

SecurityViolationException

ConfigurationException

CommunicationException

prepare

public void prepare(OperationResult parentResult)
             throws SchemaException,
ObjectNotFoundException,
ExpressionEvaluationException,
SecurityViolationException,
ConfigurationException,
CommunicationException

Prepare mapping for evaluation. Parse the values. After this call it can be checked if a mapping is activated (i.e. if the input changes will "trigger" the mapping).

Throws:

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

SecurityViolationException

ConfigurationException

CommunicationException

isActivated

public boolean isActivated()

isConditionSatisfied

public boolean isConditionSatisfied()

Description copied from interface: Mapping

Returns true if the condition is at least partially satisfied, i.e. it is not "false -> false". Precondition: the condition is evaluated. Otherwise a NullPointerException is thrown.

Specified by:

isConditionSatisfied in interface Mapping<V extends PrismValue,D extends ItemDefinition<?>>

getConditionOutputTriple

public PrismValueDeltaSetTriple<PrismPropertyValue<Boolean>> getConditionOutputTriple()

getOutputDefinition

public D getOutputDefinition()

getOutputPath

public ItemPath getOutputPath()

Specified by:

getOutputPath in interface Mapping<V extends PrismValue,D extends ItemDefinition<?>>

createValueMetadataComputer

protected abstract TransformationValueMetadataComputer createValueMetadataComputer(OperationResult result)
                                                                            throws CommunicationException,
ObjectNotFoundException,
SchemaException,
SecurityViolationException,
ConfigurationException,
ExpressionEvaluationException

Throws:

CommunicationException

ObjectNotFoundException

SchemaException

SecurityViolationException

ConfigurationException

ExpressionEvaluationException

determinePushChangesRequested

protected abstract boolean determinePushChangesRequested()

getOutputTriple

public PrismValueDeltaSetTriple<V> getOutputTriple()

Description copied from interface: PrismValueDeltaSetTripleProducer

Null output triple means "the mapping is not applicable", e.g. due to the condition being false. Empty output triple means "the mapping is applicable but there are no values".

Specified by:

getOutputTriple in interface Mapping<V extends PrismValue,D extends ItemDefinition<?>>

Specified by:

getOutputTriple in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

getOutput

public Item<V,D> getOutput()
                    throws SchemaException

Throws:

SchemaException

clone

public abstract AbstractMappingImpl<V,D,MBT> clone()

Shallow clone. Only the output is cloned deeply.

Specified by:

clone in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

Overrides:

clone in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

toString

public String toString()

Overrides:

toString in class Object

getIdentifier

public String getIdentifier()

Description copied from interface: PrismValueDeltaSetTripleProducer

Identifier of this producer; e.g. mapping name.

Specified by:

getIdentifier in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

toHumanReadableDescription

public String toHumanReadableDescription()

Specified by:

toHumanReadableDescription in interface HumanReadableDescribable

getTask

@NotNull
public @NotNull Task getTask()

Available only during mapping evaluation.

getBeans

@NotNull
public @NotNull ModelCommonBeans getBeans()

getMappingSpecification

@NotNull
public @NotNull MappingSpecificationType getMappingSpecification()

getSourceNames

public List<QName> getSourceNames()

isPushChanges

@Experimental
public boolean isPushChanges()

Specified by:

isPushChanges in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>

getTargetItemDefinition

public D getTargetItemDefinition()

Description copied from interface: PrismValueDeltaSetTripleProducer

Returns the definition for the target item. It is usually present, but there may be border cases where it is not. Please research them if needed.

Specified by:

getTargetItemDefinition in interface PrismValueDeltaSetTripleProducer<V extends PrismValue,D extends ItemDefinition<?>>