View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.procedure;
19  
20  import org.apache.hadoop.classification.InterfaceAudience;
21  
22  /**
23   * Task builder to build instances of a {@link ProcedureMember}'s {@link Subprocedure}s.
24   */
25  @InterfaceAudience.Private
26  public interface SubprocedureFactory {
27  
28    /**
29     * Build {@link Subprocedure} when requested.
30     * @param procName name of the procedure associated with this subprocedure
31     * @param procArgs  arguments passed from the coordinator about the procedure
32     * @return {@link Subprocedure} to run or <tt>null</tt> if the no operation should be run
33     * @throws IllegalArgumentException if the operation could not be run because of errors in the
34     *           request
35     * @throws IllegalStateException if the current runner cannot accept any more new requests
36     */
37    Subprocedure buildSubprocedure(String procName, byte[] procArgs);
38  }