AbstractPersistenceManager (Oracle® Coherence Java API Reference)

java.lang.Object
- com.tangosol.util.Base
- - com.tangosol.persistence.AbstractPersistenceManager<PS>

Type Parameters:

PS - the type of AbstractPersistentStore

All Implemented Interfaces:

com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
```
public abstract class AbstractPersistenceManager<PS extends AbstractPersistenceManager.AbstractPersistentStore>
extends Base
implements com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
```
Abstract implementation of a ReadBuffer-based PersistentManager.

Author:

jh 2012.10.04

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractPersistenceManager.AbstractPersistenceSnapshotTools` Abstract implementation of PersistenceTools which can be extended to support local snapshot operations for specific implementations.
`class`	`AbstractPersistenceManager.AbstractPersistentStore` Abstract implementation of a ReadBuffer-based PersistentStore.
`class`	`AbstractPersistenceManager.Task` Runnable extension that adds the ability to notify the task that it has been canceled.

Nested classes/interfaces inherited from class com.tangosol.util.Base
Base.LoggingWriter, Base.StackFrame

Field Summary

Fields
Modifier and Type	Field and Description
`protected File`	`f_dirActive` The directory used to store persisted data.
`protected File`	`f_dirLock` The directory used to store lock files (to protect against multi-process file system clean up).
`protected File`	`f_dirTrash` The directory used to store "safe-deleted" data.
`protected Map<String,PS>`	`f_mapStores` Map of open AbstractPersistentStore instances.
`protected Set<AbstractPersistenceManager.Task>`	`f_setTasks` Set of outstanding tasks.
`protected String`	`f_sName` The name of this AbstractPersistenceManager.
`protected AbstractPersistenceEnvironment`	`m_env` The environment that created this AbstractPersistenceManager.
`protected com.tangosol.internal.util.DaemonPool`	`m_pool` An optional DaemonPool used to execute tasks.
`protected static long[]`	`NO_LONGS` An empty long array (by definition immutable).
`protected static String[]`	`NO_STRINGS` An empty String array (by definition immutable).

Fields inherited from class com.tangosol.util.Base
LOG_ALWAYS, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Constructor Summary

Constructors
Constructor and Description

AbstractPersistenceManager(File fileData, File fileTrash, String sName)
Create a new AbstractPersistenceManager.

Constructors
Constructor and Description
`AbstractPersistenceManager(File fileData, File fileTrash, String sName)` Create a new AbstractPersistenceManager.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close(String sId)` Close the associated PersistentStore and release exclusive access to the associated resources.
`boolean`	`delete(String sId, boolean fSafe)` Remove the PersistentStore associated with the specified identifier.
`protected com.oracle.datagrid.persistence.PersistenceException`	`ensurePersistenceException(Throwable eCause)` Return a PersistenceException with the given cause.
`protected com.oracle.datagrid.persistence.PersistenceException`	`ensurePersistenceException(Throwable eCause, String sMessage)` Return a PersistenceException with the given cause and detail message.
`protected void`	`executeTask(AbstractPersistenceManager.Task task)` Execute the specified task with the calling thread.
`protected void`	`executeTaskExclusive(AbstractPersistenceManager.Task task)` Execute the specified task with the calling thread.
`com.tangosol.internal.util.DaemonPool`	`getDaemonPool()` Return the optional DaemonPool used to execute tasks.
`File`	`getDataDirectory()` Return the directory used to store persisted data.
`protected abstract int`	`getImplVersion()` Return the implementation version of this manager.
`protected File`	`getLockDirectory()` Return the directory used to store lock files.
`protected Properties`	`getMetadata()` Return metadata for this manager.
`String`	`getName()` Return the name of this manager.
`protected AbstractPersistenceEnvironment`	`getPersistenceEnvironment()` Return the environment that created this manager.
`com.oracle.datagrid.persistence.PersistenceTools`	`getPersistenceTools()` Return an instance of `PersistenceTools` allowing offline operations to be performed against the associated PersistenceManager and appropriate `PersistentStore`.
`Map<String,PS>`	`getPersistentStoreMap()` Return the map of open PersistentStore instances keyed by their identifiers.
`protected abstract String`	`getStorageFormat()` Return the storage format used by this manager.
`protected abstract int`	`getStorageVersion()` Return the version of the storage format used by this manager.
`File`	`getTrashDirectory()` Return the directory used to store "safe-deleted" persisted data.
`protected abstract com.oracle.datagrid.persistence.PersistenceTools`	`instantiatePersistenceTools(com.oracle.datagrid.persistence.OfflinePersistenceInfo info)` Factory method to create a `PersistenceTools` implementation.
`protected abstract PS`	`instantiatePersistentStore(String sId)` Factory method for PersistentStore implementations managed by this PersistenceManager.
`protected boolean`	`isMetadataCompatible(Properties prop)` Determine if the given metadata is compatible with this manager.
`protected boolean`	`isMetadataComplete(Properties prop)` Determine if the given metadata in the `Properties` is complete.
`String[]`	`list()` Return the identifiers of the PersistentStores known to this manager.
`String[]`	`listOpen()` Return the identifiers of PersistentStores that are currently open.
`com.oracle.datagrid.persistence.PersistentStore<ReadBuffer>`	`open(String sId)` Open or create a PersistentStore associated with the specified identifier.
`void`	`read(String sId, InputStream in)` Read the PersistenceStore associated with the specified identifier from the given input stream, making it available to this manager.
`protected Properties`	`readMetadata(File fileDir)` Read persistence metadata from the specified directory.
`void`	`release()` Release all resources held by this manager.
`void`	`setDaemonPool(com.tangosol.internal.util.DaemonPool pool)` Configure the DaemonPool used to execute tasks.
`protected void`	`setPersistenceEnvironment(AbstractPersistenceEnvironment env)` Configure the environment that created this manager.
`protected void`	`submitTask(AbstractPersistenceManager.Task task)` Submit the given task for execution by the daemon pool.
`String`	`toString()` Return a human readable description of this AbstractPersistenceManager.
`String`	`validatePersistentStoreId(String sId)` Validate that the given identifier can be used for a persistent store.
`void`	`write(String sId, OutputStream out)` Write the PersistentStore associated with the specified identifier to the given output stream.
`protected void`	`writeMetadata(File fileDir)` Write persistence metadata for this manager to the specified directory.

Methods inherited from class com.tangosol.util.Base
azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_LONGS
```
protected static final long[] NO_LONGS
```
    An empty long array (by definition immutable).
  - NO_STRINGS
```
protected static final String[] NO_STRINGS
```
    An empty String array (by definition immutable).
  - f_dirActive
```
protected final File f_dirActive
```
    The directory used to store persisted data.
  - f_dirTrash
```
protected final File f_dirTrash
```
    The directory used to store "safe-deleted" data.
  - f_dirLock
```
protected final File f_dirLock
```
    The directory used to store lock files (to protect against multi-process file system clean up).
  - f_sName
```
protected final String f_sName
```
    The name of this AbstractPersistenceManager.
  - f_mapStores
```
protected final Map<String,PS extends AbstractPersistenceManager.AbstractPersistentStore> f_mapStores
```
    Map of open AbstractPersistentStore instances.
  - f_setTasks
```
protected final Set<AbstractPersistenceManager.Task> f_setTasks
```
    Set of outstanding tasks.
  - m_env
```
protected AbstractPersistenceEnvironment m_env
```
    The environment that created this AbstractPersistenceManager.
  - m_pool
```
protected com.tangosol.internal.util.DaemonPool m_pool
```
    An optional DaemonPool used to execute tasks.
- Constructor Detail
  - AbstractPersistenceManager
```
public AbstractPersistenceManager(File fileData,
                                  File fileTrash,
                                  String sName)
                           throws IOException
```
    Create a new AbstractPersistenceManager.
    
    Parameters:
    
    fileData - the directory used to store persisted data
    
    fileTrash - an optional trash directory
    
    sName - an optional name to give the new manager
    
    Throws:
    
    IOException - on error creating the data or trash directory
- Method Detail
  - getName
```
public String getName()
```
    Return the name of this manager.
    
    Specified by:
    
    getName in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
    
    Returns:
    
    the name of this manager
  - open
```
public com.oracle.datagrid.persistence.PersistentStore<ReadBuffer> open(String sId)
```
    Open or create a PersistentStore associated with the specified identifier.
    
    Specified by:
    
    open in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
    
    Parameters:
    
    sId - a unique identifier for the store
    
    Returns:
    
    a PersistentStore associated with the specified identifier
  - close
```
public void close(String sId)
```
    Close the associated PersistentStore and release exclusive access to the associated resources.
    
    Specified by:
    
    close in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
    
    Parameters:
    
    sId - a unique identifier of the store to close
  - delete
```
public boolean delete(String sId,
                      boolean fSafe)
```
    Remove the PersistentStore associated with the specified identifier.
    
    Specified by:
    
    delete in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
    
    Parameters:
    
    sId - a unique identifier of the store to remove
    
    fSafe - if true, remove the store by moving it to a restorable location (if possible) rather than deleting it
    
    Returns:
    
    true if the store was successfully removed, false otherwise
  - list
```
public String[] list()
```
    Return the identifiers of the PersistentStores known to this manager.
    
    Specified by:
    
    list in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
    
    Returns:
    
    a list of the known store identifiers
  - listOpen
```
public String[] listOpen()
```
    Return the identifiers of PersistentStores that are currently open.
    
    Specified by:
    
    listOpen in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
    
    Returns:
    
    a list of the open store identifiers
  - read
```
public void read(String sId,
                 InputStream in)
          throws IOException
```
    Read the PersistenceStore associated with the specified identifier from the given input stream, making it available to this manager.
    
    Specified by:
    
    read in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
    
    Parameters:
    
    sId - a unique identifier of the store to read
    
    in - the stream to read from
    
    Throws:
    
    IOException - if an error occurred while reading from the stream
  - write
```
public void write(String sId,
                  OutputStream out)
           throws IOException
```
    Write the PersistentStore associated with the specified identifier to the given output stream.
    
    Specified by:
    
    write in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
    
    Parameters:
    
    sId - a unique identifier of the store to write
    
    out - the stream to write to
    
    Throws:
    
    IOException - if an error occurred while writing to the stream
  - release
```
public void release()
```
    Release all resources held by this manager. Note that the behavior of all other methods on this manager is undefined after this method is called.
    
    Specified by:
    
    release in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
  - getPersistenceTools
```
public com.oracle.datagrid.persistence.PersistenceTools getPersistenceTools()
```
    Description copied from interface: com.oracle.datagrid.persistence.PersistenceManager
    
    Return an instance of PersistenceTools allowing offline operations to be performed against the associated PersistenceManager and appropriate PersistentStore.
    
    Specified by:
    
    getPersistenceTools in interface com.oracle.datagrid.persistence.PersistenceManager<ReadBuffer>
    
    Returns:
    
    a PersistenceTools implementation
  - toString
```
public String toString()
```
    Return a human readable description of this AbstractPersistenceManager.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a human readable description
  - getMetadata
```
protected Properties getMetadata()
```
    Return metadata for this manager.
    
    Returns:
    
    the metadata for this manager
  - readMetadata
```
protected Properties readMetadata(File fileDir)
                           throws IOException
```
    Read persistence metadata from the specified directory.
    
    Parameters:
    
    fileDir - the directory to read metadata from
    
    Returns:
    
    the metadata
    
    Throws:
    
    IOException - on error reading the metadata file
  - writeMetadata
```
protected void writeMetadata(File fileDir)
                      throws IOException
```
    Write persistence metadata for this manager to the specified directory.
    
    Parameters:
    
    fileDir - the directory to write metadata to
    
    Throws:
    
    IOException - on error writing the metadata file
  - isMetadataComplete
```
protected boolean isMetadataComplete(Properties prop)
```
    Determine if the given metadata in the Properties is complete.
    
    Parameters:
    
    prop - the metadata to analyze
    
    Returns:
    
    true if the given metadata is complete; false otherwise
  - isMetadataCompatible
```
protected boolean isMetadataCompatible(Properties prop)
```
    Determine if the given metadata is compatible with this manager.
    
    Parameters:
    
    prop - the metadata to analyze
    
    Returns:
    
    true if the given metadata is compatible with this manager; false otherwise
  - getImplVersion
```
protected abstract int getImplVersion()
```
    Return the implementation version of this manager.
    
    Returns:
    
    the implementation version of this manager
  - getStorageFormat
```
protected abstract String getStorageFormat()
```
    Return the storage format used by this manager.
    
    Returns:
    
    the storage format used by this manager
  - getStorageVersion
```
protected abstract int getStorageVersion()
```
    Return the version of the storage format used by this manager.
    
    Returns:
    
    the version of the storage format used by this manager
  - ensurePersistenceException
```
protected com.oracle.datagrid.persistence.PersistenceException ensurePersistenceException(Throwable eCause)
```
    Return a PersistenceException with the given cause. The returned exception is also initialized with this manager and its environment (if available).
    
    Parameters:
    
    eCause - an optional cause
    
    Returns:
    
    a PersistenceException with the given cause
  - ensurePersistenceException
```
protected com.oracle.datagrid.persistence.PersistenceException ensurePersistenceException(Throwable eCause,
                                                                                          String sMessage)
```
    Return a PersistenceException with the given cause and detail message. The returned exception is also initialized with this manager and its environment (if available).
    
    Parameters:
    
    eCause - an optional cause
    
    sMessage - an optional detail message
    
    Returns:
    
    a PersistenceException with the given cause and detail message
  - validatePersistentStoreId
```
public String validatePersistentStoreId(String sId)
```
    Validate that the given identifier can be used for a persistent store.
    
    Parameters:
    
    sId - the identifier to check
    
    Returns:
    
    the validated identifier
  - submitTask
```
protected void submitTask(AbstractPersistenceManager.Task task)
```
    Submit the given task for execution by the daemon pool.
    
    Parameters:
    
    task - the task to submit
  - executeTask
```
protected void executeTask(AbstractPersistenceManager.Task task)
```
    Execute the specified task with the calling thread.
    
    Parameters:
    
    task - the task to execute
  - executeTaskExclusive
```
protected void executeTaskExclusive(AbstractPersistenceManager.Task task)
```
    Execute the specified task with the calling thread. No other access to this manager or any of its persistent stores is guaranteed to occur while the task is being executed.
    
    Parameters:
    
    task - the task to execute
  - instantiatePersistentStore
```
protected abstract PS instantiatePersistentStore(String sId)
```
    Factory method for PersistentStore implementations managed by this PersistenceManager.
    
    Parameters:
    
    sId - the identifier of the store to create
    
    Returns:
    
    a new AbstractPersistentStore with the given identifier
  - instantiatePersistenceTools
```
protected abstract com.oracle.datagrid.persistence.PersistenceTools instantiatePersistenceTools(com.oracle.datagrid.persistence.OfflinePersistenceInfo info)
```
    Factory method to create a PersistenceTools implementation.
    
    Parameters:
    
    info - the OfflinePersistenceInfo relevant to the PersistenceTools
    
    Returns:
    
    a new PersistenceTools implementation
  - getDaemonPool
```
public com.tangosol.internal.util.DaemonPool getDaemonPool()
```
    Return the optional DaemonPool used to execute tasks.
    
    Returns:
    
    the DaemonPool or null if one hasn't been configured
  - setDaemonPool
```
public void setDaemonPool(com.tangosol.internal.util.DaemonPool pool)
```
    Configure the DaemonPool used to execute tasks.
    
    Parameters:
    
    pool - the DaemonPool
  - getDataDirectory
```
public File getDataDirectory()
```
    Return the directory used to store persisted data.
    
    Returns:
    
    the data storage directory
  - getTrashDirectory
```
public File getTrashDirectory()
```
    Return the directory used to store "safe-deleted" persisted data.
    
    Returns:
    
    the trash storage directory
  - getLockDirectory
```
protected File getLockDirectory()
```
    Return the directory used to store lock files.
    
    Returns:
    
    the directory used to store lock files
  - getPersistenceEnvironment
```
protected AbstractPersistenceEnvironment getPersistenceEnvironment()
```
    Return the environment that created this manager.
    
    Returns:
    
    the environment that created this manager
  - setPersistenceEnvironment
```
protected void setPersistenceEnvironment(AbstractPersistenceEnvironment env)
```
    Configure the environment that created this manager.
    
    Parameters:
    
    env - the environment that created this manager
  - getPersistentStoreMap
```
public Map<String,PS> getPersistentStoreMap()
```
    Return the map of open PersistentStore instances keyed by their identifiers.
    Note: The return map is "live". Any attempt to access or mutate it should be done while holding a monitor on this manager.
    
    Returns:
    
    the map of open PersistentStore instances

Class AbstractPersistenceManager<PS extends AbstractPersistenceManager.AbstractPersistentStore>

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.util.Base

Field Summary

Fields inherited from class com.tangosol.util.Base

Constructor Summary

Method Summary

Methods inherited from class com.tangosol.util.Base

Methods inherited from class java.lang.Object

Field Detail

NO_LONGS

NO_STRINGS

f_dirActive

f_dirTrash

f_dirLock

f_sName

f_mapStores

f_setTasks

m_env

m_pool

Constructor Detail

AbstractPersistenceManager

Method Detail

getName

open

close

delete

list

listOpen

read

write

release

getPersistenceTools

toString

getMetadata

readMetadata

writeMetadata

isMetadataComplete

isMetadataCompatible

getImplVersion

getStorageFormat

getStorageVersion

ensurePersistenceException

ensurePersistenceException

validatePersistentStoreId

submitTask

executeTask

executeTaskExclusive

instantiatePersistentStore

instantiatePersistenceTools

getDaemonPool

setDaemonPool

getDataDirectory

getTrashDirectory

getLockDirectory

getPersistenceEnvironment

setPersistenceEnvironment

getPersistentStoreMap