org.apache.hadoop.hbase.replication

Interface ReplicationPeerConfigBuilder

All Known Implementing Classes:

ReplicationPeerConfig.ReplicationPeerConfigBuilderImpl

@InterfaceAudience.Public
public interface ReplicationPeerConfigBuilder

For creating ReplicationPeerConfig.

Method Summary

Modifier and Type	Method and Description
ReplicationPeerConfig	build() Builds the configuration object from the current state of this.
default ReplicationPeerConfigBuilder	putAllConfiguration(Map<String,String> configuration) Adds all of the provided "raw" configuration entries to this.
default ReplicationPeerConfigBuilder	putAllPeerData(Map<byte[],byte[]> peerData) Sets all of the provided serialized peer configuration data.
ReplicationPeerConfigBuilder	putConfiguration(String key, String value) Sets a "raw" configuration property for this replication peer.
ReplicationPeerConfigBuilder	putPeerData(byte[] key, byte[] value) Sets the serialized peer configuration data
ReplicationPeerConfigBuilder	setBandwidth(long bandwidth) Sets the speed, in bytes per second, for any one RegionServer to replicate data to the peer.
ReplicationPeerConfigBuilder	setClusterKey(String clusterKey) Set the clusterKey which is the concatenation of the slave cluster's: hbase.zookeeper.quorum:hbase.zookeeper.property.clientPort:zookeeper.znode.parent
ReplicationPeerConfigBuilder	setExcludeNamespaces(Set<String> namespaces) Sets the collection of namespaces which should not be replicated when all user tables are configured to be replicated.
ReplicationPeerConfigBuilder	setExcludeTableCFsMap(Map<TableName,List<String>> tableCFsMap) Sets the mapping of table name to column families which should not be replicated.
ReplicationPeerConfigBuilder	setNamespaces(Set<String> namespaces) Sets a unique collection of HBase namespaces that should be replicated to this peer.
ReplicationPeerConfigBuilder	setReplicateAllUserTables(boolean replicateAllUserTables) Configures HBase to replicate all user tables (not system tables) to the peer.
ReplicationPeerConfigBuilder	setReplicationEndpointImpl(String replicationEndpointImpl) Sets the ReplicationEndpoint plugin class for this peer.
ReplicationPeerConfigBuilder	setSerial(boolean serial) Sets whether we should preserve order when replicating, i.e, serial replication.
ReplicationPeerConfigBuilder	setTableCFsMap(Map<TableName,List<String>> tableCFsMap) Sets an explicit map of tables and column families in those tables that should be replicated to the given peer.

Method Detail

setClusterKey

ReplicationPeerConfigBuilder setClusterKey(String clusterKey)

Set the clusterKey which is the concatenation of the slave cluster's: hbase.zookeeper.quorum:hbase.zookeeper.property.clientPort:zookeeper.znode.parent

setReplicationEndpointImpl

ReplicationPeerConfigBuilder setReplicationEndpointImpl(String replicationEndpointImpl)

Sets the ReplicationEndpoint plugin class for this peer.

Parameters:

replicationEndpointImpl - a class implementing ReplicationEndpoint

putConfiguration

@InterfaceAudience.Private
ReplicationPeerConfigBuilder putConfiguration(String key,
                                                                         String value)

Sets a "raw" configuration property for this replication peer. For experts only.

Parameters:

key - Configuration property key

value - Configuration property value

Returns:

this

putAllConfiguration

@InterfaceAudience.Private
default ReplicationPeerConfigBuilder putAllConfiguration(Map<String,String> configuration)

Adds all of the provided "raw" configuration entries to this.

Parameters:

configuration - A collection of raw configuration entries

Returns:

this

putPeerData

@InterfaceAudience.Private
ReplicationPeerConfigBuilder putPeerData(byte[] key,
                                                                    byte[] value)

Sets the serialized peer configuration data

Returns:

this

putAllPeerData

@InterfaceAudience.Private
default ReplicationPeerConfigBuilder putAllPeerData(Map<byte[],byte[]> peerData)

Sets all of the provided serialized peer configuration data.

Returns:

this

setTableCFsMap

ReplicationPeerConfigBuilder setTableCFsMap(Map<TableName,List<String>> tableCFsMap)

Sets an explicit map of tables and column families in those tables that should be replicated to the given peer. Use setReplicateAllUserTables(boolean) to replicate all tables to a peer.

Parameters:

tableCFsMap - A map from tableName to column family names. An empty collection can be passed to indicate replicating all column families.

Returns:

this

See Also:

setReplicateAllUserTables(boolean)

setNamespaces

ReplicationPeerConfigBuilder setNamespaces(Set<String> namespaces)

Sets a unique collection of HBase namespaces that should be replicated to this peer.

Parameters:

namespaces - A set of namespaces to be replicated to this peer.

Returns:

this

setBandwidth

ReplicationPeerConfigBuilder setBandwidth(long bandwidth)

Sets the speed, in bytes per second, for any one RegionServer to replicate data to the peer.

Parameters:

bandwidth - Bytes per second

Returns:

this.

setReplicateAllUserTables

ReplicationPeerConfigBuilder setReplicateAllUserTables(boolean replicateAllUserTables)

Configures HBase to replicate all user tables (not system tables) to the peer. Default is true.

Parameters:

replicateAllUserTables - True if all user tables should be replicated, else false.

Returns:

this

setExcludeTableCFsMap

ReplicationPeerConfigBuilder setExcludeTableCFsMap(Map<TableName,List<String>> tableCFsMap)

Sets the mapping of table name to column families which should not be replicated. This method sets state which is mutually exclusive to setTableCFsMap(Map). Invoking this method is only relevant when all user tables are being replicated.

Parameters:

tableCFsMap - A mapping of table names to column families which should not be replicated. An empty list of column families implies all families for the table.

Returns:

this.

setExcludeNamespaces

ReplicationPeerConfigBuilder setExcludeNamespaces(Set<String> namespaces)

Sets the collection of namespaces which should not be replicated when all user tables are configured to be replicated. This method sets state which is mutually exclusive to setNamespaces(Set). Invoking this method is only relevant when all user tables are being replicated.

Parameters:

namespaces - A set of namespaces whose tables should not be replicated.

Returns:

this

setSerial

ReplicationPeerConfigBuilder setSerial(boolean serial)

Sets whether we should preserve order when replicating, i.e, serial replication.

Default false.

Parameters:

serial - true means preserve order, otherwise false.

Returns:

this

build

ReplicationPeerConfig build()

Builds the configuration object from the current state of this.

Returns:

A ReplicationPeerConfig instance.