org.apache.hadoop.hbase.coprocessor

Interface BulkLoadObserver

All Superinterfaces:

Coprocessor

All Known Implementing Classes:

AccessController

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
 @InterfaceStability.Evolving
public interface BulkLoadObserver
extends Coprocessor

Coprocessors implement this interface to observe and mediate bulk load operations.

Exception Handling

For all functions, exception handling is done as follows:

• Exceptions of type IOException are reported back to client.
• For any other kind of exception:
  • If the configuration CoprocessorHost.ABORT_ON_ERROR_KEY is set to true, then the server aborts.
  • Otherwise, coprocessor is removed from the server and DoNotRetryIOException is returned to the client.

Nested Class Summary

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

Coprocessor.State

Field Summary

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

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Method Summary

Modifier and Type	Method and Description
default void	preCleanupBulkLoad(ObserverContext<RegionCoprocessorEnvironment> ctx, org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.CleanupBulkLoadRequest request) Called as part of SecureBulkLoadEndpoint.cleanupBulkLoad() RPC call.
default void	prePrepareBulkLoad(ObserverContext<RegionCoprocessorEnvironment> ctx, org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.PrepareBulkLoadRequest request) Called as part of SecureBulkLoadEndpoint.prepareBulkLoad() RPC call.

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

start, stop

Method Detail

prePrepareBulkLoad

default void prePrepareBulkLoad(ObserverContext<RegionCoprocessorEnvironment> ctx,
                                org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.PrepareBulkLoadRequest request)
                         throws IOException

Called as part of SecureBulkLoadEndpoint.prepareBulkLoad() RPC call. It can't bypass the default action, e.g., ctx.bypass() won't have effect.

Parameters:

ctx - the environment to interact with the framework and master

Throws:

IOException

preCleanupBulkLoad

default void preCleanupBulkLoad(ObserverContext<RegionCoprocessorEnvironment> ctx,
                                org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.CleanupBulkLoadRequest request)
                         throws IOException

Called as part of SecureBulkLoadEndpoint.cleanupBulkLoad() RPC call. It can't bypass the default action, e.g., ctx.bypass() won't have effect.

Parameters:

ctx - the environment to interact with the framework and master

Throws:

IOException