View Javadoc

1   /*
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   * http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  
20  package org.apache.hadoop.hbase.coprocessor;
21  
22  import java.io.IOException;
23  
24  import org.apache.hadoop.hbase.Coprocessor;
25  import org.apache.hadoop.hbase.HBaseInterfaceAudience;
26  import org.apache.hadoop.hbase.classification.InterfaceAudience;
27  import org.apache.hadoop.hbase.classification.InterfaceStability;
28  import org.apache.hadoop.hbase.protobuf.generated.SecureBulkLoadProtos.CleanupBulkLoadRequest;
29  import org.apache.hadoop.hbase.protobuf.generated.SecureBulkLoadProtos.PrepareBulkLoadRequest;
30  
31  /**
32   * Coprocessors implement this interface to observe and mediate bulk load operations.
33   */
34  @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
35  @InterfaceStability.Evolving
36  public interface BulkLoadObserver extends Coprocessor {
37      /**
38        * Called as part of SecureBulkLoadEndpoint.prepareBulkLoad() RPC call.
39        * It can't bypass the default action, e.g., ctx.bypass() won't have effect.
40        * @param ctx the environment to interact with the framework and master
41        * @throws IOException
42        */
43      void prePrepareBulkLoad(ObserverContext<RegionCoprocessorEnvironment> ctx,
44                              PrepareBulkLoadRequest request) throws IOException;
45  
46      /**
47        * Called as part of SecureBulkLoadEndpoint.cleanupBulkLoad() RPC call.
48        * It can't bypass the default action, e.g., ctx.bypass() won't have effect.
49        * @param ctx the environment to interact with the framework and master
50        * @throws IOException
51        */
52      void preCleanupBulkLoad(ObserverContext<RegionCoprocessorEnvironment> ctx,
53                              CleanupBulkLoadRequest request) throws IOException;
54  }