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  
19  package org.apache.hadoop.hbase.backup;
20  
21  import java.io.IOException;
22  
23  import org.apache.hadoop.conf.Configurable;
24  import org.apache.hadoop.conf.Configuration;
25  import org.apache.hadoop.hbase.backup.impl.BackupManager;
26  import org.apache.hadoop.hbase.classification.InterfaceAudience;
27  import org.apache.hadoop.hbase.classification.InterfaceStability;
28  
29  @InterfaceAudience.Private
30  @InterfaceStability.Evolving
31  public interface BackupCopyService extends Configurable {
32    static enum Type {
33      FULL, INCREMENTAL
34    }
35  
36    /**
37     * Copy backup data
38     * @param backupContext - context
39     * @param backupManager  - manager
40     * @param conf - configuration
41     * @param copyType - copy type
42     * @param options - array of options (implementation-specific)
43     * @return result (0 - success)
44     * @throws IOException
45     */
46    public int copy(BackupInfo backupContext, BackupManager backupManager, Configuration conf,
47        BackupCopyService.Type copyType, String[] options) throws IOException;
48    
49  
50     /**
51      * Cancel copy job
52      * @param jobHandler - copy job handler
53      * @throws IOException
54      */
55     public void cancelCopyJob(String jobHandler) throws IOException;  
56  }