Package com.evolveum.midpoint.task.api

Class StateReporter

java.lang.Object

com.evolveum.midpoint.task.api.StateReporter

public class StateReporter
extends Object

TODO better name (ProgressReporter ? StatisticsReporter ? ...) Used to report state, progress and performance statistics to upper layers. Generally a Task is the place where such information are reported and collected. However, because of a complex nature of some operations (namely, search) it tries to remember the state of an operation. TODO maybe this could be simplified in the future.

Author:

Pavol Mederly

Constructor Summary

Constructors

Constructor	Description
StateReporter(@NotNull LightweightIdentifierGenerator lightweightIdentifierGenerator)
StateReporter(@NotNull LightweightIdentifierGenerator lightweightIdentifierGenerator, String resourceOid, Task task)

Method Summary

Modifier and Type	Method	Description
boolean	canRun()
String	getResourceOid()
Task	getTask()
void	recordIcfOperationEnd(ConnIdOperation operation, Throwable ex)
void	recordIcfOperationResume(ConnIdOperation operation)
@NotNull ConnIdOperation	recordIcfOperationStart(@NotNull ProvisioningOperation operationKind, @Nullable ObjectClassComplexTypeDefinition objectClassDef, @Nullable String uid)
void	recordIcfOperationSuspend(@NotNull ConnIdOperation operation)
void	setResourceName(String resourceName)
void	setResourceOid(String resourceOid)
void	setTask(Task task)

Methods inherited from class java.lang.Object

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

Constructor Detail

StateReporter

public StateReporter(@NotNull
                     @NotNull LightweightIdentifierGenerator lightweightIdentifierGenerator)

StateReporter

public StateReporter(@NotNull
                     @NotNull LightweightIdentifierGenerator lightweightIdentifierGenerator,
                     String resourceOid,
                     Task task)

Method Detail

setResourceName

public void setResourceName(String resourceName)

recordIcfOperationStart

@NotNull
public @NotNull ConnIdOperation recordIcfOperationStart(@NotNull
                                                        @NotNull ProvisioningOperation operationKind,
                                                        @Nullable
                                                        @Nullable ObjectClassComplexTypeDefinition objectClassDef,
                                                        @Nullable
                                                        @Nullable String uid)

recordIcfOperationSuspend

public void recordIcfOperationSuspend(@NotNull
                                      @NotNull ConnIdOperation operation)

recordIcfOperationResume

public void recordIcfOperationResume(ConnIdOperation operation)

recordIcfOperationEnd

public void recordIcfOperationEnd(ConnIdOperation operation,
                                  Throwable ex)

setTask

public void setTask(Task task)

getTask

public Task getTask()

getResourceOid

public String getResourceOid()

setResourceOid

public void setResourceOid(String resourceOid)

canRun

public boolean canRun()