ehcache-core 2.10.9.2 · net.sf.ehcache.terracotta.RotatingSnapshotFile

Field Summary

Modifier and Type	Field and Description
private final String	cacheName
private final ClassLoader	classLoader
private final DiskStorePathManager	diskStorePathManager
private static final Logger	LOG
private final Lock	readLock
private volatile boolean	shutdownOnThreadInterrupted
private static final String	SUFFIX_MOVE
private static final String	SUFFIX_OK
private static final String	SUFFIX_PROGRESS
private final Lock	writeLock

Constructor Summary

Access	Constructor and Description
pack-priv	RotatingSnapshotFile(final DiskStorePathManager diskStorePathManager, final String use as base name of the files cacheName, final ClassLoader classLoader) Constructor

Method Summary

Modifier and Type	Method and Description
private void	cleanUp()
private void	cleanUp(final File inProgress)
private void	closeAndDeleteAssociatedFileOnFailure(final FileInputStream fis, final File associatedFile)
pack-priv File	Returns: the file to read from currentSnapshotFile() Creates a File representing the uncorrupted file on disk
pack-priv File	Returns: the File to write to newSnapshotFile() Creates a File representing the one to write new entries to
pack-priv < the type of the each element T> Set<T>	Returns: the Set of all entries in the latest uncorrupted file on disk readAll() Reads all the keys from the file on disk, doing cleanup if required of previously unterminated file written to
private boolean	requiresCleanUp()
pack-priv void	setShutdownOnThreadInterrupted(final boolean true, if shutdown needs to happen in the middle of a write shutdownOnThreadInterrupted) Whether to shutdown as soon as the writer Thread is interrupted, or to let all keys be written to disk first
pack-priv void	snapshotNowOrWaitForCurrentToFinish(final Set<E> the latest current local set localKeys) Calling this method will result in writing all keys to be written to disk or wait for the one in progress to finish
private void	swapForOldWithNewSnapshot(final File inProgress)
pack-priv File	Returns: the File representing the previous successful snapshot (temp file to be deleted) tempSnapshotFile() Creates a File representing the old uncorrupted file, when the new one has successfully been written to disk
pack-priv void	writeAll(final Iterable<T> the iterable of entries to write to disk localKeys) Writes all values of the iterable to a new file and does the necessary clean up when done

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cacheName	back to summary
private final String cacheName

classLoader	back to summary
private final ClassLoader classLoader

diskStorePathManager	back to summary
private final DiskStorePathManager diskStorePathManager

LOG	back to summary
private static final Logger LOG

readLock	back to summary
private final Lock readLock

shutdownOnThreadInterrupted	back to summary
private volatile boolean shutdownOnThreadInterrupted

SUFFIX_MOVE	back to summary
private static final String SUFFIX_MOVE

SUFFIX_OK	back to summary
private static final String SUFFIX_OK

SUFFIX_PROGRESS	back to summary
private static final String SUFFIX_PROGRESS

writeLock	back to summary
private final Lock writeLock

Constructor Detail

RotatingSnapshotFile	back to summary
pack-priv RotatingSnapshotFile(final DiskStorePathManager diskStorePathManager, final String cacheName, final ClassLoader classLoader) Constructor Parameters cacheName:String use as base name of the files

RotatingSnapshotFile

back to summary

pack-priv RotatingSnapshotFile(final DiskStorePathManager diskStorePathManager, final String cacheName, final ClassLoader classLoader)

Constructor

Parameters

cacheName:String: use as base name of the files

Method Detail

cleanUp	back to summary
private void cleanUp()

cleanUp	back to summary
private void cleanUp(final File inProgress)

closeAndDeleteAssociatedFileOnFailure	back to summary
private void closeAndDeleteAssociatedFileOnFailure(final FileInputStream fis, final File associatedFile)

currentSnapshotFile	back to summary
pack-priv File currentSnapshotFile() Creates a File representing the uncorrupted file on disk Returns:File the file to read from

currentSnapshotFile

back to summary

pack-priv File currentSnapshotFile()

Creates a File representing the uncorrupted file on disk

Returns:File: the file to read from

newSnapshotFile	back to summary
pack-priv File newSnapshotFile() Creates a File representing the one to write new entries to Returns:File the File to write to

newSnapshotFile

back to summary

pack-priv File newSnapshotFile()

Creates a File representing the one to write new entries to

Returns:File: the File to write to

readAll	back to summary
pack-priv <T> Set<T> readAll() throws IOException Reads all the keys from the file on disk, doing cleanup if required of previously unterminated file written to Parameters <T> the type of the each element Returns:Set<T> the Set of all entries in the latest uncorrupted file on disk Exceptions IOException: If the underlying FileInputStream does throw

readAll

back to summary

pack-priv <T> Set<T> readAll() throws IOException

Reads all the keys from the file on disk, doing cleanup if required of previously unterminated file written to

Parameters

<T>: the type of the each element

Returns:Set<T>

the Set of all entries in the latest uncorrupted file on disk

Exceptions

IOException:: If the underlying FileInputStream does throw

requiresCleanUp	back to summary
private boolean requiresCleanUp()

setShutdownOnThreadInterrupted	back to summary
pack-priv void setShutdownOnThreadInterrupted(final boolean shutdownOnThreadInterrupted) Whether to shutdown as soon as the writer Thread is interrupted, or to let all keys be written to disk first Parameters shutdownOnThreadInterrupted:boolean true, if shutdown needs to happen in the middle of a write

setShutdownOnThreadInterrupted

back to summary

pack-priv void setShutdownOnThreadInterrupted(final boolean shutdownOnThreadInterrupted)

Whether to shutdown as soon as the writer Thread is interrupted, or to let all keys be written to disk first

Parameters

shutdownOnThreadInterrupted:boolean: true, if shutdown needs to happen in the middle of a write

snapshotNowOrWaitForCurrentToFinish	back to summary
pack-priv void snapshotNowOrWaitForCurrentToFinish(final Set<E> localKeys) throws IOException Calling this method will result in writing all keys to be written to disk or wait for the one in progress to finish Parameters localKeys:Set<E> the latest current local set Exceptions IOException: On exception being thrown while doing the snapshot

snapshotNowOrWaitForCurrentToFinish

back to summary

pack-priv void snapshotNowOrWaitForCurrentToFinish(final Set<E> localKeys) throws IOException

Calling this method will result in writing all keys to be written to disk or wait for the one in progress to finish

Parameters

localKeys:Set<E>: the latest current local set

Exceptions

IOException:: On exception being thrown while doing the snapshot

swapForOldWithNewSnapshot	back to summary
private void swapForOldWithNewSnapshot(final File inProgress)

tempSnapshotFile	back to summary
pack-priv File tempSnapshotFile() Creates a File representing the old uncorrupted file, when the new one has successfully been written to disk Returns:File the File representing the previous successful snapshot (temp file to be deleted)

tempSnapshotFile

back to summary

pack-priv File tempSnapshotFile()

Creates a File representing the old uncorrupted file, when the new one has successfully been written to disk

Returns:File: the File representing the previous successful snapshot (temp file to be deleted)

writeAll	back to summary
pack-priv void writeAll(final Iterable<T> localKeys) throws IOException Writes all values of the iterable to a new file and does the necessary clean up when done Parameters localKeys:Iterable<T> the iterable of entries to write to disk Exceptions IOException: If the underlying OutputStream do throw

writeAll

back to summary

pack-priv void writeAll(final Iterable<T> localKeys) throws IOException

Writes all values of the iterable to a new file and does the necessary clean up when done

Parameters

localKeys:Iterable<T>: the iterable of entries to write to disk

Exceptions

IOException:: If the underlying OutputStream do throw

pack-priv Class RotatingSnapshotFile

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail