com.continuent.tungsten.replicator.filter
Class BidiRemoteSlaveFilter

java.lang.Object
  extended by com.continuent.tungsten.replicator.filter.BidiRemoteSlaveFilter
All Implemented Interfaces:
Filter, ReplicatorPlugin

public class BidiRemoteSlaveFilter
extends java.lang.Object
implements Filter

Implements a filter to suppress events that originate on the local service for remote slaves. This filter *must* run on slave pipelines for remote slaves to prevent replication loops in bi-directional replication.

Version:
1.0
Author:
Robert Hodges

Constructor Summary
BidiRemoteSlaveFilter()
           
 
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.
 void setAllowAnyRemoteService(boolean allowAnyRemoteService)
          Sets whether to allow all remote services or just this one.
 void setAllowBidiUnsafe(boolean allowBidiUnsafe)
          Sets whether we allow SQL that may be unsafe for bi-directional replication.
 void setLocalServiceName(java.lang.String localServiceName)
          Sets the local service name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BidiRemoteSlaveFilter

public BidiRemoteSlaveFilter()
Method Detail

setLocalServiceName

public void setLocalServiceName(java.lang.String localServiceName)
Sets the local service name. Events for this service are discarded.


setAllowBidiUnsafe

public void setAllowBidiUnsafe(boolean allowBidiUnsafe)
Sets whether we allow SQL that may be unsafe for bi-directional replication.


setAllowAnyRemoteService

public void setAllowAnyRemoteService(boolean allowAnyRemoteService)
Sets whether to allow all remote services or just this one.


filter

public ReplDBMSEvent filter(ReplDBMSEvent event)
                     throws ReplicatorException,
                            java.lang.InterruptedException
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)