Package org.apache.hadoop.hbase.coprocessor

Class BaseRowProcessorEndpoint<S extends com.google.protobuf.Message,T extends com.google.protobuf.Message>

java.lang.Object

org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.RowProcessorService

org.apache.hadoop.hbase.coprocessor.BaseRowProcessorEndpoint<S,T>

All Implemented Interfaces:

com.google.protobuf.Service, Coprocessor, RegionCoprocessor

@LimitedPrivate("Coprocesssor")
@Evolving
public abstract class BaseRowProcessorEndpoint<S extends com.google.protobuf.Message,T extends com.google.protobuf.Message>
extends org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.RowProcessorService
implements RegionCoprocessor

This class demonstrates how to implement atomic read-modify-writes using Region.processRowsWithLocks(org.apache.hadoop.hbase.regionserver.RowProcessor<?, ?>) and Coprocessor endpoints.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.RowProcessorService

org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.RowProcessorService.BlockingInterface, org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.RowProcessorService.Interface, org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.RowProcessorService.Stub

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

Coprocessor.State

Field Summary

Fields

Modifier and Type	Field	Description
private RegionCoprocessorEnvironment	env

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

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor	Description
BaseRowProcessorEndpoint()

Method Summary

Modifier and Type	Method	Description
(package private) RowProcessor<S,T>	constructRowProcessorFromRequest(org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.ProcessRequest request)
Iterable<com.google.protobuf.Service>	getServices()	Coprocessor endpoints providing protobuf services should override this method.
void	process(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.ProcessRequest request, com.google.protobuf.RpcCallback<org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.ProcessResponse> done)	Pass a processor to region to process multiple rows atomically.
void	start(CoprocessorEnvironment env)	Stores a reference to the coprocessor environment provided by the RegionCoprocessorHost from the region where this coprocessor is loaded.
void	stop(CoprocessorEnvironment env)	Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.

Methods inherited from class org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.RowProcessorService

callMethod, getDescriptor, getDescriptorForType, getRequestPrototype, getResponsePrototype, newBlockingStub, newReflectiveBlockingService, newReflectiveService, newStub

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

getBulkLoadObserver, getEndpointObserver, getRegionObserver

Field Details

env

private RegionCoprocessorEnvironment env

Constructor Details

BaseRowProcessorEndpoint

public BaseRowProcessorEndpoint()

Method Details

process

public void process(com.google.protobuf.RpcController controller,
 org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.ProcessRequest request,
 com.google.protobuf.RpcCallback<org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.ProcessResponse> done)

Pass a processor to region to process multiple rows atomically. The RowProcessor implementations should be the inner classes of your RowProcessorEndpoint. This way the RowProcessor can be class-loaded with the Coprocessor endpoint together. See TestRowProcessorEndpoint for example. The request contains information for constructing processor (see constructRowProcessorFromRequest(org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.ProcessRequest). The processor object defines the read-modify-write procedure.

Specified by:

process in class org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.RowProcessorService

getServices

public Iterable<com.google.protobuf.Service> getServices()

Description copied from interface: Coprocessor

Coprocessor endpoints providing protobuf services should override this method.

Specified by:

getServices in interface Coprocessor

Returns:

Iterable of Services or empty collection. Implementations should never return null.

start

public void start(CoprocessorEnvironment env)
           throws IOException

Stores a reference to the coprocessor environment provided by the RegionCoprocessorHost from the region where this coprocessor is loaded. Since this is a coprocessor endpoint, it always expects to be loaded on a table region, so always expects this to be an instance of RegionCoprocessorEnvironment.

Specified by:

start in interface Coprocessor

Parameters:

env - the environment provided by the coprocessor host

Throws:

IOException - if the provided environment is not an instance of RegionCoprocessorEnvironment

stop

public void stop(CoprocessorEnvironment env)
          throws IOException

Description copied from interface: Coprocessor

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

Specified by:

stop in interface Coprocessor

Throws:

IOException

constructRowProcessorFromRequest

RowProcessor<S,T> constructRowProcessorFromRequest(org.apache.hadoop.hbase.protobuf.generated.RowProcessorProtos.ProcessRequest request)
                                            throws IOException

Throws:

IOException