/*
 * Copyright (c) 2014 EMC Corporation
 * All Rights Reserved
 */

package com.emc.storageos.management.backup;

import com.emc.storageos.management.backup.exceptions.BackupException;

import java.io.File;

public abstract class BackupHandler {

    protected BackupType backupType;
    protected BackupContext backupContext;

    /**
     * Gets backup data type
     */
    public BackupType getBackupType() {
        return backupType;
    }

    /**
     * Sets backup data type
     * 
     * @param backupType
     *            The type of backup data
     */
    public void setBackupType(BackupType backupType) {
        this.backupType = backupType;
    }

    /**
     * Gets backup context
     */
    public BackupContext getBackupContext() {
        return this.backupContext;
    }

    /**
     * Sets backup context
     * 
     * @param backupContext
     */
    public void setBackupContext(BackupContext backupContext) {
        this.backupContext = backupContext;
    }

    /**
     * Checks that it is necessary to backup or not
     * 
     * @return execute backup if true, nothing to do else
     */
    public abstract boolean isNeed();

    /**
     * Creates local backup, such as DB snapshot, ZK snapshot & txn logs.
     * 
     * @param backupTag
     *            The name of this backup
     * @return full backup name
     */
    public abstract String createBackup(final String backupTag);

    /**
     * Moves backup files to specified location
     * 
     * @param backupTag
     *            The name of this backup
     * @param fullBackupTag
     *            The snapshot which will be dumped
     * @return The zip file to contain snapshot files
     */
    public abstract File dumpBackup(final String backupTag, final String fullBackupTag);

    /**
     * Check backup file is exist or not
     * 
     * @param backupTag
     *            The name of backup
     * @param fullBackupTag
     *            The name of the backup file
     */
    protected void checkBackupFileExist(final String backupTag, final String fullBackupTag) {
        File backupFolder = new File(backupContext.getBackupDir(), backupTag);
        if (!backupFolder.exists()) {
            return;
        }
        File backupFile = new File(backupFolder, fullBackupTag + BackupConstants.COMPRESS_SUFFIX);
        if (backupFile.exists()) {
            throw BackupException.fatals.backupFileAlreadyExist(backupFile.getName());
        }
    }
}