Package org.apache.hadoop.hbase.security.access

Class AbstractReadOnlyController

java.lang.Object

org.apache.hadoop.hbase.security.access.AbstractReadOnlyController

All Implemented Interfaces:

Coprocessor

Direct Known Subclasses:

BulkLoadReadOnlyController, EndpointReadOnlyController, MasterReadOnlyController, RegionReadOnlyController, RegionServerReadOnlyController

@LimitedPrivate("Configuration")
public abstract class AbstractReadOnlyController
extends Object
implements Coprocessor

Nested Class Summary

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

Coprocessor.State

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOG
private static final Set<TableName>	writableTables

Fields inherited from interface org.apache.hadoop.hbase.Coprocessor

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor	Description
AbstractReadOnlyController()

Method Summary

Modifier and Type	Method	Description
protected void	internalReadOnlyGuard()
static boolean	isAnotherClusterActive(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path rootDir, ActiveClusterSuffix localClusterSuffix)	Checks whether another cluster is currently active on this storage location by reading the "active.cluster.suffix.id" file on the filesystem.
static boolean	isWritableInReadOnlyMode(ObserverContext<? extends RegionCoprocessorEnvironment> c)
static boolean	isWritableInReadOnlyMode(TableName tableName)
static void	manageActiveClusterIdFile(boolean readOnlyEnabled, MasterFileSystem mfs)
void	start(CoprocessorEnvironment env)	Called by the CoprocessorEnvironment during it's own startup to initialize the coprocessor.
void	stop(CoprocessorEnvironment env)	Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.

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.Coprocessor

getServices

Field Details

LOG

private static final org.slf4j.Logger LOG

writableTables

private static final Set<TableName> writableTables

Constructor Details

AbstractReadOnlyController

public AbstractReadOnlyController()

Method Details

isWritableInReadOnlyMode

public static boolean isWritableInReadOnlyMode(ObserverContext<? extends RegionCoprocessorEnvironment> c)

isWritableInReadOnlyMode

public static boolean isWritableInReadOnlyMode(TableName tableName)

internalReadOnlyGuard

protected void internalReadOnlyGuard()
                              throws WriteAttemptedOnReadOnlyClusterException

Throws:

WriteAttemptedOnReadOnlyClusterException

start

public void start(CoprocessorEnvironment env)
           throws IOException

Description copied from interface: Coprocessor

Called by the CoprocessorEnvironment during it's own startup to initialize the coprocessor.

Specified by:

start in interface Coprocessor

Throws:

IOException

stop

public void stop(CoprocessorEnvironment env)

Description copied from interface: Coprocessor

Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.

Specified by:

stop in interface Coprocessor

isAnotherClusterActive

public static boolean isAnotherClusterActive(org.apache.hadoop.fs.FileSystem fs,
 org.apache.hadoop.fs.Path rootDir,
 ActiveClusterSuffix localClusterSuffix)

Checks whether another cluster is currently active on this storage location by reading the "active.cluster.suffix.id" file on the filesystem.

Parameters:

fs - the filesystem to read from

rootDir - the HBase root directory

localClusterSuffix - the local cluster's ActiveClusterSuffix identity

Returns:

true if the active cluster file exists and belongs to a different cluster; false if the file does not exist or belongs to this cluster

manageActiveClusterIdFile

public static void manageActiveClusterIdFile(boolean readOnlyEnabled,
 MasterFileSystem mfs)