Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.store.raw.RawStore

Modifier and Type	Field and Description
private boolean	actionAppend
private byte[]	actionBuffer
private int	actionCode
private boolean	actionCopySubDirs
private String[]	actionFilter
private File	actionRegularFile
private File	actionRegularFile2
private StorageFile	actionStorageFile
private StorageFile	actionToStorageFile
private static final String	BACKUP_HISTORY
private static final int	COPY_REGULAR_DIRECTORY_TO_STORAGE_ACTION
private static final int	COPY_REGULAR_FILE_TO_STORAGE_ACTION
private static final int	COPY_STORAGE_DIRECTORY_TO_REGULAR_ACTION
private static final int	COPY_STORAGE_FILE_TO_REGULAR_ACTION
private static final 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 final int	FILE_WRITER_ACTION
private boolean	isEncryptedDatabase
protected LogFactory	logFactory
private CipherFactory	newCipherFactory
private CipherProvider	newDecryptionEngine
private CipherProvider	newEncryptionEngine
private SecureRandom	random
protected DaemonService	rawStoreDaemon
private static final int	README_FILE_OUTPUTSTREAM_WRITER_ACTION
private static final int	REGULAR_FILE_DELETE_ACTION
private static final int	REGULAR_FILE_EXISTS_ACTION
private static final int	REGULAR_FILE_GET_CANONICALPATH_ACTION
private static final int	REGULAR_FILE_IS_DIRECTORY_ACTION
private static final int	REGULAR_FILE_LIST_DIRECTORY_ACTION
private static final int	REGULAR_FILE_MKDIRS_ACTION
private static final int	REGULAR_FILE_REMOVE_DIRECTORY_ACTION
private static final int	REGULAR_FILE_RENAME_TO_ACTION
private SlaveFactory	slaveFactory
private static final int	STORAGE_FILE_DELETE_ACTION
private static final int	STORAGE_FILE_EXISTS_ACTION
private static final int	STORAGE_FILE_GET_CANONICALPATH_ACTION
private static final int	STORAGE_FILE_LIST_DIRECTORY_ACTION
private StorageFactory	storageFactory
public static final String	TEST_REENCRYPT_CRASH_AFTER_CHECKPOINT
public static final String	TEST_REENCRYPT_CRASH_AFTER_COMMT
public static final String	TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_LOGFILE_DELETE
public static final String	TEST_REENCRYPT_CRASH_AFTER_RECOVERY_UNDO_REVERTING_KEY
public static final String	TEST_REENCRYPT_CRASH_AFTER_SWITCH_TO_NEWKEY
public static final String	TEST_REENCRYPT_CRASH_BEFORE_COMMT (re) encryption testing debug flags that are used to simulate error/crash conditions for testing purposes.
public static final String	TEST_REENCRYPT_CRASH_BEFORE_RECOVERY_FINAL_CLEANUP
protected TransactionFactory	xactFactory

Access	Constructor and Description
public	RawStore()

Method Summary

Modifier and Type	Method and Description
private void	applyBulkCryptoOperation(Properties properties, CipherFactory newCipherFactory)
public void	backup(String the name of the directory where the backup should be stored. This directory will be created if it does not exist. backupDir, boolean if `true`, waits for all the backup blocking operations in progress to finish. wait) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.backup. Backup the database to a backup directory.
public synchronized void	backup(Transaction t, File backupDir)
public void	backupAndEnableLogArchiveMode(String the name of the directory where the backup should be stored. This directory will be created if it does not exist. backupDir, boolean If true deletes online archived log files that exist before this backup, delete will occur only after the backup is complete. deleteOnlineArchivedLogFiles, boolean if `true`, waits for all the backup blocking operations in progress to finish. wait) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.backupAndEnableLogArchiveMode. 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.
public void	boot(boolean True if the database should be created create, Properties Configuration properties properties) Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot. Boot this module with the given properties.
private static Object	bootServiceModule(final boolean create, final Object serviceModule, final String factoryInterface, final Properties properties) Must be private so that user code can't call this entry point.
public boolean	canSupport(Properties startParams) Implements org.apache.derby.iapi.services.monitor.ModuleSupportable.canSupport. We use this RawStore for all databases.
public Serializable	changeBootPassword(Properties properties, Serializable changePassword) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.changeBootPassword. Change the boot password.
public void	checkpoint() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.checkpoint. Checkpoint the database.
public boolean	Returns: `true` if the database has been upgraded to the required level, `false` otherwise. checkVersion(int required database Engine major version requiredMajorVersion, int required database Engine minor version requiredMinorVersion, String Non-null to throw an exception, null to return the state of the version match. feature) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.checkVersion. Check to see if a database has been upgraded to the required level in order to use a store feature.
private void	crashOnDebugFlag(String debugFlag, boolean reEncrypt) when the input debug flag is set, an expception is throw when run in the debug mode.
private void	createBackupDirectory(File the directory to create dir) Create a directory for backup.
public void	createDataWarningFile() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.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.
public void	createFinished() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.createFinished.
private void	cryptoOperationAllowed(boolean `true` if the database is getting encrypted with a new password/key reEncrypt, boolean `true` if the database is getting decrypted decrypt) checks if the database is in the right state to (re)encrypt it.
public int	decrypt(byte[] ciphertext, int offset, int length, byte[] cleartext, int outputOffset) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.decrypt. Decrypt cleartext from ciphertext.
public void	disableLogArchiveMode(boolean If true deletes all online archived log files that exist before this call immediately; Only restore that can be performed after disabling log archive mode is version recovery. deleteOnlineArchivedLogFiles) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.disableLogArchiveMode. disables the log archival process, i.e No old log files will be kept around for a roll-forward recovery.
public int	encrypt(byte[] cleartext, int offset, int length, byte[] ciphertext, int outputOffset, boolean newEngine) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.encrypt. Encrypt cleartext into ciphertext.
public void	failover(String the replication database that is being failed over. dbname) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.failover. Start failover for this database.
private static Object	findServiceModule(final Object serviceModule, final String factoryInterface) Must be private so that user code can't call this entry point.
public Transaction	findUserTransaction(ContextManager the context manager to use. An exception will be thrown if context is not the current context. contextMgr, String If a new transaction is started, it will be given this name. The name is displayed in the transactiontable VTI. transName) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.findUserTransaction. Find a user transaction in the context manager, which must be the current context manager.
public void	freeze() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.freeze. Freeze the database temporarily so a backup can be taken.
public void	freezePersistentStore() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.freezePersistentStore. Freeze persistent store.
private static Context	getContextOrNull(final String contextID) Must be private so that user code can't call this entry point.
private static ContextService	getContextService() Private so that user code can't call this entry point.
public DaemonService	getDaemon() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getDaemon. If this raw store has a daemon that services its need, return the daemon.
public String	getDataFactoryModule() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getDataFactoryModule.
public int	getEncryptionBlockSize() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getEncryptionBlockSize. Returns the encryption block size used by the algorithm at time of creation of an encrypted database
private String	getFilePath(StorageFile file)
private String	getFilePath(File file)
public LockFactory	getLockFactory() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getLockFactory. Get the LockFactory to use with this store.
public String	getLogFactoryModule() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getLogFactoryModule.
public String	getMasterFactoryModule()
public long	Returns: The an id which can be used to create a container. getMaxContainerId() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getMaxContainerId. Return an id which can be used to create a container.
private static ModuleFactory	getMonitor() Must be private so that user code can't call this entry point.
public void	getRawStoreProperties(PersistentSet set) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getRawStoreProperties. Get JBMS properties relevant to raw store
private static String	getServiceName(final Object serviceModule) Must be private so that user code can't call this entry point.
public String	getSlaveFactoryModule()
public String	getTransactionFactoryModule() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getTransactionFactoryModule.
public TransactionInfo[]	getTransactionInfo() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getTransactionInfo.
public TransactionFactory	getXactFactory() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getXactFactory. Get the Transaction Factory to use with this store.
public Object	getXAResourceManager() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.getXAResourceManager.
public void	handleIncompleteDbCryptoOperation(Properties properties related to this database. 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.
public void	idle() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.idle. Idle the raw store as much as possible.
public boolean	isReadOnly() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.isReadOnly. Is the store read-only.
private static boolean	isSet(Properties p, String attribute) Tells if the attribute/property has been specified.
private static boolean	isTrue(Properties p, String attribute) Tells if the attribute/property has been set to `true`.
private void	logHistory(OutputStreamWriter historyFile, String msg)
public StandardException	markCorrupt(StandardException originalError) Implements org.apache.derby.iapi.store.raw.Corruptable.markCorrupt. Mark the module as corrupt.
public ScanHandle	openFlushedScan(DatabaseInstant The instant for the beginning of the scan. start, int log record groups the caller wants to scan. groupsIWant) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.openFlushedScan. Get a flushed scan.
protected boolean	privCopyDirectory(StorageFile from, File to)
protected boolean	privCopyDirectory(File from, StorageFile to)
private synchronized boolean	privCopyDirectory(StorageFile from, File to, byte[] buffer, String[] filter, boolean copySubdirs)
private synchronized boolean	privCopyDirectory(File from, StorageFile to, byte[] buffer, String[] filter)
private synchronized boolean	privCopyFile(File from, StorageFile to)
private synchronized boolean	privCopyFile(StorageFile from, File to)
private synchronized boolean	privCopyFile(StorageFile from, StorageFile to)
private synchronized boolean	privDelete(File file)
private synchronized boolean	privDelete(StorageFile file)
private synchronized boolean	privExists(File file)
private synchronized boolean	privExists(final StorageFile file)
private synchronized OutputStreamWriter	privFileWriter(StorageFile fileName, boolean append)
private synchronized String	privGetCanonicalPath(final StorageFile file)
private synchronized String	privGetCanonicalPath(final File file)
private synchronized OutputStreamWriter	privGetOutputStreamWriter(StorageFile file)
private synchronized boolean	privIsDirectory(File file)
private synchronized String[]	privList(final StorageFile file)
private synchronized boolean	privMkdirs(File file)
private synchronized boolean	privRemoveDirectory(File file)
private synchronized boolean	privRenameTo(File file1, File file2)
public int	random() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.random. Returns a secure random number for this raw store - if database is not encrypted, returns 0.
private void	removeCryptoProperties(Properties property set to remove from properties) Removes properties related to encrypted databases.
private void	restoreRemainingFromBackup(String backupPath)
public final Object	run()
public void	setUndoInsertEventHandler(UndoHandler Class to use to notify callers of an undo of an insert. input_undo_handle) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.setUndoInsertEventHandler. Register a handler class for insert undo events.
private boolean	Returns: `true` if the existing data in the database should be transformed by applying a cryptographic operation. setupEncryptionEngines(boolean whether a new database is being created, or if this is an existing database create, Properties database properties, including connection attributes properties) Setup encryption engines according to the user properties and the current database state.
public Transaction	startGlobalTransaction(ContextManager is the context manager to use. An exception will be thrown if context is not the current context. contextMgr, int the format id part of the Xid - ie. Xid.getFormatId(). format_id, byte[] the global transaction identifier part of XID - ie. Xid.getGlobalTransactionId(). global_id, byte[] The branch qualifier of the Xid - ie. Xid.getBranchQaulifier() branch_id) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.startGlobalTransaction. Create a global user transaction, almost all work within the raw store is performed in the context of a transaction.
public Transaction	startInternalTransaction(ContextManager contextMgr) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.startInternalTransaction. Create an internal transaction.
public Transaction	startNestedReadOnlyUserTransaction(Transaction parent transaction parentTransaction, CompatibilitySpace compatibility space to use for locks. compatibilitySpace, ContextManager is the context manager to use. An exception will be thrown if context is not the current context. contextMgr, String is the name of the transaction. This name will be displayed by the transactiontable VTI. transName) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.startNestedReadOnlyUserTransaction. Create a nested user transaction, almost all work within the raw store is performed in the context of a transaction.
public Transaction	startNestedUpdateUserTransaction(Transaction parent transaction parentTransaction, ContextManager is the context manager to use. An exception will be thrown if context is not the current context. contextMgr, String is the name of the transaction. This name will be displayed by the transactiontable VTI. transName, boolean By default should the transaction commit and abort be synced to the log. Normal usage should pick true, unless there is specific performance need and usage works correctly if a commit can be lost on system crash. flush_log_on_xact_end) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.startNestedUpdateUserTransaction. Create a nested user transaction, almost all work within the raw store is performed in the context of a transaction.
public void	startReplicationMaster(String The master database that is being replicated. dbmaster, String The hostname for the slave host, int The port the slave is listening on port, String The type of replication contract. Currently only asynchronous replication is supported, but 1-safe/2-safe/very-safe modes may be added later. replicationMode) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.startReplicationMaster. Start the replication master role for this database
private static Object	startSystemModule(final String factoryInterface) Must be private so that user code can't call this entry point.
public Transaction	startTransaction(ContextManager is the context manager to use. An exception will be thrown if context is not the current context. contextMgr, String is the name of the transaction. Thsi name will be displayed by the transactiontable VTI. transName) Implements org.apache.derby.iapi.store.raw.RawStoreFactory.startTransaction. Create a user transaction, almost all work within the raw store is performed in the context of a transaction.
public void	stop() Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop. Stop the module.
public void	stopReplicationMaster() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.stopReplicationMaster. Stop the replication master role for this database.
public void	unfreeze() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.unfreeze. Unfreeze the database after a backup has been taken.
public void	unfreezePersistentStore() Implements org.apache.derby.iapi.store.raw.RawStoreFactory.unfreezePersistentStore. Freeze persistent store.
private IOException	wrapSE(Exception se) Wrap a StandardException in an IOException to handle the signature of run()

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

public final Class RawStore

Field Summary

Constructor Summary

Method Summary