com.bigdata.journal

Class BasicSnapshotFactory

java.lang.Object

com.bigdata.journal.BasicSnapshotFactory

All Implemented Interfaces:

ISnapshotFactory

public class BasicSnapshotFactory
extends Object
implements ISnapshotFactory

Provides a basic implementation of a ISnapshotFactory to be used with non-HA operations to provide online backup capabilities. This is exposed via the REST API via the StatusServlet.

Author:

beebs

Constructor Summary

Constructors

Constructor and Description
BasicSnapshotFactory()
BasicSnapshotFactory(String file, boolean compress)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getAbsolutePath(String file) Utility to get the absolute path of a file if passed a relative one.
boolean	getCompress() When true the generated snapshot will be compressed.
String	getFile()
File	getSnapshotFile(IRootBlockView rbv) For the default implementation don't append the commit point to the file.
void	setCompress(boolean compress)
void	setFile(String file)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicSnapshotFactory

public BasicSnapshotFactory(String file,
                    boolean compress)

BasicSnapshotFactory

public BasicSnapshotFactory()

Method Detail

getFile

public String getFile()

setFile

public void setFile(String file)

setCompress

public void setCompress(boolean compress)

getAbsolutePath

protected String getAbsolutePath(String file)

Utility to get the absolute path of a file if passed a relative one.

Parameters:

file -

Returns:

getSnapshotFile

public File getSnapshotFile(IRootBlockView rbv)
                     throws IOException

For the default implementation don't append the commit point to the file. In non-HA mode, the system does not have the responsibility to manage and restore from snapshots. That is accomplished by operations and procedures around the deployment of the non-HA service.

Specified by:

getSnapshotFile in interface ISnapshotFactory

Parameters:

rbv - The current root block. The snapshot will be consistent as of the commit point associated with this root block.

Returns:

The file on which the snapshot will be written. If the file exists, then it must be empty. If the file is in a directory, the directory must exist and must be writable.

Throws:

IOException

See Also:

CommitCounterUtility

getCompress

public boolean getCompress()

Description copied from interface: ISnapshotFactory

When true the generated snapshot will be compressed.

Specified by:

getCompress in interface ISnapshotFactory