org.apache.hadoop.hbase.replication.regionserver

Class Replication

java.lang.Object

org.apache.hadoop.hbase.regionserver.wal.WALActionsListener.Base

org.apache.hadoop.hbase.replication.regionserver.Replication

All Implemented Interfaces:

ReplicationService, ReplicationSinkService, ReplicationSourceService, WALActionsListener

@InterfaceAudience.Private
public class Replication
extends WALActionsListener.Base
implements ReplicationSourceService, ReplicationSinkService

Gateway to Replication. Used by HRegionServer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.regionserver.wal.WALActionsListener

WALActionsListener.Base

Constructor Summary

Constructors

Constructor and Description
Replication() Empty constructor
Replication(Server server, FileSystem fs, Path logDir, Path oldLogDir) Instantiate the replication management (if rep is enabled).

Method Summary

Modifier and Type	Method and Description
static void	decorateMasterConfiguration(Configuration conf) This method modifies the master's configuration in order to inject replication-related features
ReplicationSourceManager	getReplicationManager() Get the replication sources manager
WALActionsListener	getWALActionsListener() Returns a WALObserver for the service.
void	initialize(Server server, FileSystem fs, Path logDir, Path oldLogDir) Initializes the replication service object.
static boolean	isReplication(Configuration c)
static boolean	isReplicationForBulkLoadDataEnabled(Configuration c)
void	join() Join with the replication threads
void	postAppend(long entryLen, long elapsedTimeMillis, WALKey logKey, WALEdit edit) For notification post append to the writer.
void	postLogRoll(Path oldPath, Path newPath) The WAL has been rolled.
void	preLogRoll(Path oldPath, Path newPath) The WAL is going to be rolled.
ReplicationLoad	refreshAndGetReplicationLoad() Refresh and Get ReplicationLoad
void	replicateLogEntries(List<AdminProtos.WALEntry> entries, CellScanner cells, String replicationClusterId, String sourceBaseNamespaceDirPath, String sourceHFileArchiveDirPath) Carry on the list of log entries down to the sink
static void	scopeWALEdits(HTableDescriptor htd, WALKey logKey, WALEdit logEdit, Configuration conf, ReplicationSourceManager replicationManager) Utility method used to set the correct scopes on each log key.
void	startReplicationService() If replication is enabled and this cluster is a master, it starts
void	stopReplicationService() Stops replication service.
void	visitLogEntryBeforeWrite(HTableDescriptor htd, WALKey logKey, WALEdit logEdit)

Methods inherited from class org.apache.hadoop.hbase.regionserver.wal.WALActionsListener.Base

logCloseRequested, logRollRequested, postLogArchive, postSync, preLogArchive, visitLogEntryBeforeWrite

Methods inherited from class java.lang.Object

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

Constructor Detail

Replication

public Replication(Server server,
                   FileSystem fs,
                   Path logDir,
                   Path oldLogDir)
            throws IOException

Instantiate the replication management (if rep is enabled).

Parameters:

server - Hosting server

fs - handle to the filesystem

logDir -

oldLogDir - directory where logs are archived

Throws:

IOException

Replication

public Replication()

Empty constructor

Method Detail

initialize

public void initialize(Server server,
                       FileSystem fs,
                       Path logDir,
                       Path oldLogDir)
                throws IOException

Description copied from interface: ReplicationService

Initializes the replication service object.

Specified by:

initialize in interface ReplicationService

Throws:

IOException

isReplication

public static boolean isReplication(Configuration c)

Parameters:

c - Configuration to look at

Returns:

True if replication is enabled.

isReplicationForBulkLoadDataEnabled

public static boolean isReplicationForBulkLoadDataEnabled(Configuration c)

Parameters:

c - Configuration to look at

Returns:

True if replication for bulk load data is enabled.

getWALActionsListener

public WALActionsListener getWALActionsListener()

Description copied from interface: ReplicationSourceService

Returns a WALObserver for the service. This is needed to observe log rolls and log archival events.

Specified by:

getWALActionsListener in interface ReplicationSourceService

stopReplicationService

public void stopReplicationService()

Stops replication service.

Specified by:

stopReplicationService in interface ReplicationService

join

public void join()

Join with the replication threads

replicateLogEntries

public void replicateLogEntries(List<AdminProtos.WALEntry> entries,
                                CellScanner cells,
                                String replicationClusterId,
                                String sourceBaseNamespaceDirPath,
                                String sourceHFileArchiveDirPath)
                         throws IOException

Carry on the list of log entries down to the sink

Specified by:

replicateLogEntries in interface ReplicationSinkService

Parameters:

entries - list of entries to replicate

cells - The data -- the cells -- that entries describes (the entries do not contain the Cells we are replicating; they are passed here on the side in this CellScanner).

replicationClusterId - Id which will uniquely identify source cluster FS client configurations in the replication configuration directory

sourceBaseNamespaceDirPath - Path that point to the source cluster base namespace directory required for replicating hfiles

sourceHFileArchiveDirPath - Path that point to the source cluster hfile archive directory

Throws:

IOException

startReplicationService

public void startReplicationService()
                             throws IOException

If replication is enabled and this cluster is a master, it starts

Specified by:

startReplicationService in interface ReplicationService

Throws:

IOException

getReplicationManager

public ReplicationSourceManager getReplicationManager()

Get the replication sources manager

Returns:

the manager if replication is enabled, else returns false

visitLogEntryBeforeWrite

public void visitLogEntryBeforeWrite(HTableDescriptor htd,
                                     WALKey logKey,
                                     WALEdit logEdit)
                              throws IOException

Specified by:

visitLogEntryBeforeWrite in interface WALActionsListener

Overrides:

visitLogEntryBeforeWrite in class WALActionsListener.Base

logEdit - TODO: Retire this in favor of WALActionsListener.visitLogEntryBeforeWrite(HRegionInfo, WALKey, WALEdit) It only exists to get scope when replicating. Scope should be in the WALKey and not need us passing in a htd.

Throws:

IOException - If failed to parse the WALEdit

postAppend

public void postAppend(long entryLen,
                       long elapsedTimeMillis,
                       WALKey logKey,
                       WALEdit edit)
                throws IOException

Description copied from interface: WALActionsListener

For notification post append to the writer. Used by metrics system at least. TODO: Combine this with above.

Specified by:

postAppend in interface WALActionsListener

Overrides:

postAppend in class WALActionsListener.Base

Parameters:

entryLen - approx length of cells in this append.

elapsedTimeMillis - elapsed time in milliseconds.

logKey - A WAL key

edit - A WAL edit containing list of cells.

Throws:

IOException - if any network or I/O occurred

scopeWALEdits

public static void scopeWALEdits(HTableDescriptor htd,
                                 WALKey logKey,
                                 WALEdit logEdit,
                                 Configuration conf,
                                 ReplicationSourceManager replicationManager)
                          throws IOException

Utility method used to set the correct scopes on each log key. Doesn't set a scope on keys from compaction WAL edits and if the scope is local.

Parameters:

htd - Descriptor used to find the scope to use

logKey - Key that may get scoped according to its edits

logEdit - Edits used to lookup the scopes

replicationManager - Manager used to add bulk load events hfile references

Throws:

IOException - If failed to parse the WALEdit

preLogRoll

public void preLogRoll(Path oldPath,
                       Path newPath)
                throws IOException

Description copied from interface: WALActionsListener

The WAL is going to be rolled. The oldPath can be null if this is the first log file from the regionserver.

Specified by:

preLogRoll in interface WALActionsListener

Overrides:

preLogRoll in class WALActionsListener.Base

Parameters:

oldPath - the path to the old wal

newPath - the path to the new wal

Throws:

IOException

postLogRoll

public void postLogRoll(Path oldPath,
                        Path newPath)
                 throws IOException

Description copied from interface: WALActionsListener

The WAL has been rolled. The oldPath can be null if this is the first log file from the regionserver.

Specified by:

postLogRoll in interface WALActionsListener

Overrides:

postLogRoll in class WALActionsListener.Base

Parameters:

oldPath - the path to the old wal

newPath - the path to the new wal

Throws:

IOException

decorateMasterConfiguration

public static void decorateMasterConfiguration(Configuration conf)

This method modifies the master's configuration in order to inject replication-related features

Parameters:

conf -

refreshAndGetReplicationLoad

public ReplicationLoad refreshAndGetReplicationLoad()

Description copied from interface: ReplicationService

Refresh and Get ReplicationLoad

Specified by:

refreshAndGetReplicationLoad in interface ReplicationService