org.apache.hadoop.hbase.replication.regionserver

Interface ReplicationSourceInterface

All Known Implementing Classes:

CatalogReplicationSource, RecoveredReplicationSource, ReplicationSource

@InterfaceAudience.Private
public interface ReplicationSourceInterface

Interface that defines a replication source

Method Summary

Modifier and Type	Method and Description
void	addHFileRefs(TableName tableName, byte[] family, List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs) Add hfile names to the queue to be replicated.
void	enqueueLog(org.apache.hadoop.fs.Path log) Add a log to the list of logs to replicate
org.apache.hadoop.fs.Path	getCurrentPath() Get the current log that's replicated
String	getPeerId() Get the id that the source is replicating to.
String	getQueueId() Get the queue id that the source is replicating to
ReplicationEndpoint	getReplicationEndpoint()
ReplicationQueueStorage	getReplicationQueueStorage()
ServerName	getServerWALsBelongTo() The queue of WALs only belong to one region server.
ReplicationSourceManager	getSourceManager()
MetricsSource	getSourceMetrics()
String	getStats() Get a string representation of the current statistics for this source
WALFileLengthProvider	getWALFileLengthProvider()
default Map<String,ReplicationStatus>	getWalGroupStatus() get the stat of replication for each wal group.
void	init(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, ReplicationSourceManager manager, ReplicationQueueStorage queueStorage, ReplicationPeer replicationPeer, Server server, String queueId, UUID clusterId, WALFileLengthProvider walFileLengthProvider, MetricsSource metrics) Initializer for the source
boolean	isPeerEnabled()
default boolean	isRecovered()
boolean	isSourceActive()
default void	logPositionAndCleanOldLogs(WALEntryBatch entryBatch) Log the current position to storage.
void	postShipEdits(List<WAL.Entry> entries, int batchSize) Call this after the shipper thread ship some entries to peer cluster.
ReplicationSourceInterface	startup() Start the replication
void	terminate(String reason) End the replication
void	terminate(String reason, Exception cause) End the replication
void	terminate(String reason, Exception cause, boolean clearMetrics) End the replication
void	tryThrottle(int batchSize) Try to throttle when the peer config with a bandwidth

Method Detail

init

void init(org.apache.hadoop.conf.Configuration conf,
          org.apache.hadoop.fs.FileSystem fs,
          ReplicationSourceManager manager,
          ReplicationQueueStorage queueStorage,
          ReplicationPeer replicationPeer,
          Server server,
          String queueId,
          UUID clusterId,
          WALFileLengthProvider walFileLengthProvider,
          MetricsSource metrics)
   throws IOException

Initializer for the source

Parameters:

conf - the configuration to use

fs - the file system to use

manager - the manager to use

server - the server for this region server

Throws:

IOException

enqueueLog

void enqueueLog(org.apache.hadoop.fs.Path log)

Add a log to the list of logs to replicate

Parameters:

log - path to the log to replicate

addHFileRefs

void addHFileRefs(TableName tableName,
                  byte[] family,
                  List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)
           throws ReplicationException

Add hfile names to the queue to be replicated.

Parameters:

tableName - Name of the table these files belongs to

family - Name of the family these files belong to

pairs - list of pairs of { HFile location in staging dir, HFile path in region dir which will be added in the queue for replication}

Throws:

ReplicationException - If failed to add hfile references

startup

ReplicationSourceInterface startup()

Start the replication

terminate

void terminate(String reason)

End the replication

Parameters:

reason - why it's terminating

terminate

void terminate(String reason,
               Exception cause)

End the replication

Parameters:

reason - why it's terminating

cause - the error that's causing it

terminate

void terminate(String reason,
               Exception cause,
               boolean clearMetrics)

End the replication

Parameters:

reason - why it's terminating

cause - the error that's causing it

clearMetrics - removes all metrics about this Source

getCurrentPath

org.apache.hadoop.fs.Path getCurrentPath()

Get the current log that's replicated

Returns:

the current log

getQueueId

String getQueueId()

Get the queue id that the source is replicating to

Returns:

queue id

getPeerId

String getPeerId()

Get the id that the source is replicating to.

Returns:

peer id

getStats

String getStats()

Get a string representation of the current statistics for this source

Returns:

printable stats

isPeerEnabled

boolean isPeerEnabled()

Returns:

peer enabled or not

isSourceActive

boolean isSourceActive()

Returns:

active or not

getSourceMetrics

MetricsSource getSourceMetrics()

Returns:

metrics of this replication source

getReplicationEndpoint

ReplicationEndpoint getReplicationEndpoint()

Returns:

the replication endpoint used by this replication source

getSourceManager

ReplicationSourceManager getSourceManager()

Returns:

the replication source manager

getWALFileLengthProvider

WALFileLengthProvider getWALFileLengthProvider()

Returns:

the wal file length provider

tryThrottle

void tryThrottle(int batchSize)
          throws InterruptedException

Try to throttle when the peer config with a bandwidth

Parameters:

batchSize - entries size will be pushed

Throws:

InterruptedException

postShipEdits

void postShipEdits(List<WAL.Entry> entries,
                   int batchSize)

Call this after the shipper thread ship some entries to peer cluster.

Parameters:

entries - pushed

batchSize - entries size pushed

getServerWALsBelongTo

ServerName getServerWALsBelongTo()

The queue of WALs only belong to one region server. This will return the server name which all WALs belong to.

Returns:

the server name which all WALs belong to

getWalGroupStatus

default Map<String,ReplicationStatus> getWalGroupStatus()

get the stat of replication for each wal group.

Returns:

stat of replication

isRecovered

default boolean isRecovered()

Returns:

whether this is a replication source for recovery.

getReplicationQueueStorage

ReplicationQueueStorage getReplicationQueueStorage()

Returns:

The instance of queueStorage used by this ReplicationSource.

logPositionAndCleanOldLogs

default void logPositionAndCleanOldLogs(WALEntryBatch entryBatch)

Log the current position to storage. Also clean old logs from the replication queue. Use to bypass the default call to ReplicationSourceManager.logPositionAndCleanOldLogs(ReplicationSourceInterface, WALEntryBatch) whem implementation does not need to persist state to backing storage.

Parameters:

entryBatch - the wal entry batch we just shipped