com.continuent.tungsten.replicator.filter
Class TimeDelayFilter

java.lang.Object
  com.continuent.tungsten.replicator.filter.TimeDelayFilter

All Implemented Interfaces:

Filter, ReplicatorPlugin

public class TimeDelayFilter
extends java.lang.Object
implements Filter

Filter to delay a transaction until a particular point in time has passed. The time delay filter uses the originating timestamp from the replication event to just time delays. We assume that clocks are synchronized to within some reasonable precision between event producers and consumers. Note: This filter may cause problems if used on a master. It should only be used as an applier filter.

Author:

Robert Hodges

Constructor Summary

TimeDelayFilter()

Method Summary

void	configure(PluginContext context) Complete plug-in configuration.
ReplDBMSEvent	filter(ReplDBMSEvent event) Implements a delay in processing the event.
void	prepare(PluginContext context) Prepare plug-in for use.
void	release(PluginContext context) Release all resources used by plug-in.
void	setDelay(long timeDelaySeconds) Sets the time delay in seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeDelayFilter

public TimeDelayFilter()

Method Detail

setDelay

public void setDelay(long timeDelaySeconds)

Sets the time delay in seconds.

filter

public ReplDBMSEvent filter(ReplDBMSEvent event)
                     throws ReplicatorException,
                            java.lang.InterruptedException

Implements a delay in processing the event. Filter the event. Filters may transform the event or return null if the event should be discarded. Filters must be prepared to be interrupted, which mechanism is used to cancel processing.

Specified by:

filter in interface Filter

Parameters:

event - An event to be filtered

Returns:

Filtered ReplDBMSEvent or null

Throws:

ReplicatorException - Thrown if there is a processing error

java.lang.InterruptedException - Must be thrown if the filter is interrupted or the replicator may hang

See Also:

Filter.filter(com.continuent.tungsten.replicator.event.ReplDBMSEvent)

configure

public void configure(PluginContext context)
               throws ReplicatorException

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

Specified by:

configure in interface ReplicatorPlugin

Throws:

ReplicatorException - Thrown if configuration is incomplete or fails

See Also:

ReplicatorPlugin.configure(com.continuent.tungsten.replicator.plugin.PluginContext)

prepare

public void prepare(PluginContext context)
             throws ReplicatorException

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

Specified by:

prepare in interface ReplicatorPlugin

Throws:

ReplicatorException - Thrown if resource allocation fails

See Also:

ReplicatorPlugin.prepare(com.continuent.tungsten.replicator.plugin.PluginContext)

release

public void release(PluginContext context)
             throws ReplicatorException

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

Specified by:

release in interface ReplicatorPlugin

Throws:

ReplicatorException - Thrown if resource deallocation fails

See Also:

ReplicatorPlugin.release(com.continuent.tungsten.replicator.plugin.PluginContext)