ReplicationPeerConfig (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.replication.ReplicationPeerConfig

@InterfaceAudience.Public
public class ReplicationPeerConfig
extends Object

A configuration for the replication peer cluster.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class ReplicationPeerConfig.ReplicationPeerConfigBuilderImpl

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`ReplicationPeerConfig.ReplicationPeerConfigBuilderImpl`

Field Summary

Fields
Modifier and Type	Field and Description
`private long`	`bandwidth`
`private String`	`clusterKey`
`private Map<String,String>`	`configuration`
`private Set<String>`	`excludeNamespaces`
`private Map<TableName,? extends Collection<String>>`	`excludeTableCFsMap`
`private Set<String>`	`namespaces`
`private Map<byte[],byte[]>`	`peerData`
`private boolean`	`replicateAllUserTables`
`private String`	`replicationEndpointImpl`
`private boolean`	`serial`
`private Map<TableName,? extends Collection<String>>`	`tableCFsMap`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ReplicationPeerConfig()` Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use `ReplicationPeerConfigBuilder` to create new ReplicationPeerConfig.
`private`	`ReplicationPeerConfig(ReplicationPeerConfig.ReplicationPeerConfigBuilderImpl builder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`long`	`getBandwidth()`
`String`	`getClusterKey()`
`Map<String,String>`	`getConfiguration()`
`Set<String>`	`getExcludeNamespaces()`
`Map<TableName,List<String>>`	`getExcludeTableCFsMap()`
`Set<String>`	`getNamespaces()`
`Map<byte[],byte[]>`	`getPeerData()`
`String`	`getReplicationEndpointImpl()`
`Map<TableName,List<String>>`	`getTableCFsMap()`
`boolean`	`isSerial()`
`boolean`	`needToReplicate(TableName table)` Decide whether the table need replicate to the peer cluster
`boolean`	`needToReplicate(TableName table, byte[] family)` Decide whether the passed family of the table need replicate to the peer cluster according to this peer config.
`static ReplicationPeerConfigBuilder`	`newBuilder()`
`static ReplicationPeerConfigBuilder`	`newBuilder(ReplicationPeerConfig peerConfig)`
`boolean`	`replicateAllUserTables()`
`ReplicationPeerConfig`	`setBandwidth(long bandwidth)` Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use `ReplicationPeerConfigBuilder.setBandwidth(long)` instead.
`ReplicationPeerConfig`	`setClusterKey(String clusterKey)` Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use `ReplicationPeerConfigBuilder.setClusterKey(String)` instead.
`ReplicationPeerConfig`	`setExcludeNamespaces(Set<String> namespaces)` Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use `ReplicationPeerConfigBuilder.setExcludeNamespaces(Set)` instead.
`ReplicationPeerConfig`	`setExcludeTableCFsMap(Map<TableName,? extends Collection<String>> tableCFsMap)` Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use `ReplicationPeerConfigBuilder.setExcludeTableCFsMap(Map)` instead.
`ReplicationPeerConfig`	`setNamespaces(Set<String> namespaces)` Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use `ReplicationPeerConfigBuilder.setNamespaces(Set)` instead.
`ReplicationPeerConfig`	`setReplicateAllUserTables(boolean replicateAllUserTables)` Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use `ReplicationPeerConfigBuilder.setReplicateAllUserTables(boolean)` instead.
`ReplicationPeerConfig`	`setReplicationEndpointImpl(String replicationEndpointImpl)` Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use `ReplicationPeerConfigBuilder.setReplicationEndpointImpl(String)` instead.
`ReplicationPeerConfig`	`setTableCFsMap(Map<TableName,? extends Collection<String>> tableCFsMap)` Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use `ReplicationPeerConfigBuilder.setTableCFsMap(Map)` instead.
`String`	`toString()`
`private Map<TableName,List<String>>`	`unmodifiableTableCFsMap(Map<TableName,List<String>> tableCFsMap)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - clusterKey
```
private String clusterKey
```
  - replicationEndpointImpl
```
private String replicationEndpointImpl
```
  - peerData
```
private final Map<byte[],byte[]> peerData
```
  - configuration
```
private final Map<String,String> configuration
```
  - tableCFsMap
```
private Map<TableName,? extends Collection<String>> tableCFsMap
```
  - namespaces
```
private Set<String> namespaces
```
  - replicateAllUserTables
```
private boolean replicateAllUserTables
```
  - excludeTableCFsMap
```
private Map<TableName,? extends Collection<String>> excludeTableCFsMap
```
  - excludeNamespaces
```
private Set<String> excludeNamespaces
```
  - bandwidth
```
private long bandwidth
```
  - serial
```
private final boolean serial
```
- Constructor Detail
  - ReplicationPeerConfig
```
private ReplicationPeerConfig(ReplicationPeerConfig.ReplicationPeerConfigBuilderImpl builder)
```
  - ReplicationPeerConfig
```
@Deprecated
public ReplicationPeerConfig()
```
    Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use ReplicationPeerConfigBuilder to create new ReplicationPeerConfig.
- Method Detail
  - unmodifiableTableCFsMap
```
private Map<TableName,List<String>> unmodifiableTableCFsMap(Map<TableName,List<String>> tableCFsMap)
```
  - setClusterKey
```
@Deprecated
public ReplicationPeerConfig setClusterKey(String clusterKey)
```
    Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use ReplicationPeerConfigBuilder.setClusterKey(String) instead.
    
    Set the clusterKey which is the concatenation of the slave cluster's: hbase.zookeeper.quorum:hbase.zookeeper.property.clientPort:zookeeper.znode.parent
  - setReplicationEndpointImpl
```
@Deprecated
public ReplicationPeerConfig setReplicationEndpointImpl(String replicationEndpointImpl)
```
    Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use ReplicationPeerConfigBuilder.setReplicationEndpointImpl(String) instead.
    
    Sets the ReplicationEndpoint plugin class for this peer.
    
    Parameters:
    
    replicationEndpointImpl - a class implementing ReplicationEndpoint
  - getClusterKey
```
public String getClusterKey()
```
  - getReplicationEndpointImpl
```
public String getReplicationEndpointImpl()
```
  - getPeerData
```
public Map<byte[],byte[]> getPeerData()
```
  - getConfiguration
```
public Map<String,String> getConfiguration()
```
  - getTableCFsMap
```
public Map<TableName,List<String>> getTableCFsMap()
```
  - setTableCFsMap
```
@Deprecated
public ReplicationPeerConfig setTableCFsMap(Map<TableName,? extends Collection<String>> tableCFsMap)
```
    Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use ReplicationPeerConfigBuilder.setTableCFsMap(Map) instead.
  - getNamespaces
```
public Set<String> getNamespaces()
```
  - setNamespaces
```
@Deprecated
public ReplicationPeerConfig setNamespaces(Set<String> namespaces)
```
    Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use ReplicationPeerConfigBuilder.setNamespaces(Set) instead.
  - getBandwidth
```
public long getBandwidth()
```
  - setBandwidth
```
@Deprecated
public ReplicationPeerConfig setBandwidth(long bandwidth)
```
    Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use ReplicationPeerConfigBuilder.setBandwidth(long) instead.
  - replicateAllUserTables
```
public boolean replicateAllUserTables()
```
  - setReplicateAllUserTables
```
@Deprecated
public ReplicationPeerConfig setReplicateAllUserTables(boolean replicateAllUserTables)
```
    Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use ReplicationPeerConfigBuilder.setReplicateAllUserTables(boolean) instead.
  - getExcludeTableCFsMap
```
public Map<TableName,List<String>> getExcludeTableCFsMap()
```
  - setExcludeTableCFsMap
```
@Deprecated
public ReplicationPeerConfig setExcludeTableCFsMap(Map<TableName,? extends Collection<String>> tableCFsMap)
```
    Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use ReplicationPeerConfigBuilder.setExcludeTableCFsMap(Map) instead.
  - getExcludeNamespaces
```
public Set<String> getExcludeNamespaces()
```
  - setExcludeNamespaces
```
@Deprecated
public ReplicationPeerConfig setExcludeNamespaces(Set<String> namespaces)
```
    Deprecated. as release of 2.0.0, and it will be removed in 3.0.0. Use ReplicationPeerConfigBuilder.setExcludeNamespaces(Set) instead.
  - newBuilder
```
public static ReplicationPeerConfigBuilder newBuilder()
```
  - isSerial
```
public boolean isSerial()
```
  - newBuilder
```
public static ReplicationPeerConfigBuilder newBuilder(ReplicationPeerConfig peerConfig)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - needToReplicate
```
public boolean needToReplicate(TableName table)
```
    Decide whether the table need replicate to the peer cluster
    
    Parameters:
    
    table - name of the table
    
    Returns:
    
    true if the table need replicate to the peer cluster
  - needToReplicate
```
public boolean needToReplicate(TableName table,
                               byte[] family)
```
    Decide whether the passed family of the table need replicate to the peer cluster according to this peer config.
    
    Parameters:
    
    table - name of the table
    
    family - family name
    
    Returns:
    
    true if (the family of) the table need replicate to the peer cluster. If passed family is null, return true if any CFs of the table need replicate; If passed family is not null, return true if the passed family need replicate.

Class ReplicationPeerConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

clusterKey

replicationEndpointImpl

peerData

configuration

tableCFsMap

namespaces

replicateAllUserTables

excludeTableCFsMap

excludeNamespaces

bandwidth

serial

Constructor Detail

ReplicationPeerConfig

ReplicationPeerConfig

Method Detail

unmodifiableTableCFsMap

setClusterKey

setReplicationEndpointImpl

getClusterKey

getReplicationEndpointImpl

getPeerData

getConfiguration

getTableCFsMap

setTableCFsMap

getNamespaces

setNamespaces

getBandwidth

setBandwidth

replicateAllUserTables

setReplicateAllUserTables

getExcludeTableCFsMap

setExcludeTableCFsMap

getExcludeNamespaces

setExcludeNamespaces

newBuilder

isSerial

newBuilder

toString

needToReplicate

needToReplicate