ome.smuggler.core.service.imports.impl

Class Finaliser

java.lang.Object

ome.smuggler.core.service.imports.impl.Finaliser

All Implemented Interfaces:

RepeatConsumer<ProcessedImport>, ImportFinaliser

public class Finaliser
extends java.lang.Object
implements ImportFinaliser

Carries out completion procedures after the ImportRunner or the ImportFailureHandler have finished their work. These include notifying the user of the import outcome and cleaning up allocated resources, e.g. OMERO sessions, scheduling deletion of import logs, etc.

Constructor Summary

Constructors

Constructor and Description
Finaliser(ImportEnv env) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
RepeatAction	consume(ProcessedImport task) Processes messages from the GC queue to carry out each step in the batch finalisation procedure.
protected ImportFinaliser	handlerFor(ImportFinalisationPhase status)
void	onBatchCompletion(ProcessedImport task) Triggers the procedure to finalise the import batch after all import tasks within it have run.
void	onFailure(QueuedImport task) Triggers the completion of an import task when the OMERO import has failed.
void	onSuccess(QueuedImport task) Triggers the completion of an import task when the OMERO import has run successfully.

Methods inherited from class java.lang.Object

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

Constructor Detail

Finaliser

public Finaliser(ImportEnv env)

Creates a new instance.

Parameters:

env - the import environment.

Throws:

java.lang.NullPointerException - if the argument is null.

Method Detail

onSuccess

public void onSuccess(QueuedImport task)

Triggers the completion of an import task when the OMERO import has run successfully.

Parameters:

task - the import task.

Throws:

java.lang.NullPointerException - if the argument is null.

onFailure

public void onFailure(QueuedImport task)

Triggers the completion of an import task when the OMERO import has failed.

Parameters:

task - the import task.

Throws:

java.lang.NullPointerException - if the argument is null.

onBatchCompletion

public void onBatchCompletion(ProcessedImport task)

Triggers the procedure to finalise the import batch after all import tasks within it have run.

Parameters:

task - the last import task that was processed and completed the batch.

Throws:

java.lang.NullPointerException - if the argument is null.

consume

public RepeatAction consume(ProcessedImport task)

Processes messages from the GC queue to carry out each step in the batch finalisation procedure.

Specified by:

consume in interface RepeatConsumer<ProcessedImport>

Parameters:

task - which step to carry out.

Returns:

Repeat if the current step of the finalisation procedure failed because of a transient error condition and it should be retried or Stop if it should not be retried either because it succeeded or because it failed but it's not possible to recover.

handlerFor

protected ImportFinaliser handlerFor(ImportFinalisationPhase status)