com.continuent.tungsten.replicator.plugin
Interface ReplicatorPlugin

All Known Subinterfaces:

Applier, Extractor, Filter, FilterManualProperties, ParallelApplier, ParallelExtractor, ParallelStore, PipelineService, RawApplier, RawExtractor, ScriptExecutor, Store

All Known Implementing Classes:

ApplierWrapper, BidiRemoteSlaveFilter, BuildAuditTable, BuildIndexTable, CaseMappingFilter, CDCMetadataFilter, ChannelAssignmentService, ColumnNameFilter, Connector, ConnectorHandler, ConsistencyCheckFilter, CSVLoader, DatabaseTransformFilter, DrizzleApplier, DummyApplier, DummyExtractor, DummyFilter, EnumToStringFilter, EventMetadataFilter, ExtractorWrapper, HeartbeatFilter, InfiniDBBatchApplier, InMemoryMultiQueue, InMemoryMultiQueueApplier, InMemoryQueueAdapter, InMemoryQueueStore, InMemoryTransactionalQueue, InMemoryTransactionalQueueApplier, JavascriptExecutor, JavaScriptFilter, JdbcApplier, JdbcLoader, JdbcPrefetcher, Loader, LoggingFilter, MongoApplier, MySQLApplier, MySQLDrizzleApplier, MySQLExtractor, MySQLLoader, MySQLSessionSupportFilter, NativeScriptExecutor, OptimizeUpdatesFilter, OracleApplier, OracleCDCExtractor, OracleCDCReaderExtractor, OracleExtractor, ParallelQueueApplier, ParallelQueueExtractor, ParallelQueueStore, Pipeline, PostgreSQLApplier, PostgreSQLSlonyExtractor, PrefetchApplier, PrefetchStore, PrefetchStore, PrimaryKeyFilter, PrintEventFilter, RemoteTHLExtractor, RenameFilter, ReplicateColumnsFilter, ReplicateFilter, SetToStringFilter, ShardFilter, ShardFilter, SimpleBatchApplier, Stage, StageTaskGroup, THL, THLParallelQueue, THLParallelQueueApplier, THLParallelQueueExtractor, THLStoreApplier, THLStoreExtractor, TimeDelayFilter, TungstenTableCDCTransformFilter, VerticaStreamBatchApplier

public interface ReplicatorPlugin

This class defines a ReplicatorPlugin. Replicator plug-ins have the following life cycle:

1. Instantiate plug-in from class name
2. Call setters on plug-in instance and load property names
3. Call configure() to signal configuration is complete
4. Call prepare() to create resources for operation
5. (Type-specific plug-in method calls)
6. Call release() to free resources

Version:

1.0

Author:

Teemu Ollakka

Method Summary

void	configure(PluginContext context) Complete plug-in configuration.
void	prepare(PluginContext context) Prepare plug-in for use.
void	release(PluginContext context) Release all resources used by plug-in.

Method Detail

configure

void configure(PluginContext context)
               throws ReplicatorException,
                      java.lang.InterruptedException

Complete plug-in configuration. This is called after setters are invoked at the time that the replicator goes through configuration.

Throws:

ReplicatorException - Thrown if configuration is incomplete or fails

java.lang.InterruptedException

prepare

void prepare(PluginContext context)
             throws ReplicatorException,
                    java.lang.InterruptedException

Prepare plug-in for use. This method is assumed to allocate all required resources. It is called before the plug-in performs any operations.

Throws:

ReplicatorException - Thrown if resource allocation fails

java.lang.InterruptedException

release

void release(PluginContext context)
             throws ReplicatorException,
                    java.lang.InterruptedException

Release all resources used by plug-in. This is called before the plug-in is deallocated.

Throws:

ReplicatorException - Thrown if resource deallocation fails

java.lang.InterruptedException