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

Modifier and Type	Field and Description
private int	actionCode
private StorageFile	actionFile
private File	backupRoot
private String[]	bfilelist
private static final int	BOOT_ACTION
private CacheManager	containerCache
private ContainerKey	containerId
private String	databaseDirectory
private boolean	databaseEncrypted
private String	dataDirectory
pack-priv boolean	dataNotSyncedAtAllocation
pack-priv boolean	dataNotSyncedAtCheckpoint
private static final int	DELETE_IF_EXISTS_ACTION
private Hashtable<LogInstant, Object[]>	droppedTableStubInfo
private StorageFile	exFileLock
private FileResource	fileHandler
private StorageRandomAccessFile	fileLockOnDB
private static final int	FIND_MAX_CONTAINER_ID_ACTION
private final Object	freezeSemaphore
private static final int	GET_ALTERNATE_CONTAINER_PATH_ACTION
private static final int	GET_CONTAINER_NAMES_ACTION
private static final int	GET_CONTAINER_PATH_ACTION
private static final int	GET_LOCK_ON_DB_ACTION
private static final int	GET_PATH_ACTION
private UUID	identifier
private boolean	inCreateNoLog
private boolean	isCorrupt
private boolean	isFrozen
private HeaderPrintWriter	istream
private String	jarCPath
private ProductVersionHolder	jbmsVersion
private String	jvmVersion
private static final String	LINE
private LogFactory	logFactory
private AllocationActions	loggableAllocActions
private PageActions	loggablePageActions
private UUID	myUUID
private long	nextContainerId
private String	osInfo
private CacheManager	pageCache
private static final int	POST_RECOVERY_REMOVE_ACTION
private Hashtable<String, StorageFile>	postRecoveryRemovedFiles
private RawStoreFactory	rawStoreFactory
private boolean	readOnly
private static final int	RELEASE_LOCK_ON_DB_ACTION
private static final int	REMOVE_STUBS_ACTION
private static final int	REMOVE_TEMP_DIRECTORY_ACTION
private boolean	removeStubsOK
private static final int	RESTORE_DATA_DIRECTORY_ACTION
pack-priv StorageFactory	storageFactory
private boolean	stub
private boolean	supportsRandomAccess
private boolean	throwDBlckException
private UndoHandler	undo_handler
private UUIDFactory	uuidFactory
pack-priv WritableStorageFactory	writableStorageFactory
private int	writersInProgress

Access	Constructor and Description
public	BaseDataFileFactory()

Method Summary

Modifier and Type	Method and Description
public long	addAndLoadStreamContainer(RawTransaction the transaction that is creating the container t, long the segment where the container is to go segmentId, Properties properties of the container that is persistently stored throughout the lifetime of the container tableProperties, RowSource the data to load the container with rowSource) Implements org.apache.derby.iapi.store.raw.data.DataFactory.addAndLoadStreamContainer. Add and load a stream container
public long	addContainer(RawTransaction the transaction that is creating the container t, long the segment where the container is to go segmentId, long input_containerid, int whether or not to LOGGED or not. The effect of this mode is only for this addContainer call, not persisently stored throughout the lifetime of the container mode, Properties properties of the container that is persistently stored throughout the lifetime of the container tableProperties, int temporaryFlag) Implements org.apache.derby.iapi.store.raw.data.DataFactory.addContainer. Add a container with a specified page size to a segment.
public void	backupDataFiles(Transaction rt, File backupDir) Implements org.apache.derby.iapi.store.raw.data.DataFactory.backupDataFiles. Back up the data segment of the database.
public void	boot(boolean True if the database should be created create, Properties Configuration properties startParams) Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot. Boot this module with the given properties.
private void	bootLogFactory(boolean create, Properties startParams)
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.
private static String	Returns: the Java system property value from the JVM or a string capturing a security exception. buildJvmVersion() Return values of system properties that identify the JVM.
private static String	Returns: the Java system property value for the OS or a string capturing a security exception. buildOSinfo() Return values of system properties that identify the OS.
public boolean	canSupport(Properties startParams) Implements org.apache.derby.iapi.services.monitor.ModuleSupportable.canSupport. See if this implementation can support any attributes that are listed in properties.
public void	checkpoint() Implements org.apache.derby.iapi.store.raw.data.DataFactory.checkpoint. Implement checkpoint operation, write/sync all pages in cache.
public void	createFinished() Implements org.apache.derby.iapi.store.raw.data.DataFactory.createFinished. Database creation finished
public final boolean	databaseEncrypted() Implements org.apache.derby.iapi.store.raw.data.DataFactory.databaseEncrypted. Returns if data base is in encrypted mode.
public int	decrypt(byte[] ciphertext, int offset, int length, byte[] cleartext, int outputOffset) Implements org.apache.derby.iapi.store.raw.data.DataFactory.decrypt. Decrypt cleartext from ciphertext.
public void	decryptAllContainers(RawTransaction the transaction that is decrypting the container t) Implements org.apache.derby.iapi.store.raw.data.DataFactory.decryptAllContainers. Decrypts all the containers in the data segment.
public void	dropContainer(RawTransaction t, ContainerKey ckey) Implements org.apache.derby.iapi.store.raw.data.DataFactory.dropContainer. Drop a container.
public void	dropStreamContainer(RawTransaction t, long segmentId, long containerId) Implements org.apache.derby.iapi.store.raw.data.DataFactory.dropStreamContainer. Drop a stream container.
public int	encrypt(byte[] cleartext, int offset, int length, byte[] ciphertext, int outputOffset, boolean newEngine) Implements org.apache.derby.iapi.store.raw.data.DataFactory.encrypt. Encrypt cleartext into ciphertext.
public void	encryptAllContainers(RawTransaction the transaction that is encrypting the containers. t) Implements org.apache.derby.iapi.store.raw.data.DataFactory.encryptAllContainers. Encrypt all the containers in the data segment.
pack-priv void	fileToRemove(StorageFile file, boolean remove) Add a file to the list of files to be removed post recovery.
private synchronized long	Returns: The largest containerid in seg0. findMaxContainerId() Find the largest containerid is seg 0.
pack-priv void	flush(LogInstant instant) Ask the log factory to flush up to this log instant.
public void	freezePersistentStore() Implements org.apache.derby.iapi.store.raw.data.DataFactory.freezePersistentStore. Backup restore - stop writing dirty pages or container to disk
public StorageFile	getAlternateContainerPath(ContainerKey The container being opened/created containerId, boolean True if the file name for the stub is requested, otherwise the file name for the data file stub) Return an alternate path to container file relative to the root directory.
pack-priv CacheManager	getContainerCache()
pack-priv synchronized String[]	Returns: An array of all the file names in seg0. getContainerNames() get all the names of the files in seg 0.
public StorageFile	Returns: The StorageFile representing path to container relative to root. getContainerPath(ContainerKey The container being opened/created containerId, boolean True if the file name for the stub is requested, otherwise the file name for the data file stub) Return the path to a container file.
private synchronized StorageFile	getContainerPath(ContainerKey containerId, boolean stub, int code)
public int	getEncryptionBlockSize() Implements org.apache.derby.iapi.store.raw.data.DataFactory.getEncryptionBlockSize. Returns the encryption block size used by the algorithm at time of creation of an encrypted database
public FileResource	getFileHandler() Implements org.apache.derby.iapi.store.raw.data.DataFactory.getFileHandler. Get an object to handle non-transactional files.
public UUID	getIdentifier() Implements org.apache.derby.iapi.store.raw.data.DataFactory.getIdentifier. Return my unique identifier
public int	getIntParameter(String parameterName, Properties properties, int defaultValue, int minimumValue, int maximumValue)
private void	getJBMSLockOnDB(UUID myUUID, UUIDFactory uuidFactory, String databaseDirectory) check to see if we are the only JBMS opened against this database.
pack-priv LogFactory	getLogFactory()
private AllocationActions	Returns: the PageActions getLoggableAllocationActions() Get the loggable allocation action associated with this implementation
private PageActions	getLoggablePageActions()
public long	Returns: The an id which can be used to create a container. getMaxContainerId() Implements org.apache.derby.iapi.store.raw.data.DataFactory.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.
pack-priv synchronized long	getNextId()
pack-priv CacheManager	getPageCache()
pack-priv RawStoreFactory	getRawStoreFactory()
public String	getRootDirectory() Implements org.apache.derby.iapi.store.raw.data.DataFactory.getRootDirectory. Get the root directory of the data storage area.
public StorageFactory	Returns: The StorageFactory used by this dataFactory getStorageFactory() Implements org.apache.derby.iapi.store.raw.data.DataFactory.getStorageFactory.
public String	getVersionedName(String name, long generationId)
private boolean	handleServiceType(String type) Does this factory support this service type.
public void	idle() Implements org.apache.derby.iapi.store.raw.data.DataFactory.idle.
protected void	insertUndoNotify(RawTransaction raw transaction of the aborted insert. rxact, PageKey page key of the aborted insert. page_key) Notify through set handler that an undo of an insert has happened.
public boolean	isReadOnly() Implements org.apache.derby.iapi.store.raw.data.DataFactory.isReadOnly. Is the store read-only.
private static String	Returns: the ClassPath of a jar file jarClassPath(final Class<T> the Class to ask to print the class name of an object cls) Return a jar file by asking the class's class loader for the location where the class was loaded from.
private void	logMsg(String msg)
public boolean	luceneLoaded() Return true if the Lucene plugin is loaded
public StandardException	markCorrupt(StandardException originalError) Implements org.apache.derby.iapi.store.raw.Corruptable.markCorrupt. Really this is just a convience routine for callers that might not have access to a log factory.
public Cacheable	newCacheable(CacheManager cm) Implements org.apache.derby.iapi.services.cache.CacheableFactory.newCacheable.
pack-priv Cacheable	Returns: A new file container object. newContainerObject() Produces new container objects.
protected Cacheable	newRAFContainer(BaseDataFileFactory factory) Creates a RAFContainer object.
public ContainerHandle	openContainer(RawTransaction the raw transaction that is opening the container t, ContainerKey the container's identity containerId, LockingPolicy the locking policy locking, int see the different mode in @see ContainerHandle then will return a null handle if the container is dropped. mode) Implements org.apache.derby.iapi.store.raw.data.DataFactory.openContainer. Open a container that is not droped.
private RawContainerHandle	openContainer(RawTransaction t, ContainerKey identity, LockingPolicy locking, int mode, boolean droppedOK)
public RawContainerHandle	openDroppedContainer(RawTransaction t, ContainerKey containerId, LockingPolicy locking, int mode) Implements org.apache.derby.iapi.store.raw.data.DataFactory.openDroppedContainer. Open a container that may have been dropped.
public StreamContainerHandle	openStreamContainer(RawTransaction t, long segmentId, long containerId, boolean hold) Implements org.apache.derby.iapi.store.raw.data.DataFactory.openStreamContainer. open an exsisting streamContainer
public void	postRecovery() Implements org.apache.derby.iapi.store.raw.data.DataFactory.postRecovery. Called after recovery is performed.
private void	privGetJBMSLockOnDB()
private void	privReleaseJBMSLockOnDB()
private void	privRestoreDataDirectory()
pack-priv int	random() return a secure random number
public int	reclaimSpace(Serviceable work, ContextManager contextMgr) Implements org.apache.derby.iapi.store.raw.data.DataFactory.reclaimSpace. Reclaim space used by this factory.
public void	reCreateContainerForRedoRecovery(RawTransaction t, long segmentId, long containerId, ByteArray containerInfo) Implements org.apache.derby.iapi.store.raw.data.DataFactory.reCreateContainerForRedoRecovery. re-Create a container during redo recovery.
private void	releaseJBMSLockOnDB()
public void	removeDroppedContainerFileStubs(LogInstant redoLWM) Implements org.apache.derby.iapi.store.raw.data.DataFactory.removeDroppedContainerFileStubs. Delete the stub files that are not required for recovery.
public void	removeOldVersionOfContainers() Implements org.apache.derby.iapi.store.raw.data.DataFactory.removeOldVersionOfContainers. Removes old versions of the containers after a cryptographic operation on the database.
private synchronized void	removeStubs() Remove stubs in this database.
public void	removeStubsOK() Implements org.apache.derby.iapi.store.raw.data.DataFactory.removeStubsOK. Tell the data factory it is OK to remove committed deleted containers when the data factory shuts down.
private synchronized void	removeTempDirectory()
private void	restoreDataDirectory(String backupPath) removes the data directory(seg*) from database home directory and restores it from backup location.
public final Object	run()
public void	setDatabaseEncrypted(boolean `true` if the database is encrypted, `false` otherwise isEncrypted) Implements org.apache.derby.iapi.store.raw.data.DataFactory.setDatabaseEncrypted. Sets whether the database is encrypted.
public void	setRawStoreFactory(RawStoreFactory rsf, boolean create, Properties startParams) Implements org.apache.derby.iapi.store.raw.data.DataFactory.setRawStoreFactory. make data factory aware of which raw store factory it belongs to Also need to boot the LogFactory
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.data.DataFactory.setUndoInsertEventHandler. Register a handler class for insert undo events.
public void	setupCacheCleaner(DaemonService daemon service to use for background cleaning daemon) Implements org.apache.derby.iapi.store.raw.data.DataFactory.setupCacheCleaner. Set up the cache cleaner for the container cache and the page cache.
private static Object	startSystemModule(final String factoryInterface) Must be private so that user code can't call this entry point.
public void	stop() Implements org.apache.derby.iapi.store.raw.data.DataFactory.stop, org.apache.derby.iapi.services.monitor.ModuleControl.stop. Stop the module.
public void	stubFileToRemoveAfterCheckPoint(StorageFile file, LogInstant logInstant, Object identity) keeps track of information about the stub files of the committed deleted containers.
public void	unfreezePersistentStore() Implements org.apache.derby.iapi.store.raw.data.DataFactory.unfreezePersistentStore. Backup restore - start writing dirty pages or container to disk
public void	writeFinished() Implements org.apache.derby.iapi.store.raw.data.DataFactory.writeFinished. Backup restore - write finished, if this is the last writer, allow the persistent store to proceed.
public void	writeInProgress() Implements org.apache.derby.iapi.store.raw.data.DataFactory.writeInProgress. Backup restore - don't allow the persistent store to be frozen - or if it is already frozen, block.

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

public Class BaseDataFileFactory

Field Summary

Constructor Summary

Method Summary