org.apache.hadoop.hbase.wal

Class SyncReplicationWALProvider

java.lang.Object

org.apache.hadoop.hbase.wal.SyncReplicationWALProvider

All Implemented Interfaces:

PeerActionListener, WALProvider

@InterfaceAudience.Private
public class SyncReplicationWALProvider
extends Object
implements WALProvider, PeerActionListener

The special WALProvider for synchronous replication.

It works like an interceptor, when getting WAL, first it will check if the given region should be replicated synchronously, if so it will return a special WAL for it, otherwise it will delegate the request to the normal WALProvider.

Nested Class Summary

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

WALProvider.AsyncWriter, WALProvider.Writer, WALProvider.WriterBase

Field Summary

Fields

Modifier and Type	Field and Description
static String	DUAL_WAL_IMPL

Fields inherited from interface org.apache.hadoop.hbase.replication.regionserver.PeerActionListener

DUMMY

Method Summary

Modifier and Type	Method and Description
void	addWALActionsListener(WALActionsListener listener) Add a WALActionsListener.
void	close() shutdown utstanding WALs and clean up any persisted state.
long	getLogFileSize() Get size of the log files this provider is managing
long	getNumLogFiles() Get number of the log files this provider is managing
static Optional<String>	getSyncReplicationPeerIdFromWALName(String name) Returns the peer id if the wal file name is in the special group for a sync replication peer.
WAL	getWAL(RegionInfo region)
List<WAL>	getWALs()
void	init(WALFactory factory, org.apache.hadoop.conf.Configuration conf, String providerId, Abortable abortable) Set up the provider to create wals.
void	peerSyncReplicationStateChange(String peerId, SyncReplicationState from, SyncReplicationState to, int stage)
void	setPeerInfoProvider(SyncReplicationPeerInfoProvider peerInfoProvider)
void	shutdown() persist outstanding WALs to storage and stop accepting new appends.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.wal.WALProvider

getWALFileLengthProvider

Field Detail

DUAL_WAL_IMPL

public static final String DUAL_WAL_IMPL

See Also:

Constant Field Values

Method Detail

setPeerInfoProvider

public void setPeerInfoProvider(SyncReplicationPeerInfoProvider peerInfoProvider)

init

public void init(WALFactory factory,
                 org.apache.hadoop.conf.Configuration conf,
                 String providerId,
                 Abortable abortable)
          throws IOException

Description copied from interface: WALProvider

Set up the provider to create wals. will only be called once per instance.

Specified by:

init in interface WALProvider

Parameters:

factory - factory that made us may not be null

conf - may not be null

providerId - differentiate between providers from one factory. may be null

Throws:

IOException

getWAL

public WAL getWAL(RegionInfo region)
           throws IOException

Specified by:

getWAL in interface WALProvider

Parameters:

region - the region which we want to get a WAL for it. Could be null.

Returns:

a WAL for writing entries for the given region.

Throws:

IOException

getWALs

public List<WAL> getWALs()

Specified by:

getWALs in interface WALProvider

Returns:

the List of WALs that are used by this server

shutdown

public void shutdown()
              throws IOException

Description copied from interface: WALProvider

persist outstanding WALs to storage and stop accepting new appends. This method serves as shorthand for sending a sync to every WAL provided by a given implementation. Those WALs will also stop accepting new writes.

Specified by:

shutdown in interface WALProvider

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: WALProvider

shutdown utstanding WALs and clean up any persisted state. Call this method only when you will not need to replay any of the edits to the WALs from this provider. After this call completes, the underlying resources should have been reclaimed.

Specified by:

close in interface WALProvider

Throws:

IOException

getNumLogFiles

public long getNumLogFiles()

Description copied from interface: WALProvider

Get number of the log files this provider is managing

Specified by:

getNumLogFiles in interface WALProvider

getLogFileSize

public long getLogFileSize()

Description copied from interface: WALProvider

Get size of the log files this provider is managing

Specified by:

getLogFileSize in interface WALProvider

addWALActionsListener

public void addWALActionsListener(WALActionsListener listener)

Description copied from interface: WALProvider

Add a WALActionsListener.

Notice that you must call this method before calling WALProvider.getWAL(RegionInfo) as this method will not effect the WAL which has already been created. And as long as we can only it when initialization, it is not thread safe.

Specified by:

addWALActionsListener in interface WALProvider

peerSyncReplicationStateChange

public void peerSyncReplicationStateChange(String peerId,
                                           SyncReplicationState from,
                                           SyncReplicationState to,
                                           int stage)

Specified by:

peerSyncReplicationStateChange in interface PeerActionListener

getSyncReplicationPeerIdFromWALName

public static Optional<String> getSyncReplicationPeerIdFromWALName(String name)

Returns the peer id if the wal file name is in the special group for a sync replication peer.

The prefix format is <factoryId>-<ts>-<peerId>.