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.backup;
019
020import java.io.IOException;
021import org.apache.hadoop.conf.Configurable;
022import org.apache.hadoop.conf.Configuration;
023import org.apache.hadoop.hbase.backup.impl.BackupManager;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * Backup copy job is a part of a backup process. The concrete implementation is responsible for
028 * copying data from a cluster to backup destination. Concrete implementation is provided by backup
029 * provider, see {@link BackupRestoreFactory}
030 */
031@InterfaceAudience.Private
032public interface BackupCopyJob extends Configurable {
033  /**
034   * Copy backup data to destination
035   * @param backupInfo    context object
036   * @param backupManager backup manager
037   * @param conf          configuration
038   * @param backupType    backup type (FULL or INCREMENTAL)
039   * @param options       array of options (implementation-specific)
040   * @return result (0 - success, -1 failure )
041   * @throws IOException exception
042   */
043  int copy(BackupInfo backupInfo, BackupManager backupManager, Configuration conf,
044    BackupType backupType, String[] options) throws IOException;
045
046  /**
047   * Cancel copy job
048   * @param jobHandler backup copy job handler
049   * @throws IOException if cancelling the jobs fails
050   */
051  void cancel(String jobHandler) throws IOException;
052}