org.duracloud.snapshot.service.RestoreManager Maven / Gradle / Ivy

Go to download
/*
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 *     http://duracloud.org/license/
 */
package org.duracloud.snapshot.service;

import org.duracloud.snapshot.SnapshotException;
import org.duracloud.snapshot.SnapshotInProcessException;
import org.duracloud.snapshot.SnapshotNotFoundException;
import org.duracloud.snapshot.db.model.DuracloudEndPointConfig;
import org.duracloud.snapshot.db.model.Restoration;
import org.duracloud.snapshot.db.model.Snapshot;
import org.duracloud.snapshot.dto.RestoreStatus;

/**
 * @author Daniel Bernstein
 *         Date: Jul 15, 2014
 */
public interface RestoreManager {
    
    /**
     * 
     * @param config
     * @param jobManager
     */
    void init(RestoreManagerConfig config, SnapshotJobManager jobManager);
    
    /**
     * Initiates the restoration of a snapshot.
     * @param snapshotId
     * @param destination
     * @param userEmail
     * @return
     * @throws SnapshotNotFoundException
     * @throws SnapshotInProcessException
     * @throws SnapshotException
     */
    Restoration restoreSnapshot(String snapshotId,
                                DuracloudEndPointConfig destination,
                                String userEmail)
        throws SnapshotNotFoundException,
            SnapshotInProcessException,
            SnapshotException;

    /**
     * Sends an email request to duracloud admin to restore a space.
     * @param snapshotId
     * @param destination The destination where the restore should occur.
     * @param userEmail email to notify when restore starts and ends.
     * @return snapshot to be restored
     * @throws SnapshotNotFoundException
     */
    Snapshot requestRestoreSnapshot(String snapshotId,
                                DuracloudEndPointConfig destination,
                                String userEmail)
        throws SnapshotException;
    
    /**
     * Called by the process responsible for performing the restoration from 
     * DPN to Bridge Storage upon completion of the transfer.
     * 
     * @param restorationId
     * @return
     * @throws SnapshotNotFoundException
     * @throws SnapshotInProcessException
     * @throws NoRestorationInProcessException
     * @throws SnapshotException
     */
    Restoration restoreCompleted(String restorationId)
        throws SnapshotNotFoundException,
            SnapshotInProcessException,
            NoRestorationInProcessException,
            SnapshotException;

    /**
     * @param restorationId
     * @return
     */
    Restoration get(String restorationId) throws RestorationNotFoundException;

    /**
     * Transition the workflow status of the restore activity to a new status
     *
     * @param restorationId
     * @param status
     * @param message
     * @return
     */
    public Restoration transitionRestoreStatus(String restorationId,
                                               RestoreStatus status,
                                               String message)
        throws InvalidStateTransitionException, RestorationNotFoundException;

    /**
     * Retrieves a restoration based on the ID of the snapshot being restored
     *
     * @param snapshotId
     * @return
     */
    public Restoration getBySnapshotId(String snapshotId)
        throws RestorationNotFoundException;

    /**
     * Look for restorations which have expired, and perform final cleanup actions
     */
    public void finalizeRestores();
    
    /**
     * Cancels a restore.
     * @param restoreId
     * @throws SnapshotException 
     */
    public void cancelRestore(String restoreId) throws SnapshotException;
    
    /**
     * Restarts a restore.  Assumes that the DPN transfer was successful.
     * @param restoreId
     * @throws SnapshotException
     */
    public Restoration restartRestore(String restoreId) throws SnapshotException;
}