Package org.duracloud.snapshot.service

Interface SnapshotJobManager

public interface SnapshotJobManager

An interface defining the interaction between the REST api and job engine. Primary function is to hide the details of the underlying job processing subsystem.

Author:

Daniel Bernstein Date: Feb 11, 2014

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_LAUNCHER_KEY
static final String	JOB_REPOSITORY_KEY

Method Summary

Modifier and Type	Method	Description
void	cancelRestore(String restoreId)	Stops the restore process and removes source content and destination space.
void	cancelSnapshot(String snapshotId)	Cancels a snapshot
org.springframework.batch.core.BatchStatus	executeRestoration(String restorationId)
org.springframework.batch.core.BatchStatus	executeSnapshot(String snapshotId)	This method creates an underlying job and executes it.
SnapshotJobManagerConfig	getConfig()	Access the snapshot job manager configuration.
org.springframework.batch.core.BatchStatus	getStatus(String snapshotId)
void	init(SnapshotJobManagerConfig duracloudCredential)	Lazily initializes the component.
boolean	isInitialized()
Restoration	stopRestore(String restoreId)	Stops the restore process but leaves underlying file system and destination space intact.

Field Details

JOB_REPOSITORY_KEY

static final String JOB_REPOSITORY_KEY

See Also:

• Constant Field Values

JOB_LAUNCHER_KEY

static final String JOB_LAUNCHER_KEY

See Also:

• Constant Field Values

Method Details

init

void init(SnapshotJobManagerConfig duracloudCredential)
   throws AlreadyInitializedException

Lazily initializes the component. The data source must be fully configured when this method is called; otherwise it will fail.

Parameters:

duracloudCredential -

Throws:

AlreadyInitializedException - if the service is already initialized.

isInitialized

boolean isInitialized()

Returns:

true if the service is already initialized.

executeSnapshot

org.springframework.batch.core.BatchStatus executeSnapshot(String snapshotId)
                                                    throws SnapshotException

This method creates an underlying job and executes it.

Parameters:

snapshotId -

Returns:

Throws:

SnapshotException

getStatus

org.springframework.batch.core.BatchStatus getStatus(String snapshotId)
                                              throws SnapshotNotFoundException,
SnapshotException

Parameters:

snapshotId -

Returns:

Throws:

SnapshotNotFoundException

SnapshotException

executeRestoration

org.springframework.batch.core.BatchStatus executeRestoration(String restorationId)
                                                       throws SnapshotException

Parameters:

restorationId -

Returns:

Throws:

SnapshotException

cancelSnapshot

void cancelSnapshot(String snapshotId)
             throws SnapshotException

Cancels a snapshot

Parameters:

snapshotId -

Throws:

SnapshotException

cancelRestore

void cancelRestore(String restoreId)
            throws SnapshotException

Stops the restore process and removes source content and destination space. Cancels a restore

Parameters:

restoreId -

Throws:

SnapshotException

stopRestore

Restoration stopRestore(String restoreId)
                 throws SnapshotException

Stops the restore process but leaves underlying file system and destination space intact.

Parameters:

restoreId -

Returns:

Throws:

SnapshotException

getConfig

SnapshotJobManagerConfig getConfig()

Access the snapshot job manager configuration.

Returns:

the config object