001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.procedure;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022/**
023 * Task builder to build instances of a {@link ProcedureMember}'s {@link Subprocedure}s.
024 */
025@InterfaceAudience.Private
026public interface SubprocedureFactory {
027
028  /**
029   * Build {@link Subprocedure} when requested.
030   * @param procName name of the procedure associated with this subprocedure
031   * @param procArgs arguments passed from the coordinator about the procedure
032   * @return {@link Subprocedure} to run or <tt>null</tt> if the no operation should be run
033   * @throws IllegalArgumentException if the operation could not be run because of errors in the
034   *                                  request
035   * @throws IllegalStateException    if the current runner cannot accept any more new requests
036   */
037  Subprocedure buildSubprocedure(String procName, byte[] procArgs);
038}