Package com.evolveum.midpoint.repo.common.activity.run.processing

Class ContainerableProcessingRequest<C extends Containerable>

java.lang.Object

com.evolveum.midpoint.repo.common.activity.run.processing.ItemProcessingRequest<C>

com.evolveum.midpoint.repo.common.activity.run.processing.ContainerableProcessingRequest<C>

All Implemented Interfaces:

AcknowledgementSink

Direct Known Subclasses:

ObjectProcessingRequest

@Experimental
public class ContainerableProcessingRequest<C extends Containerable>
extends ItemProcessingRequest<C>

Request to process a containerable.

Field Summary

Fields inherited from class com.evolveum.midpoint.repo.common.activity.run.processing.ItemProcessingRequest

identifier, item

Method Summary

Modifier and Type	Method	Description
void	acknowledge(boolean release, OperationResult result)	Informs the receiver that a particular item was processed (successfully or not).
static <C extends Containerable> @NotNull ContainerableProcessingRequest<C>	create(int sequentialNumber, C item, @NotNull IterativeActivityRun<C,?,?,?> activityRun)	Factory method: returns either ContainerableProcessingRequest or ObjectProcessingRequest (if the item is of ObjectType type).
@Nullable String	getItemOid()	OID of the object connected to the item being processed (usually the object itself or related shadow).
@NotNull IterationItemInformation	getIterationItemInformation()	This can be overridden in cases when we know how to derive a name or display name for the containerable.
String	getObjectOidToRecordRetryTrigger()
OperationExecutionRecorderForTasks.Target	getOperationExecutionRecordingTarget()
@Nullable SynchronizationSituationType	getSynchronizationSituationOnProcessingStart()	TODO reconsider
String	toString()

Methods inherited from class com.evolveum.midpoint.repo.common.activity.run.processing.ItemProcessingRequest

createRecordingTargetForObject, getIdentifier, getItem, getRootTaskOid, getSequentialNumber, getType, getType, process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

@NotNull
public static <C extends Containerable> @NotNull ContainerableProcessingRequest<C> create(int sequentialNumber,
                                                                                          @NotNull
                                                                                          C item,
                                                                                          @NotNull
                                                                                          @NotNull IterativeActivityRun<C,?,?,?> activityRun)

Factory method: returns either ContainerableProcessingRequest or ObjectProcessingRequest (if the item is of ObjectType type).

getIterationItemInformation

@NotNull
public @NotNull IterationItemInformation getIterationItemInformation()

This can be overridden in cases when we know how to derive a name or display name for the containerable.

Specified by:

getIterationItemInformation in class ItemProcessingRequest<C extends Containerable>

getOperationExecutionRecordingTarget

public OperationExecutionRecorderForTasks.Target getOperationExecutionRecordingTarget()

Specified by:

getOperationExecutionRecordingTarget in class ItemProcessingRequest<C extends Containerable>

Returns:

Object to which we will write an operation execution record (plus auxiliary information).

getObjectOidToRecordRetryTrigger

public String getObjectOidToRecordRetryTrigger()

Specified by:

getObjectOidToRecordRetryTrigger in class ItemProcessingRequest<C extends Containerable>

Returns:

OID of object to which we put a trigger causing operation retry (if known)

acknowledge

public void acknowledge(boolean release,
                        OperationResult result)

Description copied from interface: AcknowledgementSink

Informs the receiver that a particular item was processed (successfully or not).

Parameters:

release - If true, the item can be forgotten. If false, we want to receive that item again, presumably to be reprocessed later.

result - Operation result in context of which the acknowledgement should take place. It is useful if the acknowledgement itself can take considerable time, e.g. when it involves a communication with an external party.

getItemOid

@Nullable
public @Nullable String getItemOid()

Description copied from class: ItemProcessingRequest

OID of the object connected to the item being processed (usually the object itself or related shadow). TODO reconsider

Specified by:

getItemOid in class ItemProcessingRequest<C extends Containerable>

getSynchronizationSituationOnProcessingStart

@Nullable
public @Nullable SynchronizationSituationType getSynchronizationSituationOnProcessingStart()

Description copied from class: ItemProcessingRequest

TODO reconsider

Specified by:

getSynchronizationSituationOnProcessingStart in class ItemProcessingRequest<C extends Containerable>

toString

public String toString()

Overrides:

toString in class ItemProcessingRequest<C extends Containerable>