org.apache.hadoop.hbase.security.visibility

Class VisibilityReplicationEndpoint

java.lang.Object

org.apache.hadoop.hbase.security.visibility.VisibilityReplicationEndpoint

All Implemented Interfaces:

ReplicationEndpoint, ReplicationPeerConfigListener

@InterfaceAudience.Private
public class VisibilityReplicationEndpoint
extends Object
implements ReplicationEndpoint

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.replication.ReplicationEndpoint

ReplicationEndpoint.Context, ReplicationEndpoint.ReplicateContext

Constructor Summary

Constructors

Constructor and Description
VisibilityReplicationEndpoint(ReplicationEndpoint endpoint, VisibilityLabelService visibilityLabelsService)

Method Summary

Modifier and Type	Method and Description
void	awaitRunning() Waits for the ReplicationEndpoint to be up and running.
void	awaitRunning(long timeout, TimeUnit unit) Waits for the ReplicationEndpoint to to be up and running for no more than the given time.
void	awaitTerminated() Waits for the ReplicationEndpoint to reach the terminated (internal) state.
void	awaitTerminated(long timeout, TimeUnit unit) Waits for the ReplicationEndpoint to reach a terminal state for no more than the given time.
boolean	canReplicateToSameCluster() Whether or not, the replication endpoint can replicate to it's source cluster with the same UUID
Throwable	failureCause() Returns the Throwable that caused this service to fail.
UUID	getPeerUUID() Returns a UUID of the provided peer id.
WALEntryFilter	getWALEntryfilter() Returns a WALEntryFilter to use for filtering out WALEntries from the log.
void	init(ReplicationEndpoint.Context context) Initialize the replication endpoint with the given context.
boolean	isRunning() Returns true if this service is RUNNING.
boolean	isStarting()
void	peerConfigUpdated(ReplicationPeerConfig rpc) Callback method for when users update the ReplicationPeerConfig for this peer
boolean	replicate(ReplicationEndpoint.ReplicateContext replicateContext) Replicate the given set of entries (in the context) to the other cluster.
void	start() Initiates service startup and returns immediately.
void	stop() If the service is starting or running, this initiates service shutdown and returns immediately.

Methods inherited from class java.lang.Object

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

Constructor Detail

VisibilityReplicationEndpoint

public VisibilityReplicationEndpoint(ReplicationEndpoint endpoint,
                                     VisibilityLabelService visibilityLabelsService)

Method Detail

init

public void init(ReplicationEndpoint.Context context)
          throws IOException

Description copied from interface: ReplicationEndpoint

Initialize the replication endpoint with the given context.

Specified by:

init in interface ReplicationEndpoint

Parameters:

context - replication context

Throws:

IOException - error occur when initialize the endpoint.

peerConfigUpdated

public void peerConfigUpdated(ReplicationPeerConfig rpc)

Description copied from interface: ReplicationPeerConfigListener

Callback method for when users update the ReplicationPeerConfig for this peer

Specified by:

peerConfigUpdated in interface ReplicationPeerConfigListener

Parameters:

rpc - The updated ReplicationPeerConfig

replicate

public boolean replicate(ReplicationEndpoint.ReplicateContext replicateContext)

Description copied from interface: ReplicationEndpoint

Replicate the given set of entries (in the context) to the other cluster. Can block until all the given entries are replicated. Upon this method is returned, all entries that were passed in the context are assumed to be persisted in the target cluster.

Specified by:

replicate in interface ReplicationEndpoint

Parameters:

replicateContext - a context where WAL entries and other parameters can be obtained.

getPeerUUID

public UUID getPeerUUID()

Description copied from interface: ReplicationEndpoint

Returns a UUID of the provided peer id. Every HBase cluster instance has a persisted associated UUID. If the replication is not performed to an actual HBase cluster (but some other system), the UUID returned has to uniquely identify the connected target system.

Specified by:

getPeerUUID in interface ReplicationEndpoint

Returns:

a UUID or null if the peer cluster does not exist or is not connected.

canReplicateToSameCluster

public boolean canReplicateToSameCluster()

Description copied from interface: ReplicationEndpoint

Whether or not, the replication endpoint can replicate to it's source cluster with the same UUID

Specified by:

canReplicateToSameCluster in interface ReplicationEndpoint

getWALEntryfilter

public WALEntryFilter getWALEntryfilter()

Description copied from interface: ReplicationEndpoint

Returns a WALEntryFilter to use for filtering out WALEntries from the log. Replication infrastructure will call this filter before sending the edits to shipEdits().

Specified by:

getWALEntryfilter in interface ReplicationEndpoint

Returns:

a WALEntryFilter or null.

isRunning

public boolean isRunning()

Description copied from interface: ReplicationEndpoint

Returns true if this service is RUNNING.

Specified by:

isRunning in interface ReplicationEndpoint

isStarting

public boolean isStarting()

Specified by:

isStarting in interface ReplicationEndpoint

Returns:

Return true is this service is STARTING (but not yet RUNNING).

start

public void start()

Description copied from interface: ReplicationEndpoint

Initiates service startup and returns immediately. A stopped service may not be restarted. Equivalent of startAsync call in Guava Service.

Specified by:

start in interface ReplicationEndpoint

awaitRunning

public void awaitRunning()

Description copied from interface: ReplicationEndpoint

Waits for the ReplicationEndpoint to be up and running.

Specified by:

awaitRunning in interface ReplicationEndpoint

awaitRunning

public void awaitRunning(long timeout,
                         TimeUnit unit)
                  throws TimeoutException

Description copied from interface: ReplicationEndpoint

Waits for the ReplicationEndpoint to to be up and running for no more than the given time.

Specified by:

awaitRunning in interface ReplicationEndpoint

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

TimeoutException - if the service has not reached the given state within the deadline

stop

public void stop()

Description copied from interface: ReplicationEndpoint

If the service is starting or running, this initiates service shutdown and returns immediately. If the service has already been stopped, this method returns immediately without taking action. Equivalent of stopAsync call in Guava Service.

Specified by:

stop in interface ReplicationEndpoint

awaitTerminated

public void awaitTerminated()

Description copied from interface: ReplicationEndpoint

Waits for the ReplicationEndpoint to reach the terminated (internal) state.

Specified by:

awaitTerminated in interface ReplicationEndpoint

awaitTerminated

public void awaitTerminated(long timeout,
                            TimeUnit unit)
                     throws TimeoutException

Description copied from interface: ReplicationEndpoint

Waits for the ReplicationEndpoint to reach a terminal state for no more than the given time.

Specified by:

awaitTerminated in interface ReplicationEndpoint

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

TimeoutException - if the service has not reached the given state within the deadline

failureCause

public Throwable failureCause()

Description copied from interface: ReplicationEndpoint

Returns the Throwable that caused this service to fail.

Specified by:

failureCause in interface ReplicationEndpoint