com.continuent.tungsten.replicator.heartbeat
Class HeartbeatFilter

java.lang.Object
  com.continuent.tungsten.replicator.heartbeat.HeartbeatFilter

All Implemented Interfaces:

Filter, ReplicatorPlugin

public class HeartbeatFilter
extends java.lang.Object
implements Filter

Implements a filter to detect heartbeat table updates and add appropriate metadata to the event. This filter can run on either master or slave.

Version:

1.0

Author:

Robert Hodges

Constructor Summary

HeartbeatFilter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartbeatFilter

public HeartbeatFilter()

Method Detail

filter

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

Description copied from interface: Filter

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

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)