RawStore (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.impl.store.raw.RawStore

All Implemented Interfaces:

java.security.PrivilegedExceptionAction<java.lang.Object>, ModuleControl, ModuleSupportable, Corruptable, RawStoreFactory
```
public final class RawStore
extends java.lang.Object
implements RawStoreFactory, ModuleControl, ModuleSupportable, java.security.PrivilegedExceptionAction<java.lang.Object>
```
A Raw store that implements the RawStoreFactory module by delegating all the work to the lower modules TransactionFactory, LogFactory and DataFactory.
```
        String TransactionFactoryId=
        
```
Class is final as it has methods with privilege blocks and implements PrivilegedExceptionAction.

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`actionAppend`
`private byte[]`	`actionBuffer`
`private int`	`actionCode`
`private boolean`	`actionCopySubDirs`
`private java.lang.String[]`	`actionFilter`
`private java.io.File`	`actionRegularFile`
`private java.io.File`	`actionRegularFile2`
`private StorageFile`	`actionStorageFile`
`private StorageFile`	`actionToStorageFile`
`private static java.lang.String`	`BACKUP_HISTORY`
`private static int`	`COPY_REGULAR_DIRECTORY_TO_STORAGE_ACTION`
`private static int`	`COPY_REGULAR_FILE_TO_STORAGE_ACTION`
`private static int`	`COPY_STORAGE_DIRECTORY_TO_REGULAR_ACTION`
`private static int`	`COPY_STORAGE_FILE_TO_REGULAR_ACTION`
`private static int`	`COPY_STORAGE_FILE_TO_STORAGE_ACTION`
`private int`	`counter_decrypt`
`private int`	`counter_encrypt`
`private CipherFactory`	`currentCipherFactory`
`protected DataFactory`	`dataFactory`
`private CipherProvider`	`decryptionEngine`
`private int`	`encryptionBlockSize`
`private CipherProvider`	`encryptionEngine`
`private static int`	`FILE_WRITER_ACTION`
`private boolean`	`isEncryptedDatabase`
`protected LogFactory`	`logFactory`
`private CipherFactory`	`newCipherFactory`
`private CipherProvider`	`newDecryptionEngine`
`private CipherProvider`	`newEncryptionEngine`
`private java.security.SecureRandom`	`random`
`protected DaemonService`	`rawStoreDaemon`
`private static int`	`README_FILE_OUTPUTSTREAM_WRITER_ACTION`
`private static int`	`REGULAR_FILE_DELETE_ACTION`
`private static int`	`REGULAR_FILE_EXISTS_ACTION`
`private static int`	`REGULAR_FILE_GET_CANONICALPATH_ACTION`
`private static int`	`REGULAR_FILE_IS_DIRECTORY_ACTION`
`private static int`	`REGULAR_FILE_LIST_DIRECTORY_ACTION`
`private static int`	`REGULAR_FILE_MKDIRS_ACTION`
`private static int`	`REGULAR_FILE_REMOVE_DIRECTORY_ACTION`
`private static int`	`REGULAR_FILE_RENAME_TO_ACTION`
`private SlaveFactory`	`slaveFactory`
`private static int`	`STORAGE_FILE_DELETE_ACTION`
`private static int`	`STORAGE_FILE_EXISTS_ACTION`
`private static int`	`STORAGE_FILE_GET_CANONICALPATH_ACTION`
`private static int`	`STORAGE_FILE_LIST_DIRECTORY_ACTION`
`private StorageFactory`	`storageFactory`
`static java.lang.String`	`TEST_REENCRYPT_CRASH_AFTER_CHECKPOINT`
`static java.lang.String`	`TEST_REENCRYPT_CRASH_AFTER_COMMT`
`static java.lang.String`	`TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_LOGFILE_DELETE`
`static java.lang.String`	`TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_REVERTING_KEY`
`static java.lang.String`	`TEST_REENCRYPT_CRASH_AFTER_SWITCH_TO_NEWKEY`
`static java.lang.String`	`TEST_REENCRYPT_CRASH_BEFORE_COMMT`	(re) encryption testing debug flags that are used to simulate error/crash conditions for testing purposes.
`static java.lang.String`	`TEST_REENCRYPT_CRASH_BEFORE_RECOVERY_FINAL_CLEANUP`
`protected TransactionFactory`	`xactFactory`

Fields inherited from interface org.apache.derby.iapi.store.raw.RawStoreFactory
CONTAINER_CACHE_SIZE_DEFAULT, CONTAINER_CACHE_SIZE_MAXIMUM, CONTAINER_CACHE_SIZE_MINIMUM, CONTAINER_CACHE_SIZE_PARAMETER, CONTAINER_INITIAL_PAGES, CRYPTO_OLD_EXTERNAL_KEY_VERIFY_FILE, DATA_ENCRYPT_ALGORITHM_VERSION, DB_ENCRYPTION_IN_CLEANUP, DB_ENCRYPTION_IN_PROGRESS, DB_ENCRYPTION_IN_UNDO, DB_ENCRYPTION_STATUS, DEFAULT_ENCRYPTION_BLOCKSIZE, DERBY_STORE_MAJOR_VERSION_10, DERBY_STORE_MINOR_VERSION_1, DERBY_STORE_MINOR_VERSION_10, DERBY_STORE_MINOR_VERSION_2, DERBY_STORE_MINOR_VERSION_3, DERBY_STORE_MINOR_VERSION_4, ENCRYPTED_KEY, ENCRYPTION_ALIGNMENT, ENCRYPTION_BLOCKSIZE, KEEP_TRANSACTION_LOG, LOG_ENCRYPT_ALGORITHM_VERSION, MAX_CONTAINER_INITIAL_PAGES, MINIMUM_RECORD_SIZE_DEFAULT, MINIMUM_RECORD_SIZE_MINIMUM, MINIMUM_RECORD_SIZE_PARAMETER, MODULE, OLD_ENCRYPTED_KEY, PAGE_CACHE_SIZE_DEFAULT, PAGE_CACHE_SIZE_MAXIMUM, PAGE_CACHE_SIZE_MINIMUM, PAGE_CACHE_SIZE_PARAMETER, PAGE_RESERVED_SPACE_PARAMETER, PAGE_RESERVED_ZERO_SPACE_STRING, PAGE_REUSABLE_RECORD_ID, PAGE_SIZE_DEFAULT, PAGE_SIZE_MINIMUM, PAGE_SIZE_STRING, PATCH_INITPAGE_RECOVER_ERROR, PRE_ALLOCATE_PAGE, STREAM_FILE_BUFFER_SIZE_DEFAULT, STREAM_FILE_BUFFER_SIZE_MAXIMUM, STREAM_FILE_BUFFER_SIZE_MINIMUM, STREAM_FILE_BUFFER_SIZE_PARAMETER

Constructor Summary

Constructors
Constructor Description

RawStore()

Constructors
Constructor	Description
`RawStore()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`applyBulkCryptoOperation(java.util.Properties properties, CipherFactory newCipherFactory)`
`void`	`backup(java.lang.String backupDir, boolean wait)`	Backup the database to a backup directory.
`void`	`backup(Transaction t, java.io.File backupDir)`
`void`	`backupAndEnableLogArchiveMode(java.lang.String backupDir, boolean deleteOnlineArchivedLogFiles, boolean wait)`	Backup the database to a backup directory and enable the log archive mode that will keep the archived log files required for roll-forward from this version backup.
`void`	`boot(boolean create, java.util.Properties properties)`	Boot this module with the given properties.
`private static java.lang.Object`	`bootServiceModule(boolean create, java.lang.Object serviceModule, java.lang.String factoryInterface, java.util.Properties properties)`	Privileged startup.
`boolean`	`canSupport(java.util.Properties startParams)`	We use this RawStore for all databases.
`java.io.Serializable`	`changeBootPassword(java.util.Properties properties, java.io.Serializable changePassword)`	Change the boot password.
`void`	`checkpoint()`	Checkpoint the database.
`boolean`	`checkVersion(int requiredMajorVersion, int requiredMinorVersion, java.lang.String feature)`	Check to see if a database has been upgraded to the required level in order to use a store feature.
`private void`	`crashOnDebugFlag(java.lang.String debugFlag, boolean reEncrypt)`	when the input debug flag is set, an expception is throw when run in the debug mode.
`private void`	`createBackupDirectory(java.io.File dir)`	Create a directory for backup.
`void`	`createDataWarningFile()`	Use the available storage factory handle to create a readme file in "seg0" directory warning users to not edit/delete any files in the directory to avoid database corruption.
`void`	`createFinished()`
`private void`	`cryptoOperationAllowed(boolean reEncrypt, boolean decrypt)`	checks if the database is in the right state to (re)encrypt it.
`int`	`decrypt(byte[] ciphertext, int offset, int length, byte[] cleartext, int outputOffset)`	Decrypt cleartext from ciphertext.
`void`	`disableLogArchiveMode(boolean deleteOnlineArchivedLogFiles)`	disables the log archival process, i.e No old log files will be kept around for a roll-forward recovery.
`int`	`encrypt(byte[] cleartext, int offset, int length, byte[] ciphertext, int outputOffset, boolean newEngine)`	Encrypt cleartext into ciphertext.
`void`	`failover(java.lang.String dbname)`	Start failover for this database.
`private static java.lang.Object`	`findServiceModule(java.lang.Object serviceModule, java.lang.String factoryInterface)`	Privileged startup.
`Transaction`	`findUserTransaction(ContextManager contextMgr, java.lang.String transName)`	Find a user transaction in the context manager, which must be the current context manager.
`void`	`freeze()`	Freeze the database temporarily so a backup can be taken.
`void`	`freezePersistentStore()`	Freeze persistent store.
`private static Context`	`getContextOrNull(java.lang.String contextID)`	Privileged lookup of a Context.
`private static ContextService`	`getContextService()`	Privileged lookup of the ContextService.
`DaemonService`	`getDaemon()`	If this raw store has a daemon that services its need, return the daemon.
`java.lang.String`	`getDataFactoryModule()`
`int`	`getEncryptionBlockSize()`	Returns the encryption block size used by the algorithm at time of creation of an encrypted database
`private java.lang.String`	`getFilePath(java.io.File file)`
`private java.lang.String`	`getFilePath(StorageFile file)`
`LockFactory`	`getLockFactory()`	Get the LockFactory to use with this store.
`java.lang.String`	`getLogFactoryModule()`
`java.lang.String`	`getMasterFactoryModule()`
`long`	`getMaxContainerId()`	Return an id which can be used to create a container.
`private static ModuleFactory`	`getMonitor()`	Privileged Monitor lookup.
`void`	`getRawStoreProperties(PersistentSet set)`	Get JBMS properties relevant to raw store
`private static java.lang.String`	`getServiceName(java.lang.Object serviceModule)`	Privileged service name lookup.
`java.lang.String`	`getSlaveFactoryModule()`
`java.lang.String`	`getTransactionFactoryModule()`
`TransactionInfo[]`	`getTransactionInfo()`
`TransactionFactory`	`getXactFactory()`	Get the Transaction Factory to use with this store.
`java.lang.Object`	`getXAResourceManager()`
`void`	`handleIncompleteDbCryptoOperation(java.util.Properties properties)`	Engine might have crashed during encryption of un-encrypted datbase or while re-encryptin an already encrypted database with a new key after all the containers or (re) encrypted.
`void`	`idle()`	Idle the raw store as much as possible.
`boolean`	`isReadOnly()`	Is the store read-only.
`private static boolean`	`isSet(java.util.Properties p, java.lang.String attribute)`	Tells if the attribute/property has been specified.
`private static boolean`	`isTrue(java.util.Properties p, java.lang.String attribute)`	Tells if the attribute/property has been set to `true`.
`private void`	`logHistory(java.io.OutputStreamWriter historyFile, java.lang.String msg)`
`StandardException`	`markCorrupt(StandardException originalError)`	Mark the module as corrupt.
`ScanHandle`	`openFlushedScan(DatabaseInstant start, int groupsIWant)`	Get a flushed scan.
`protected boolean`	`privCopyDirectory(java.io.File from, StorageFile to)`
`private boolean`	`privCopyDirectory(java.io.File from, StorageFile to, byte[] buffer, java.lang.String[] filter)`
`protected boolean`	`privCopyDirectory(StorageFile from, java.io.File to)`
`private boolean`	`privCopyDirectory(StorageFile from, java.io.File to, byte[] buffer, java.lang.String[] filter, boolean copySubdirs)`
`private boolean`	`privCopyFile(java.io.File from, StorageFile to)`
`private boolean`	`privCopyFile(StorageFile from, java.io.File to)`
`private boolean`	`privCopyFile(StorageFile from, StorageFile to)`
`private boolean`	`privDelete(java.io.File file)`
`private boolean`	`privDelete(StorageFile file)`
`private boolean`	`privExists(java.io.File file)`
`private boolean`	`privExists(StorageFile file)`
`private java.io.OutputStreamWriter`	`privFileWriter(StorageFile fileName, boolean append)`
`private java.lang.String`	`privGetCanonicalPath(java.io.File file)`
`private java.lang.String`	`privGetCanonicalPath(StorageFile file)`
`private java.io.OutputStreamWriter`	`privGetOutputStreamWriter(StorageFile file)`
`private boolean`	`privIsDirectory(java.io.File file)`
`private java.lang.String[]`	`privList(StorageFile file)`
`private boolean`	`privMkdirs(java.io.File file)`
`private boolean`	`privRemoveDirectory(java.io.File file)`
`private boolean`	`privRenameTo(java.io.File file1, java.io.File file2)`
`int`	`random()`	Returns a secure random number for this raw store - if database is not encrypted, returns 0.
`private void`	`removeCryptoProperties(java.util.Properties properties)`	Removes properties related to encrypted databases.
`private void`	`restoreRemainingFromBackup(java.lang.String backupPath)`
`java.lang.Object`	`run()`
`void`	`setUndoInsertEventHandler(UndoHandler input_undo_handle)`	Register a handler class for insert undo events.
`private boolean`	`setupEncryptionEngines(boolean create, java.util.Properties properties)`	Setup encryption engines according to the user properties and the current database state.
`Transaction`	`startGlobalTransaction(ContextManager contextMgr, int format_id, byte[] global_id, byte[] branch_id)`	Create a global user transaction, almost all work within the raw store is performed in the context of a transaction.
`Transaction`	`startInternalTransaction(ContextManager contextMgr)`	Create an internal transaction.
`Transaction`	`startNestedReadOnlyUserTransaction(Transaction parentTransaction, CompatibilitySpace compatibilitySpace, ContextManager contextMgr, java.lang.String transName)`	Create a nested user transaction, almost all work within the raw store is performed in the context of a transaction.
`Transaction`	`startNestedUpdateUserTransaction(Transaction parentTransaction, ContextManager contextMgr, java.lang.String transName, boolean flush_log_on_xact_end)`	Create a nested user transaction, almost all work within the raw store is performed in the context of a transaction.
`void`	`startReplicationMaster(java.lang.String dbmaster, java.lang.String host, int port, java.lang.String replicationMode)`	Start the replication master role for this database
`private static java.lang.Object`	`startSystemModule(java.lang.String factoryInterface)`	Privileged startup.
`Transaction`	`startTransaction(ContextManager contextMgr, java.lang.String transName)`	Create a user transaction, almost all work within the raw store is performed in the context of a transaction.
`void`	`stop()`	Stop the module.
`void`	`stopReplicationMaster()`	Stop the replication master role for this database.
`void`	`unfreeze()`	Unfreeze the database after a backup has been taken.
`void`	`unfreezePersistentStore()`	Freeze persistent store.

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

- Field Detail
  - BACKUP_HISTORY
```
private static final java.lang.String BACKUP_HISTORY
```
    See Also:
    
    Constant Field Values
  - xactFactory
```
protected TransactionFactory xactFactory
```
  - dataFactory
```
protected DataFactory dataFactory
```
  - logFactory
```
protected LogFactory logFactory
```
  - slaveFactory
```
private SlaveFactory slaveFactory
```
  - storageFactory
```
private StorageFactory storageFactory
```
  - random
```
private java.security.SecureRandom random
```
  - isEncryptedDatabase
```
private boolean isEncryptedDatabase
```
  - encryptionEngine
```
private CipherProvider encryptionEngine
```
  - decryptionEngine
```
private CipherProvider decryptionEngine
```
  - newEncryptionEngine
```
private CipherProvider newEncryptionEngine
```
  - newDecryptionEngine
```
private CipherProvider newDecryptionEngine
```
  - currentCipherFactory
```
private CipherFactory currentCipherFactory
```
  - newCipherFactory
```
private CipherFactory newCipherFactory
```
  - counter_encrypt
```
private int counter_encrypt
```
  - counter_decrypt
```
private int counter_decrypt
```
  - encryptionBlockSize
```
private int encryptionBlockSize
```
  - rawStoreDaemon
```
protected DaemonService rawStoreDaemon
```
  - actionCode
```
private int actionCode
```
  - FILE_WRITER_ACTION
```
private static final int FILE_WRITER_ACTION
```
    See Also:
    
    Constant Field Values
  - actionStorageFile
```
private StorageFile actionStorageFile
```
  - actionToStorageFile
```
private StorageFile actionToStorageFile
```
  - actionAppend
```
private boolean actionAppend
```
  - REGULAR_FILE_EXISTS_ACTION
```
private static final int REGULAR_FILE_EXISTS_ACTION
```
    See Also:
    
    Constant Field Values
  - actionRegularFile
```
private java.io.File actionRegularFile
```
  - STORAGE_FILE_EXISTS_ACTION
```
private static final int STORAGE_FILE_EXISTS_ACTION
```
    See Also:
    
    Constant Field Values
  - REGULAR_FILE_DELETE_ACTION
```
private static final int REGULAR_FILE_DELETE_ACTION
```
    See Also:
    
    Constant Field Values
  - REGULAR_FILE_MKDIRS_ACTION
```
private static final int REGULAR_FILE_MKDIRS_ACTION
```
    See Also:
    
    Constant Field Values
  - REGULAR_FILE_IS_DIRECTORY_ACTION
```
private static final int REGULAR_FILE_IS_DIRECTORY_ACTION
```
    See Also:
    
    Constant Field Values
  - REGULAR_FILE_REMOVE_DIRECTORY_ACTION
```
private static final int REGULAR_FILE_REMOVE_DIRECTORY_ACTION
```
    See Also:
    
    Constant Field Values
  - REGULAR_FILE_RENAME_TO_ACTION
```
private static final int REGULAR_FILE_RENAME_TO_ACTION
```
    See Also:
    
    Constant Field Values
  - actionRegularFile2
```
private java.io.File actionRegularFile2
```
  - COPY_STORAGE_DIRECTORY_TO_REGULAR_ACTION
```
private static final int COPY_STORAGE_DIRECTORY_TO_REGULAR_ACTION
```
    See Also:
    
    Constant Field Values
  - actionBuffer
```
private byte[] actionBuffer
```
  - actionFilter
```
private java.lang.String[] actionFilter
```
  - actionCopySubDirs
```
private boolean actionCopySubDirs
```
  - COPY_REGULAR_DIRECTORY_TO_STORAGE_ACTION
```
private static final int COPY_REGULAR_DIRECTORY_TO_STORAGE_ACTION
```
    See Also:
    
    Constant Field Values
  - COPY_REGULAR_FILE_TO_STORAGE_ACTION
```
private static final int COPY_REGULAR_FILE_TO_STORAGE_ACTION
```
    See Also:
    
    Constant Field Values
  - REGULAR_FILE_LIST_DIRECTORY_ACTION
```
private static final int REGULAR_FILE_LIST_DIRECTORY_ACTION
```
    See Also:
    
    Constant Field Values
  - STORAGE_FILE_LIST_DIRECTORY_ACTION
```
private static final int STORAGE_FILE_LIST_DIRECTORY_ACTION
```
    See Also:
    
    Constant Field Values
  - COPY_STORAGE_FILE_TO_REGULAR_ACTION
```
private static final int COPY_STORAGE_FILE_TO_REGULAR_ACTION
```
    See Also:
    
    Constant Field Values
  - REGULAR_FILE_GET_CANONICALPATH_ACTION
```
private static final int REGULAR_FILE_GET_CANONICALPATH_ACTION
```
    See Also:
    
    Constant Field Values
  - STORAGE_FILE_GET_CANONICALPATH_ACTION
```
private static final int STORAGE_FILE_GET_CANONICALPATH_ACTION
```
    See Also:
    
    Constant Field Values
  - COPY_STORAGE_FILE_TO_STORAGE_ACTION
```
private static final int COPY_STORAGE_FILE_TO_STORAGE_ACTION
```
    See Also:
    
    Constant Field Values
  - STORAGE_FILE_DELETE_ACTION
```
private static final int STORAGE_FILE_DELETE_ACTION
```
    See Also:
    
    Constant Field Values
  - README_FILE_OUTPUTSTREAM_WRITER_ACTION
```
private static final int README_FILE_OUTPUTSTREAM_WRITER_ACTION
```
    See Also:
    
    Constant Field Values
  - TEST_REENCRYPT_CRASH_BEFORE_COMMT
```
public static final java.lang.String TEST_REENCRYPT_CRASH_BEFORE_COMMT
```
    (re) encryption testing debug flags that are used to simulate error/crash conditions for testing purposes. When any one of the following flags are set to true in the debug mode, re-encryption will fail at that point.
  - TEST_REENCRYPT_CRASH_AFTER_COMMT
```
public static final java.lang.String TEST_REENCRYPT_CRASH_AFTER_COMMT
```
  - TEST_REENCRYPT_CRASH_AFTER_SWITCH_TO_NEWKEY
```
public static final java.lang.String TEST_REENCRYPT_CRASH_AFTER_SWITCH_TO_NEWKEY
```
  - TEST_REENCRYPT_CRASH_AFTER_CHECKPOINT
```
public static final java.lang.String TEST_REENCRYPT_CRASH_AFTER_CHECKPOINT
```
  - TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_LOGFILE_DELETE
```
public static final java.lang.String TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_LOGFILE_DELETE
```
  - TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_REVERTING_KEY
```
public static final java.lang.String TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_REVERTING_KEY
```
  - TEST_REENCRYPT_CRASH_BEFORE_RECOVERY_FINAL_CLEANUP
```
public static final java.lang.String TEST_REENCRYPT_CRASH_BEFORE_RECOVERY_FINAL_CLEANUP
```
- Constructor Detail
  - RawStore
```
public RawStore()
```
- Method Detail
  - canSupport
```
public boolean canSupport(java.util.Properties startParams)
```
    We use this RawStore for all databases.
    
    Specified by:
    
    canSupport in interface ModuleSupportable
    
    Returns:
    
    true if this instance can be used, false otherwise.
  - boot
```
public void boot(boolean create,
                 java.util.Properties properties)
          throws StandardException
```
    Description copied from interface: ModuleControl
    
    Boot this module with the given properties. Creates a module instance that can be found using the findModule() methods of Monitor. The module can only be found using one of these findModule() methods once this method has returned.
    An implementation's boot method can throw StandardException. If it is thrown the module is not registered by the monitor and therefore cannot be found through a findModule(). In this case the module's stop() method is not called, thus throwing this exception must free up any resources.
    When create is true the contents of the properties object will be written to the service.properties of the persistent service. Thus any code that requires an entry in service.properties must explicitly place the value in this properties set using the put method.
    Typically the properties object contains one or more default properties sets, which are not written out to service.properties. These default sets are how callers modify the create process. In a JDBC connection database create the first set of defaults is a properties object that contains the attributes that were set on the jdbc:derby: URL. This attributes properties set has the second default properties set as its default. This set (which could be null) contains the properties that the user set on their DriverManager.getConnection() call, and are thus not owned by Derby code, and thus must not be modified by Derby code.
    When create is false the properties object contains all the properties set in the service.properties file plus a limited number of attributes from the JDBC URL attributes or connection properties set. This avoids properties set by the user compromising the boot process. An example of a property passed in from the JDBC world is the bootPassword for encrypted databases.
    Code should not hold onto the passed in properties reference after boot time as its contents may change underneath it. At least after the complete boot is completed, the links to all the default sets will be removed.
    
    Specified by:
    
    boot in interface ModuleControl
    
    Throws:
    
    StandardException - Module cannot be started.
    
    See Also:
    
    Monitor, ModuleFactory
  - stop
```
public void stop()
```
    Description copied from interface: ModuleControl
    
    Stop the module. The module may be found via a findModule() method until some time after this method returns. Therefore the factory must be prepared to reject requests to it once it has been stopped. In addition other modules may cache a reference to the module and make requests of it after it has been stopped, these requests should be rejected as well.
    
    Specified by:
    
    stop in interface ModuleControl
    
    See Also:
    
    Monitor, ModuleFactory
  - isReadOnly
```
public boolean isReadOnly()
```
    Is the store read-only.
    
    Specified by:
    
    isReadOnly in interface RawStoreFactory
    
    See Also:
    
    RawStoreFactory.isReadOnly()
  - getLockFactory
```
public LockFactory getLockFactory()
```
    Description copied from interface: RawStoreFactory
    
    Get the LockFactory to use with this store.
    
    Specified by:
    
    getLockFactory in interface RawStoreFactory
  - getXactFactory
```
public TransactionFactory getXactFactory()
```
    Get the Transaction Factory to use with this store.
    
    Specified by:
    
    getXactFactory in interface RawStoreFactory
  - setUndoInsertEventHandler
```
public void setUndoInsertEventHandler(UndoHandler input_undo_handle)
                               throws StandardException
```
    Register a handler class for insert undo events.
    Register a class to be called when an undo of an insert is executed. When an undo of an event is executed by the raw store UndoHandler.insertUndoNotify() will be called, allowing upper level callers to execute code as necessary. The initial need is for the access layer to be able to queue post commit reclaim space in the case of inserts which are aborted (including the normal case of inserts failed for duplicate key violations) (see DERBY-4057)
    
    Specified by:
    
    setUndoInsertEventHandler in interface RawStoreFactory
    
    Parameters:
    
    input_undo_handle - Class to use to notify callers of an undo of an insert.
    
    Throws:
    
    StandardException - Standard exception policy.
  - getXAResourceManager
```
public java.lang.Object getXAResourceManager()
                                      throws StandardException
```
    Specified by:
    
    getXAResourceManager in interface RawStoreFactory
    
    Throws:
    
    StandardException
  - startGlobalTransaction
```
public Transaction startGlobalTransaction(ContextManager contextMgr,
                                          int format_id,
                                          byte[] global_id,
                                          byte[] branch_id)
                                   throws StandardException
```
    Description copied from interface: RawStoreFactory
    Create a global user transaction, almost all work within the raw store is performed in the context of a transaction.
    The (format_id, global_id, branch_id) triplet is meant to come exactly from a javax.transaction.xa.Xid. We don't use Xid so that the system can be delivered on a non-1.2 vm system and not require the javax classes in the path.
    Starting a transaction always performs the following steps.
    1. Create an raw store transaction context
    2. Create a new idle transaction and then link it to the context.
  Only one user transaction can be active in a context at any one time. After a commit the transaction may be re-used.
  Raw Store Transaction Context Behaviour
  The cleanupOnError() method of this context behaves as follows:
  - If error is an instance of StandardException that has a severity less than ExceptionSeverity.TRANSACTION_SEVERITY then no action is taken.
  - If error is an instance of StandardException that has a severity equal to ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, and the transaction returned to the idle state.
  - If error is an instance of StandardException that has a severity greater than ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.
  - If error is not an instance of StandardException then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.

Specified by:: startGlobalTransaction in interface RawStoreFactory
Parameters:: contextMgr - is the context manager to use. An exception will be thrown if context is not the current context.; format_id - the format id part of the Xid - ie. Xid.getFormatId().; global_id - the global transaction identifier part of XID - ie. Xid.getGlobalTransactionId().; branch_id - The branch qualifier of the Xid - ie. Xid.getBranchQaulifier()
Throws:: StandardException - Standard Derby error policy
See Also:: Transaction, Context, StandardException

startTransaction
```
public Transaction startTransaction(ContextManager contextMgr,
                                    java.lang.String transName)
                             throws StandardException
```
Description copied from interface: RawStoreFactory
Create a user transaction, almost all work within the raw store is performed in the context of a transaction.
Starting a transaction always performs the following steps.
1. Create an raw store transaction context
2. Create a new idle transaction and then link it to the context.

Only one user transaction and one nested user transaction can be active in a context at any one time. After a commit the transaction may be re-used.

Raw Store Transaction Context Behaviour
The cleanupOnError() method of this context behaves as follows:

If error is an instance of StandardException that has a severity less than ExceptionSeverity.TRANSACTION_SEVERITY then no action is taken.
If error is an instance of StandardException that has a severity equal to ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, and the transaction returned to the idle state.
If error is an instance of StandardException that has a severity greater than ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.
If error is not an instance of StandardException then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.

Raw Store Transaction Context Behaviour
The cleanupOnError() method of this context behaves as follows:

AN internal transaction is identical to a user transaction with the exception that

Raw Store Internal Transaction Context Behaviour
The cleanupOnError() method of this context behaves as follows:

Class RawStore

Field Summary

Fields inherited from interface org.apache.derby.iapi.store.raw.RawStoreFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BACKUP_HISTORY

xactFactory

dataFactory

logFactory

slaveFactory

storageFactory

random

isEncryptedDatabase

encryptionEngine

decryptionEngine

newEncryptionEngine

newDecryptionEngine

currentCipherFactory

newCipherFactory

counter_encrypt

counter_decrypt

encryptionBlockSize

rawStoreDaemon

actionCode

FILE_WRITER_ACTION

actionStorageFile

actionToStorageFile

actionAppend

REGULAR_FILE_EXISTS_ACTION

actionRegularFile

STORAGE_FILE_EXISTS_ACTION

REGULAR_FILE_DELETE_ACTION

REGULAR_FILE_MKDIRS_ACTION

REGULAR_FILE_IS_DIRECTORY_ACTION

REGULAR_FILE_REMOVE_DIRECTORY_ACTION

REGULAR_FILE_RENAME_TO_ACTION

actionRegularFile2

COPY_STORAGE_DIRECTORY_TO_REGULAR_ACTION

actionBuffer

actionFilter

actionCopySubDirs

COPY_REGULAR_DIRECTORY_TO_STORAGE_ACTION

COPY_REGULAR_FILE_TO_STORAGE_ACTION

REGULAR_FILE_LIST_DIRECTORY_ACTION

STORAGE_FILE_LIST_DIRECTORY_ACTION

COPY_STORAGE_FILE_TO_REGULAR_ACTION

REGULAR_FILE_GET_CANONICALPATH_ACTION

STORAGE_FILE_GET_CANONICALPATH_ACTION

COPY_STORAGE_FILE_TO_STORAGE_ACTION

STORAGE_FILE_DELETE_ACTION

README_FILE_OUTPUTSTREAM_WRITER_ACTION

TEST_REENCRYPT_CRASH_BEFORE_COMMT

TEST_REENCRYPT_CRASH_AFTER_COMMT

TEST_REENCRYPT_CRASH_AFTER_SWITCH_TO_NEWKEY

TEST_REENCRYPT_CRASH_AFTER_CHECKPOINT

TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_LOGFILE_DELETE

TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_REVERTING_KEY

TEST_REENCRYPT_CRASH_BEFORE_RECOVERY_FINAL_CLEANUP

Constructor Detail

RawStore

Method Detail

canSupport

boot

stop

isReadOnly

getLockFactory

getXactFactory

setUndoInsertEventHandler

getXAResourceManager

startGlobalTransaction

startTransaction

startNestedReadOnlyUserTransaction

startNestedUpdateUserTransaction

findUserTransaction

startInternalTransaction

checkpoint

startReplicationMaster

stopReplicationMaster