Package com.tangosol.persistence

Class DirectorySnapshotArchiver

java.lang.Object

com.tangosol.persistence.AbstractSnapshotArchiver

com.tangosol.persistence.DirectorySnapshotArchiver

All Implemented Interfaces:

SnapshotArchiver

public class DirectorySnapshotArchiver
extends AbstractSnapshotArchiver

An implementation of a SnapshotArchiver that uses a shared directory to store archived snapshots.

Since:

12.2.1

Author:

tam 2014.08.19

Field Summary

Fields inherited from class com.tangosol.persistence.AbstractSnapshotArchiver

f_sClusterName, f_sServiceName, m_cMillisLastStart, m_cMillisMax, m_cMillisMin, m_cMillisTotal

Constructor Summary

Constructors

Constructor	Description
DirectorySnapshotArchiver(String sClusterName, String sServiceName, File fileDirectory)	Constructs a new DirectorySnapshotArchiver which uses a shared directory available from all members to store archived snapshots.

Method Summary

Modifier and Type	Method	Description
protected void	archiveInternal(Snapshot snapshot, com.oracle.coherence.persistence.PersistenceManager<ReadBuffer> mgr)	Internal implementation to Archive the specified snapshot.
protected Properties	getMetadata(String sSnapshot)	Internal implementation to retrieve the metadata stored for the archived snapshot.
File	getSharedDirectoryPath()	The shared directory to write archives to.
protected boolean	isEmpty(String sSnapshot, String sStore)	Internal implementation to check if the specified archived store is empty.
protected String[]	listInternal()	Internal implementation to return the identifiers of the archived snapshots known to this archiver.
protected String[]	listStoresInternal(String sSnapshot)	List the stores for a given snapshot.
protected boolean	removeInternal(String sSnapshot)	Internal implementation to remove the specified archived snapshot.
protected void	retrieveInternal(Snapshot snapshot, com.oracle.coherence.persistence.PersistenceManager<ReadBuffer> mgr)	Internal implementation to retrieve the specified snapshot.
String	toString()

Methods inherited from class com.tangosol.persistence.AbstractSnapshotArchiver

archive, createTempEnvironment, displayStatistics, get, getPersistenceTools, hasArchivedSnapshot, hasLocalSnapshot, instantiatePersistenceTools, list, recordEndTime, recordStartTime, remove, resetStatistics, retrieve, writeMetadata

Methods inherited from class java.lang.Object

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

Constructor Details

DirectorySnapshotArchiver

public DirectorySnapshotArchiver(String sClusterName,
 String sServiceName,
 File fileDirectory)
                          throws IOException

Constructs a new DirectorySnapshotArchiver which uses a shared directory available from all members to store archived snapshots.

Parameters:

sClusterName - the name of the cluster

sServiceName - the service name

fileDirectory - a shared directory available from all members

Throws:

IOException - if errors creating directories

Method Details

listInternal

protected String[] listInternal()

Description copied from class: AbstractSnapshotArchiver

Internal implementation to return the identifiers of the archived snapshots known to this archiver.

Specified by:

listInternal in class AbstractSnapshotArchiver

Returns:

a list of the known archived snapshot identifiers

archiveInternal

protected void archiveInternal(Snapshot snapshot,
 com.oracle.coherence.persistence.PersistenceManager<ReadBuffer> mgr)

Description copied from class: AbstractSnapshotArchiver

Internal implementation to Archive the specified snapshot.

Specified by:

archiveInternal in class AbstractSnapshotArchiver

Parameters:

snapshot - the snapshot to archive

mgr - the PersistenceManager used to read the stores from

retrieveInternal

protected void retrieveInternal(Snapshot snapshot,
 com.oracle.coherence.persistence.PersistenceManager<ReadBuffer> mgr)

Description copied from class: AbstractSnapshotArchiver

Internal implementation to retrieve the specified snapshot.

Specified by:

retrieveInternal in class AbstractSnapshotArchiver

Parameters:

snapshot - the snapshot to retrieve

mgr - the PersistenceManager used to write the stores to

removeInternal

protected boolean removeInternal(String sSnapshot)

Description copied from class: AbstractSnapshotArchiver

Internal implementation to remove the specified archived snapshot. (Called by JMX operation removeArchivedSnapshot)

Specified by:

removeInternal in class AbstractSnapshotArchiver

Parameters:

sSnapshot - the snapshot name to remove

Returns:

true if the snapshot was removed

listStoresInternal

protected String[] listStoresInternal(String sSnapshot)

Description copied from class: AbstractSnapshotArchiver

List the stores for a given snapshot.

Specified by:

listStoresInternal in class AbstractSnapshotArchiver

Parameters:

sSnapshot - the snapshot name to list stores for

Returns:

a String[] of store names

getMetadata

protected Properties getMetadata(String sSnapshot)
                          throws IOException

Description copied from class: AbstractSnapshotArchiver

Internal implementation to retrieve the metadata stored for the archived snapshot.

Specified by:

getMetadata in class AbstractSnapshotArchiver

Parameters:

sSnapshot - the snapshot name to retrieve metadata

Returns:

the metadata for the archived snapshot

Throws:

IOException - if any I/O related problems

isEmpty

protected boolean isEmpty(String sSnapshot,
 String sStore)

Description copied from class: AbstractSnapshotArchiver

Internal implementation to check if the specified archived store is empty.

Specified by:

isEmpty in class AbstractSnapshotArchiver

Parameters:

sSnapshot - the snapshot name

sStore - the store name

Returns:

true if the store is empty

toString

public String toString()

Description copied from class: AbstractSnapshotArchiver

Overrides:

toString in class AbstractSnapshotArchiver

getSharedDirectoryPath

public File getSharedDirectoryPath()

The shared directory to write archives to.

Returns:

shared directory to write archives to.