RegionServerCoprocessorHost (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.coprocessor.CoprocessorHost<RegionServerCoprocessorHost.RegionServerEnvironment>
- - org.apache.hadoop.hbase.regionserver.RegionServerCoprocessorHost

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
@InterfaceStability.Evolving
public class RegionServerCoprocessorHost
extends CoprocessorHost<RegionServerCoprocessorHost.RegionServerEnvironment>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`RegionServerCoprocessorHost.CoprocessOperationWithResult<T>`
`private static class`	`RegionServerCoprocessorHost.CoprocessorOperation`
`(package private) static class`	`RegionServerCoprocessorHost.EnvironmentPriorityComparator` Environment priority comparator.
`(package private) static class`	`RegionServerCoprocessorHost.RegionServerEnvironment` Coprocessor environment extension providing access to region server related services.

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost
CoprocessorHost.Environment

Field Summary

Fields
Modifier and Type Field and Description

private static org.apache.commons.logging.Log LOG

private RegionServerServices rsServices
- Fields inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost
  ABORT_ON_ERROR_KEY, abortable, conf, coprocessors, COPROCESSORS_ENABLED_CONF_KEY, DEFAULT_ABORT_ON_ERROR, DEFAULT_COPROCESSORS_ENABLED, DEFAULT_USER_COPROCESSORS_ENABLED, loadSequence, MASTER_COPROCESSOR_CONF_KEY, pathPrefix, REGION_COPROCESSOR_CONF_KEY, REGIONSERVER_COPROCESSOR_CONF_KEY, USER_COPROCESSORS_ENABLED_CONF_KEY, USER_REGION_COPROCESSOR_CONF_KEY, WAL_COPROCESSOR_CONF_KEY

Fields
Modifier and Type	Field and Description
`private static org.apache.commons.logging.Log`	`LOG`
`private RegionServerServices`	`rsServices`

Constructor Summary

Constructors
Constructor and Description

RegionServerCoprocessorHost(RegionServerServices rsServices, org.apache.hadoop.conf.Configuration conf)

Constructors
Constructor and Description
`RegionServerCoprocessorHost(RegionServerServices rsServices, org.apache.hadoop.conf.Configuration conf)`

Method Summary

Methods
Modifier and Type	Method and Description
`RegionServerCoprocessorHost.RegionServerEnvironment`	`createEnvironment(Class<?> implClass, Coprocessor instance, int priority, int sequence, org.apache.hadoop.conf.Configuration conf)` Called when a new Coprocessor class is loaded
`private boolean`	`execOperation(RegionServerCoprocessorHost.CoprocessorOperation ctx)`
`private <T> T`	`execOperationWithResult(T defaultValue, RegionServerCoprocessorHost.CoprocessOperationWithResult<T> ctx)`
`private boolean`	`execShutdown(RegionServerCoprocessorHost.CoprocessorOperation ctx)` RegionServer coprocessor classes can be configured in any order, based on that priority is set and chained in a sorted order.
`ReplicationEndpoint`	`postCreateReplicationEndPoint(ReplicationEndpoint endpoint)`
`void`	`postMerge(HRegion regionA, HRegion regionB, HRegion mergedRegion)`
`void`	`postMergeCommit(HRegion regionA, HRegion regionB, HRegion mergedRegion)`
`void`	`postReplicateLogEntries(List<org.apache.hadoop.hbase.protobuf.generated.AdminProtos.WALEntry> entries, CellScanner cells)`
`void`	`postRollBackMerge(HRegion regionA, HRegion regionB)`
`void`	`postRollWALWriterRequest()`
`boolean`	`preMerge(HRegion regionA, HRegion regionB)`
`boolean`	`preMergeCommit(HRegion regionA, HRegion regionB, List<Mutation> metaEntries)`
`void`	`preReplicateLogEntries(List<org.apache.hadoop.hbase.protobuf.generated.AdminProtos.WALEntry> entries, CellScanner cells)`
`void`	`preRollBackMerge(HRegion regionA, HRegion regionB)`
`void`	`preRollWALWriterRequest()`
`void`	`preStop(String message)`

Methods inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost
abortServer, abortServer, findCoprocessor, findCoprocessorEnvironment, findCoprocessors, getCoprocessors, getLoadedCoprocessors, handleCoprocessorThrowable, legacyWarning, load, load, loadInstance, loadSystemCoprocessors, shutdown, useLegacyMethod

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

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

rsServices

private RegionServerServices rsServices

Constructor Detail

RegionServerCoprocessorHost

public RegionServerCoprocessorHost(RegionServerServices rsServices,
                           org.apache.hadoop.conf.Configuration conf)

Method Detail

createEnvironment

public RegionServerCoprocessorHost.RegionServerEnvironment createEnvironment(Class<?> implClass,
                                                                    Coprocessor instance,
                                                                    int priority,
                                                                    int sequence,
                                                                    org.apache.hadoop.conf.Configuration conf)

Description copied from class: CoprocessorHost

Called when a new Coprocessor class is loaded

Specified by:: createEnvironment in class CoprocessorHost<RegionServerCoprocessorHost.RegionServerEnvironment>

preStop

public void preStop(String message)
             throws IOException

Throws:: IOException

preMerge

public boolean preMerge(HRegion regionA,
               HRegion regionB)
                 throws IOException

Throws:: IOException

postMerge

public void postMerge(HRegion regionA,
             HRegion regionB,
             HRegion mergedRegion)
               throws IOException

Throws:: IOException

preMergeCommit

public boolean preMergeCommit(HRegion regionA,
                     HRegion regionB,
                     @MetaMutationAnnotation
                     List<Mutation> metaEntries)
                       throws IOException

Throws:: IOException

postMergeCommit

public void postMergeCommit(HRegion regionA,
                   HRegion regionB,
                   HRegion mergedRegion)
                     throws IOException

Throws:: IOException

preRollBackMerge

public void preRollBackMerge(HRegion regionA,
                    HRegion regionB)
                      throws IOException

Throws:: IOException

postRollBackMerge

public void postRollBackMerge(HRegion regionA,
                     HRegion regionB)
                       throws IOException

Throws:: IOException

preRollWALWriterRequest

public void preRollWALWriterRequest()
                             throws IOException

Throws:: IOException

postRollWALWriterRequest

public void postRollWALWriterRequest()
                              throws IOException

Throws:: IOException

preReplicateLogEntries

public void preReplicateLogEntries(List<org.apache.hadoop.hbase.protobuf.generated.AdminProtos.WALEntry> entries,
                          CellScanner cells)
                            throws IOException

Throws:: IOException

postReplicateLogEntries

public void postReplicateLogEntries(List<org.apache.hadoop.hbase.protobuf.generated.AdminProtos.WALEntry> entries,
                           CellScanner cells)
                             throws IOException

Throws:: IOException

postCreateReplicationEndPoint

public ReplicationEndpoint postCreateReplicationEndPoint(ReplicationEndpoint endpoint)
                                                  throws IOException

Throws:: IOException

execOperationWithResult

private <T> T execOperationWithResult(T defaultValue,
                            RegionServerCoprocessorHost.CoprocessOperationWithResult<T> ctx)
                           throws IOException

Throws:: IOException

execOperation

private boolean execOperation(RegionServerCoprocessorHost.CoprocessorOperation ctx)
                       throws IOException

Throws:: IOException

execShutdown
```
private boolean execShutdown(RegionServerCoprocessorHost.CoprocessorOperation ctx)
                      throws IOException
```
RegionServer coprocessor classes can be configured in any order, based on that priority is set and chained in a sorted order. For preStop(), coprocessor methods are invoked in call() and environment is shutdown in postEnvCall().
Need to execute all coprocessor methods first then postEnvCall(), otherwise some coprocessors may remain shutdown if any exception occurs during next coprocessor execution which prevent RegionServer stop. (Refer: HBASE-16663

Parameters:
ctx - CoprocessorOperation

Returns:
true if bypaas coprocessor execution, false if not.

Throws:

IOException

Class RegionServerCoprocessorHost

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost

Field Summary

Fields inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost

Methods inherited from class java.lang.Object

Field Detail

LOG

rsServices

Constructor Detail

RegionServerCoprocessorHost

Method Detail

createEnvironment

preStop

preMerge

postMerge

preMergeCommit

postMergeCommit

preRollBackMerge

postRollBackMerge

preRollWALWriterRequest

postRollWALWriterRequest

preReplicateLogEntries

postReplicateLogEntries

postCreateReplicationEndPoint

execOperationWithResult

execOperation

execShutdown