com.univocity.api.engine
Class EngineLifecycleInterceptor

java.lang.Object
  extended by com.univocity.api.engine.EngineLifecycleInterceptor

public abstract class EngineLifecycleInterceptor
extends Object

The EngineLifecycleInterceptor is used to obtain notifications about life cycle events of a DataIntegrationEngine. Use DataIntegrationEngine.addInterceptor(EngineLifecycleInterceptor) to obtain notifications of such events.

Author:
uniVocity Software Pty Ltd - dev@univocity.com
See Also:
DataIntegrationEngine, EngineLifecycleContext, EngineScope

Constructor Summary
EngineLifecycleInterceptor()
           
 
Method Summary
 void cycleCompleted(EngineLifecycleContext context)
          Notifies a data mapping cycle has completed in the DataIntegrationEngine: EngineScope.CYCLE is still active and will be destroyed after the interceptors have been executed.
 void cycleStarted(EngineLifecycleContext context)
          Notifies a new data mapping cycle has been started in the DataIntegrationEngine: EngineScope.CYCLE is active and a set of data mappings is ready to be executed.
 void engineReady(EngineLifecycleContext context)
          Notifies the DataIntegrationEngine is ready to execute a new data mapping cycle: EngineScope.PERSISTENT and EngineScope.APPLICATION scopes are active.
 void engineShuttingDown(EngineLifecycleContext context)
          Notifies the DataIntegrationEngine is being shut down.
 void engineStopped(EngineLifecycleContext context)
          Notifies the DataIntegrationEngine has been completely shut down.
 void mappingCompleted(EngineLifecycleContext context)
          Notifies a data mapping has been in the DataIntegrationEngine: EngineScope.MAPPING is still active and will be destroyed after the interceptors have been executed.
 void mappingStarted(EngineLifecycleContext context)
          Notifies a new data mapping has been started in the DataIntegrationEngine: EngineScope.MAPPING is active and a data mapping is ready to be executed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EngineLifecycleInterceptor

public EngineLifecycleInterceptor()
Method Detail

engineReady

public void engineReady(EngineLifecycleContext context)
Notifies the DataIntegrationEngine is ready to execute a new data mapping cycle: EngineScope.PERSISTENT and EngineScope.APPLICATION scopes are active. All data stores have been initialized and the engine is ready to map data.

Parameters:
context - the contextual information and controls available to the user while the DataIntegrationEngine is active.

Note: attempts to obtain inactive contextual information from the EngineLifecycleContext will produce an IllegalStateException


cycleStarted

public void cycleStarted(EngineLifecycleContext context)
Notifies a new data mapping cycle has been started in the DataIntegrationEngine: EngineScope.CYCLE is active and a set of data mappings is ready to be executed.

Parameters:
context - the contextual information and controls available to the user while the DataIntegrationEngine is active.

Note: attempts to obtain inactive contextual information from the EngineLifecycleContext will produce an IllegalStateException


mappingStarted

public void mappingStarted(EngineLifecycleContext context)
Notifies a new data mapping has been started in the DataIntegrationEngine: EngineScope.MAPPING is active and a data mapping is ready to be executed.

Parameters:
context - the contextual information and controls available to the user while the DataIntegrationEngine is active.

mappingCompleted

public void mappingCompleted(EngineLifecycleContext context)
Notifies a data mapping has been in the DataIntegrationEngine: EngineScope.MAPPING is still active and will be destroyed after the interceptors have been executed. This method will be called even in case of exceptions.

Parameters:
context - the contextual information and controls available to the user while the DataIntegrationEngine is active.

cycleCompleted

public void cycleCompleted(EngineLifecycleContext context)
Notifies a data mapping cycle has completed in the DataIntegrationEngine: EngineScope.CYCLE is still active and will be destroyed after the interceptors have been executed. This method will be called even in case of exceptions.

Parameters:
context - the contextual information and controls available to the user while the DataIntegrationEngine is active.

Note: attempts to obtain inactive contextual information from the EngineLifecycleContext will produce an IllegalStateException


engineShuttingDown

public void engineShuttingDown(EngineLifecycleContext context)
Notifies the DataIntegrationEngine is being shut down. EngineScope.APPLICATION and EngineScope.PERSISTENT are still active and will be destroyed after the interceptors have been executed. This method will be called even in case of exceptions.

Parameters:
context - the contextual information and controls available to the user while the DataIntegrationEngine is active.

Note: attempts to obtain inactive contextual information from the EngineLifecycleContext will produce an IllegalStateException


engineStopped

public void engineStopped(EngineLifecycleContext context)
Notifies the DataIntegrationEngine has been completely shut down. No EngineScope is active. After the interceptors have been executed, the remaining shutdown hooks will be executed and any resources allocated by DataIntegrationEngine will be freed. This method will be called even in case of exceptions.

Parameters:
context - the contextual information still available to the user before the DataIntegrationEngine takes its last breath.

Note: attempts to obtain inactive contextual information from the EngineLifecycleContext will produce an IllegalStateException



Copyright © 2015 uniVocity Software Pty Ltd. All rights reserved.