Class BaseDataFileFactory
- java.lang.Object
-
- org.apache.derby.impl.store.raw.data.BaseDataFileFactory
-
- All Implemented Interfaces:
java.security.PrivilegedExceptionAction<java.lang.Object>
,CacheableFactory
,ModuleControl
,ModuleSupportable
,Corruptable
,DataFactory
- Direct Known Subclasses:
BaseDataFileFactoryJ4
public class BaseDataFileFactory extends java.lang.Object implements DataFactory, CacheableFactory, ModuleControl, ModuleSupportable, java.security.PrivilegedExceptionAction<java.lang.Object>
Provides the abstract class with most of the implementation of DataFactory and ModuleControl shared by all the different filesystem implementations.RESOLVE (mikem - 2/19/98) - Currently only getContainerClass() is abstract, there are probably more routines which should be abstract. Also the other implementations should probably inherit from the abstract class, rather than from the DataFileFactory class. Also there probably should be a generic directory and the rest of the filesystem implementations parallel to it. I wanted to limit the changes going into the branch and then fix inheritance stuff in main.
The code in this class was moved over from DataFileFactory.java and then that file was made to inherit from this one.
-
-
Field Summary
-
Fields inherited from interface org.apache.derby.iapi.store.raw.data.DataFactory
DB_EX_LOCKFILE_NAME, DB_LOCKFILE_NAME, MODULE, TEMP_SEGMENT_NAME
-
-
Constructor Summary
Constructors Constructor Description BaseDataFileFactory()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description long
addAndLoadStreamContainer(RawTransaction t, long segmentId, java.util.Properties tableProperties, RowSource rowSource)
Add and load a stream containerlong
addContainer(RawTransaction t, long segmentId, long input_containerid, int mode, java.util.Properties tableProperties, int temporaryFlag)
Add a container with a specified page size to a segment.void
backupDataFiles(Transaction rt, java.io.File backupDir)
Back up the data segment of the database.void
boot(boolean create, java.util.Properties startParams)
Boot this module with the given properties.private void
bootLogFactory(boolean create, java.util.Properties startParams)
private static java.lang.Object
bootServiceModule(boolean create, java.lang.Object serviceModule, java.lang.String factoryInterface, java.util.Properties properties)
Privileged startup.private static java.lang.String
buildJvmVersion()
Return values of system properties that identify the JVM.private static java.lang.String
buildOSinfo()
Return values of system properties that identify the OS.boolean
canSupport(java.util.Properties startParams)
See if this implementation can support any attributes that are listed in properties.void
checkpoint()
Implement checkpoint operation, write/sync all pages in cache.void
createFinished()
Database creation finishedboolean
databaseEncrypted()
Returns if data base is in encrypted mode.int
decrypt(byte[] ciphertext, int offset, int length, byte[] cleartext, int outputOffset)
Decrypt cleartext from ciphertext.void
decryptAllContainers(RawTransaction t)
Decrypts all the containers in the data segment.void
dropContainer(RawTransaction t, ContainerKey ckey)
Drop a container.void
dropStreamContainer(RawTransaction t, long segmentId, long containerId)
Drop a stream container.int
encrypt(byte[] cleartext, int offset, int length, byte[] ciphertext, int outputOffset, boolean newEngine)
Encrypt cleartext into ciphertext.void
encryptAllContainers(RawTransaction t)
Encrypt all the containers in the data segment.(package private) void
fileToRemove(StorageFile file, boolean remove)
Add a file to the list of files to be removed post recovery.private long
findMaxContainerId()
Find the largest containerid is seg 0.(package private) void
flush(LogInstant instant)
Ask the log factory to flush up to this log instant.void
freezePersistentStore()
Backup restore - stop writing dirty pages or container to diskStorageFile
getAlternateContainerPath(ContainerKey containerId, boolean stub)
Return an alternate path to container file relative to the root directory.(package private) CacheManager
getContainerCache()
(package private) java.lang.String[]
getContainerNames()
get all the names of the files in seg 0.StorageFile
getContainerPath(ContainerKey containerId, boolean stub)
Return the path to a container file.private StorageFile
getContainerPath(ContainerKey containerId, boolean stub, int code)
int
getEncryptionBlockSize()
Returns the encryption block size used by the algorithm at time of creation of an encrypted databaseFileResource
getFileHandler()
Get an object to handle non-transactional files.UUID
getIdentifier()
Return my unique identifierint
getIntParameter(java.lang.String parameterName, java.util.Properties properties, int defaultValue, int minimumValue, int maximumValue)
private void
getJBMSLockOnDB(UUID myUUID, UUIDFactory uuidFactory, java.lang.String databaseDirectory)
check to see if we are the only JBMS opened against this database.(package private) LogFactory
getLogFactory()
private AllocationActions
getLoggableAllocationActions()
Get the loggable allocation action associated with this implementationprivate PageActions
getLoggablePageActions()
long
getMaxContainerId()
Return an id which can be used to create a container.private static ModuleFactory
getMonitor()
Privileged Monitor lookup.(package private) long
getNextId()
(package private) CacheManager
getPageCache()
(package private) RawStoreFactory
getRawStoreFactory()
java.lang.String
getRootDirectory()
Get the root directory of the data storage area.StorageFactory
getStorageFactory()
java.lang.String
getVersionedName(java.lang.String name, long generationId)
private boolean
handleServiceType(java.lang.String type)
Does this factory support this service type.void
idle()
protected void
insertUndoNotify(RawTransaction rxact, PageKey page_key)
Notify through set handler that an undo of an insert has happened.boolean
isReadOnly()
Is the store read-only.private static java.lang.String
jarClassPath(java.lang.Class cls)
Return a jar file by asking the class's class loader for the location where the class was loaded from.private void
logMsg(java.lang.String msg)
boolean
luceneLoaded()
Return true if the Lucene plugin is loadedStandardException
markCorrupt(StandardException originalError)
Really this is just a convience routine for callers that might not have access to a log factory.Cacheable
newCacheable(CacheManager cm)
(package private) Cacheable
newContainerObject()
Produces new container objects.protected Cacheable
newRAFContainer(BaseDataFileFactory factory)
Creates a RAFContainer object.ContainerHandle
openContainer(RawTransaction t, ContainerKey containerId, LockingPolicy locking, int mode)
Open a container that is not droped.private RawContainerHandle
openContainer(RawTransaction t, ContainerKey identity, LockingPolicy locking, int mode, boolean droppedOK)
RawContainerHandle
openDroppedContainer(RawTransaction t, ContainerKey containerId, LockingPolicy locking, int mode)
Open a container that may have been dropped.StreamContainerHandle
openStreamContainer(RawTransaction t, long segmentId, long containerId, boolean hold)
open an exsisting streamContainervoid
postRecovery()
Called after recovery is performed.private void
privGetJBMSLockOnDB()
private void
privReleaseJBMSLockOnDB()
private void
privRestoreDataDirectory()
(package private) int
random()
return a secure random numberint
reclaimSpace(Serviceable work, ContextManager contextMgr)
Reclaim space used by this factory.void
reCreateContainerForRedoRecovery(RawTransaction t, long segmentId, long containerId, ByteArray containerInfo)
re-Create a container during redo recovery.private void
releaseJBMSLockOnDB()
void
removeDroppedContainerFileStubs(LogInstant redoLWM)
Delete the stub files that are not required for recovery.void
removeOldVersionOfContainers()
Removes old versions of the containers after a cryptographic operation on the database.private void
removeStubs()
Remove stubs in this database.void
removeStubsOK()
Tell the data factory it is OK to remove committed deleted containers when the data factory shuts down.private void
removeTempDirectory()
private void
restoreDataDirectory(java.lang.String backupPath)
removes the data directory(seg*) from database home directory and restores it from backup location.java.lang.Object
run()
void
setDatabaseEncrypted(boolean isEncrypted)
Sets whether the database is encrypted.void
setRawStoreFactory(RawStoreFactory rsf, boolean create, java.util.Properties startParams)
make data factory aware of which raw store factory it belongs to Also need to boot the LogFactoryvoid
setUndoInsertEventHandler(UndoHandler input_undo_handle)
Register a handler class for insert undo events.void
setupCacheCleaner(DaemonService daemon)
Set up the cache cleaner for the container cache and the page cache.private static java.lang.Object
startSystemModule(java.lang.String factoryInterface)
Privileged startup.void
stop()
Stop the module.void
stubFileToRemoveAfterCheckPoint(StorageFile file, LogInstant logInstant, java.lang.Object identity)
keeps track of information about the stub files of the committed deleted containers.void
unfreezePersistentStore()
Backup restore - start writing dirty pages or container to diskvoid
writeFinished()
Backup restore - write finished, if this is the last writer, allow the persistent store to proceed.void
writeInProgress()
Backup restore - don't allow the persistent store to be frozen - or if it is already frozen, block.
-
-
-
Field Detail
-
storageFactory
StorageFactory storageFactory
-
writableStorageFactory
WritableStorageFactory writableStorageFactory
-
nextContainerId
private long nextContainerId
-
databaseEncrypted
private boolean databaseEncrypted
-
pageCache
private CacheManager pageCache
-
containerCache
private CacheManager containerCache
-
logFactory
private LogFactory logFactory
-
jbmsVersion
private ProductVersionHolder jbmsVersion
-
jvmVersion
private java.lang.String jvmVersion
-
osInfo
private java.lang.String osInfo
-
jarCPath
private java.lang.String jarCPath
-
rawStoreFactory
private RawStoreFactory rawStoreFactory
-
dataDirectory
private java.lang.String dataDirectory
-
throwDBlckException
private boolean throwDBlckException
-
identifier
private UUID identifier
-
freezeSemaphore
private final java.lang.Object freezeSemaphore
-
isFrozen
private boolean isFrozen
-
writersInProgress
private int writersInProgress
-
removeStubsOK
private boolean removeStubsOK
-
isCorrupt
private boolean isCorrupt
-
inCreateNoLog
private boolean inCreateNoLog
-
fileLockOnDB
private StorageRandomAccessFile fileLockOnDB
-
exFileLock
private StorageFile exFileLock
-
istream
private HeaderPrintWriter istream
-
LINE
private static final java.lang.String LINE
- See Also:
- Constant Field Values
-
dataNotSyncedAtAllocation
boolean dataNotSyncedAtAllocation
-
dataNotSyncedAtCheckpoint
boolean dataNotSyncedAtCheckpoint
-
loggablePageActions
private PageActions loggablePageActions
-
loggableAllocActions
private AllocationActions loggableAllocActions
-
readOnly
private boolean readOnly
-
supportsRandomAccess
private boolean supportsRandomAccess
-
fileHandler
private FileResource fileHandler
-
droppedTableStubInfo
private java.util.Hashtable<LogInstant,java.lang.Object[]> droppedTableStubInfo
-
postRecoveryRemovedFiles
private java.util.Hashtable<java.lang.String,StorageFile> postRecoveryRemovedFiles
-
actionCode
private int actionCode
-
REMOVE_TEMP_DIRECTORY_ACTION
private static final int REMOVE_TEMP_DIRECTORY_ACTION
- See Also:
- Constant Field Values
-
GET_CONTAINER_PATH_ACTION
private static final int GET_CONTAINER_PATH_ACTION
- See Also:
- Constant Field Values
-
GET_ALTERNATE_CONTAINER_PATH_ACTION
private static final int GET_ALTERNATE_CONTAINER_PATH_ACTION
- See Also:
- Constant Field Values
-
FIND_MAX_CONTAINER_ID_ACTION
private static final int FIND_MAX_CONTAINER_ID_ACTION
- See Also:
- Constant Field Values
-
DELETE_IF_EXISTS_ACTION
private static final int DELETE_IF_EXISTS_ACTION
- See Also:
- Constant Field Values
-
GET_PATH_ACTION
private static final int GET_PATH_ACTION
- See Also:
- Constant Field Values
-
POST_RECOVERY_REMOVE_ACTION
private static final int POST_RECOVERY_REMOVE_ACTION
- See Also:
- Constant Field Values
-
REMOVE_STUBS_ACTION
private static final int REMOVE_STUBS_ACTION
- See Also:
- Constant Field Values
-
BOOT_ACTION
private static final int BOOT_ACTION
- See Also:
- Constant Field Values
-
GET_LOCK_ON_DB_ACTION
private static final int GET_LOCK_ON_DB_ACTION
- See Also:
- Constant Field Values
-
RELEASE_LOCK_ON_DB_ACTION
private static final int RELEASE_LOCK_ON_DB_ACTION
- See Also:
- Constant Field Values
-
RESTORE_DATA_DIRECTORY_ACTION
private static final int RESTORE_DATA_DIRECTORY_ACTION
- See Also:
- Constant Field Values
-
GET_CONTAINER_NAMES_ACTION
private static final int GET_CONTAINER_NAMES_ACTION
- See Also:
- Constant Field Values
-
containerId
private ContainerKey containerId
-
stub
private boolean stub
-
actionFile
private StorageFile actionFile
-
myUUID
private UUID myUUID
-
uuidFactory
private UUIDFactory uuidFactory
-
databaseDirectory
private java.lang.String databaseDirectory
-
backupRoot
private java.io.File backupRoot
-
bfilelist
private java.lang.String[] bfilelist
-
undo_handler
private UndoHandler undo_handler
-
-
Method Detail
-
canSupport
public boolean canSupport(java.util.Properties startParams)
Description copied from interface:ModuleSupportable
See if this implementation can support any attributes that are listed in properties. This call may be made on a newly created instance before the boot() method has been called, or after the boot method has been called for a running module.The module can check for attributes in the properties to see if it can fulfill the required behaviour. E.g. the raw store may define an attribute called RawStore.Recoverable. If a temporary raw store is required the property RawStore.recoverable=false would be added to the properties before calling bootServiceModule. If a raw store cannot support this attribute its canSupport method would return null. Also see the Monitor class's prologue to see how the identifier is used in looking up properties.
Actually a better way maybe to have properties of the form RawStore.Attributes.mandatory=recoverable,smallfootprint and RawStore.Attributes.requested=oltp,fast- Specified by:
canSupport
in interfaceModuleSupportable
- Returns:
- true if this instance can be used, false otherwise.
-
boot
public void boot(boolean create, java.util.Properties startParams) 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 interfaceModuleControl
- 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 interfaceDataFactory
- Specified by:
stop
in interfaceModuleControl
- See Also:
Monitor
,ModuleFactory
-
newCacheable
public Cacheable newCacheable(CacheManager cm)
- Specified by:
newCacheable
in interfaceCacheableFactory
-
createFinished
public void createFinished() throws StandardException
Database creation finished- Specified by:
createFinished
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby exception policy.
-
openContainer
public ContainerHandle openContainer(RawTransaction t, ContainerKey containerId, LockingPolicy locking, int mode) throws StandardException
Description copied from interface:DataFactory
Open a container that is not droped.- Specified by:
openContainer
in interfaceDataFactory
- Parameters:
t
- the raw transaction that is opening the containercontainerId
- the container's identitylocking
- the locking policymode
- see the different mode in @see ContainerHandle then will return a null handle if the container is dropped.- Returns:
- the handle to the opened container
- Throws:
StandardException
- Standard Derby error policy
-
openDroppedContainer
public RawContainerHandle openDroppedContainer(RawTransaction t, ContainerKey containerId, LockingPolicy locking, int mode) throws StandardException
Description copied from interface:DataFactory
Open a container that may have been dropped. Only internal raw store code should call this, e.g. recovery.- Specified by:
openDroppedContainer
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby error policy- See Also:
DataFactory.openDroppedContainer(org.apache.derby.iapi.store.raw.xact.RawTransaction, org.apache.derby.iapi.store.raw.ContainerKey, org.apache.derby.iapi.store.raw.LockingPolicy, int)
-
openContainer
private RawContainerHandle openContainer(RawTransaction t, ContainerKey identity, LockingPolicy locking, int mode, boolean droppedOK) throws StandardException
- Throws:
StandardException
- Standard Derby error policy- See Also:
DataFactory.openContainer(org.apache.derby.iapi.store.raw.xact.RawTransaction, org.apache.derby.iapi.store.raw.ContainerKey, org.apache.derby.iapi.store.raw.LockingPolicy, int)
-
addContainer
public long addContainer(RawTransaction t, long segmentId, long input_containerid, int mode, java.util.Properties tableProperties, int temporaryFlag) throws StandardException
Add a container with a specified page size to a segment.- Specified by:
addContainer
in interfaceDataFactory
- Parameters:
t
- the transaction that is creating the containersegmentId
- the segment where the container is to gomode
- 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 containertableProperties
- properties of the container that is persistently stored throughout the lifetime of the container- Returns:
- the containerId of the newly created container
- Throws:
StandardException
- Standard Derby error policy
-
addAndLoadStreamContainer
public long addAndLoadStreamContainer(RawTransaction t, long segmentId, java.util.Properties tableProperties, RowSource rowSource) throws StandardException
Add and load a stream container- Specified by:
addAndLoadStreamContainer
in interfaceDataFactory
- Parameters:
t
- the transaction that is creating the containersegmentId
- the segment where the container is to gotableProperties
- properties of the container that is persistently stored throughout the lifetime of the containerrowSource
- the data to load the container with- Returns:
- the containerId of the newly created stream container
- Throws:
StandardException
- Standard Derby error policy
-
openStreamContainer
public StreamContainerHandle openStreamContainer(RawTransaction t, long segmentId, long containerId, boolean hold) throws StandardException
open an exsisting streamContainer- Specified by:
openStreamContainer
in interfaceDataFactory
- Returns:
- a valid StreamContainerHandle or null if the container does not exist.
- Throws:
StandardException
- Standard Derby error policy- See Also:
DataFactory.openStreamContainer(org.apache.derby.iapi.store.raw.xact.RawTransaction, long, long, boolean)
-
dropStreamContainer
public void dropStreamContainer(RawTransaction t, long segmentId, long containerId) throws StandardException
Drop a stream container.Synchronisation
This call will remove the container.
- Specified by:
dropStreamContainer
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby error policy
-
reCreateContainerForRedoRecovery
public void reCreateContainerForRedoRecovery(RawTransaction t, long segmentId, long containerId, ByteArray containerInfo) throws StandardException
re-Create a container during redo recovery. called ONLY during recovery load tran.- Specified by:
reCreateContainerForRedoRecovery
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby Error policy
-
dropContainer
public void dropContainer(RawTransaction t, ContainerKey ckey) throws StandardException
Drop a container.Synchronisation
This call will mark the container as dropped and then obtain an CX lock (table level exclusive lock) on the container. Once a container has been marked as dropped it cannot be retrieved by an openContainer() call unless explicitly with droppedOK.
Once the exclusive lock has been obtained the container is removed and all its pages deallocated. The container will be fully removed at the commit time of the transaction.
- Specified by:
dropContainer
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby error policy
-
checkpoint
public void checkpoint() throws StandardException
Implement checkpoint operation, write/sync all pages in cache.The derby write ahead log algorithm uses checkpoint of the data cache to determine points of the log no longer required by restart recovery.
This implementation uses the 2 cache interfaces to force all dirty pages to disk: WRITE DIRTY PAGES TO OS: In the first step all pages in the page cache are written, but not synced (pagecache.cleanAll). The cachemanager cleanAll() interface guarantees that every dirty page that exists when this call is first made will have it's clean() method called. The data cache (CachedPage.clean()), will call writePage but not sync the page. By using the java write then sync, the checkpoint is usually doing async I/O, allowing the OS to schedule multiple I/O's to the file as efficiently as it can. Note that it has been observed that checkpoints can flood the I/O system because these writes are not synced, see DERBY-799 - checkpoint should probably somehow restrict the rate it sends out those I/O's - it was observed a simple sleep every N writes fixed most of the problem. FORCE THOSE DIRTY WRITES TO DISK: To force the I/O's to disk, the system calls each open dirty file and uses the java interface to sync any outstanding dirty pages to disk (containerCache.cleanAll()). The open container cache does this work in RAFContainer.clean() by writing it's header out and syncing the file. (Note if any change is made to checkpoint to sync the writes vs. syncing the file, one probably still needs to write the container header out and sync it).
- Specified by:
checkpoint
in interfaceDataFactory
- Throws:
StandardException
- Standard exception policy.
-
idle
public void idle() throws StandardException
- Specified by:
idle
in interfaceDataFactory
- Throws:
StandardException
-
setRawStoreFactory
public void setRawStoreFactory(RawStoreFactory rsf, boolean create, java.util.Properties startParams) throws StandardException
Description copied from interface:DataFactory
make data factory aware of which raw store factory it belongs to Also need to boot the LogFactory- Specified by:
setRawStoreFactory
in interfaceDataFactory
- Throws:
StandardException
- cannot boot the log factory
-
getIdentifier
public UUID getIdentifier()
Return my unique identifier- Specified by:
getIdentifier
in interfaceDataFactory
- See Also:
DataFactory.getIdentifier()
-
reclaimSpace
public int reclaimSpace(Serviceable work, ContextManager contextMgr) throws StandardException
Description copied from interface:DataFactory
Reclaim space used by this factory. Called by post commit daemon.- Specified by:
reclaimSpace
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby exception policy
-
markCorrupt
public StandardException markCorrupt(StandardException originalError)
Really this is just a convience routine for callers that might not have access to a log factory.- Specified by:
markCorrupt
in interfaceCorruptable
- Returns:
- Must always return its parameter.
-
getFileHandler
public FileResource getFileHandler()
Description copied from interface:DataFactory
Get an object to handle non-transactional files.- Specified by:
getFileHandler
in interfaceDataFactory
-
removeStubsOK
public void removeStubsOK()
Description copied from interface:DataFactory
Tell the data factory it is OK to remove committed deleted containers when the data factory shuts down.- Specified by:
removeStubsOK
in interfaceDataFactory
-
setUndoInsertEventHandler
public void setUndoInsertEventHandler(UndoHandler input_undo_handle)
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 interfaceDataFactory
- Parameters:
input_undo_handle
- Class to use to notify callers of an undo of an insert.- Throws:
StandardException
- Standard exception policy.
-
insertUndoNotify
protected void insertUndoNotify(RawTransaction rxact, PageKey page_key) throws StandardException
Notify through set handler that an undo of an insert has happened.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) Longer descrption of routine.
- Parameters:
rxact
- raw transaction of the aborted insert.page_key
- page key of the aborted insert.- Throws:
StandardException
- Standard exception policy.
-
getIntParameter
public int getIntParameter(java.lang.String parameterName, java.util.Properties properties, int defaultValue, int minimumValue, int maximumValue)
-
getContainerCache
CacheManager getContainerCache()
-
getPageCache
CacheManager getPageCache()
-
flush
void flush(LogInstant instant) throws StandardException
Ask the log factory to flush up to this log instant.- Throws:
StandardException
- cannot sync log file
-
getLogFactory
LogFactory getLogFactory()
-
getRawStoreFactory
RawStoreFactory getRawStoreFactory()
-
getRootDirectory
public java.lang.String getRootDirectory()
Description copied from interface:DataFactory
Get the root directory of the data storage area. It is always guaranteed to be an absolute path, and it is prefixed with the JDBC sub-sub-protocol if it is not a directory database. Examples:
/path/to/database
- in case of a directory database
memory:/path/to/database
- in case of a memory database
- Specified by:
getRootDirectory
in interfaceDataFactory
- Returns:
- the root directory of the data storage area
-
newContainerObject
Cacheable newContainerObject()
Produces new container objects.Concrete implementations of a DataFactory must implement this routine to indicate what kind of containers are produced. This class produces file-based containers - RAFContainer objects for files that support random access and InputStreamContainer object for others, such as data files in JARs.
- Returns:
- A new file container object.
-
newRAFContainer
protected Cacheable newRAFContainer(BaseDataFileFactory factory)
Creates a RAFContainer object. This method is overridden in BaseDataFileFactoryJ4 to produce RAFContainer4 objects instead of RAFContainer objects.
-
getLoggablePageActions
private PageActions getLoggablePageActions() throws StandardException
- Throws:
StandardException
-
getLoggableAllocationActions
private AllocationActions getLoggableAllocationActions()
Get the loggable allocation action associated with this implementation- Returns:
- the PageActions
-
removeTempDirectory
private void removeTempDirectory()
-
getContainerPath
public StorageFile getContainerPath(ContainerKey containerId, boolean stub)
Return the path to a container file.Return the path to a container file that is relative to the root directory.
The format of the name of an existing container file is: segNNN/cXXX.dat The format of the name of a stub describing a dropped container file is: segNNN/dXXX.dat NNN = segment number, currently 0 is where normal db files are found. XXX = The hex representation of the container number The store will always create containers with this format name, but the store will also recognize the following two formats when attempting to open files - as some copy tools have uppercased our filesnames when moving across operating systems: The format of the name of an existing container file is: segNNN/CXXX.DAT The format of the name of a stub describing a dropped container file is: segNNN/DXXX.DAT
- Parameters:
containerId
- The container being opened/createdstub
- True if the file name for the stub is requested, otherwise the file name for the data file- Returns:
- The StorageFile representing path to container relative to root.
-
getContainerPath
private StorageFile getContainerPath(ContainerKey containerId, boolean stub, int code)
-
getAlternateContainerPath
public StorageFile getAlternateContainerPath(ContainerKey containerId, boolean stub)
Return an alternate path to container file relative to the root directory. The alternate path uses upper case 'C','D', and 'DAT' instead of lower case - there have been cases of people copying the database and somehow upper casing all the file names. The intended use is as a bug fix for track 3444.- Parameters:
containerId
- The container being opened/createdstub
- True if the file name for the stub is requested, otherwise the file name for the data file
-
removeStubs
private void removeStubs()
Remove stubs in this database. Stubs are committed deleted containers
-
stubFileToRemoveAfterCheckPoint
public void stubFileToRemoveAfterCheckPoint(StorageFile file, LogInstant logInstant, java.lang.Object identity)
keeps track of information about the stub files of the committed deleted containers. We use the info to delete them at checkpoints. In addition to the file info , we also keep track of the identity of the container; which helps to remove entry in the cache and the log instant when the stub was created, which helps us to figure out whether we require the stub file for the crash recovery. We maintain the information in a hashtable: key(LOG INSTANT) Values: File handle , and ContainerIdentity.
-
removeDroppedContainerFileStubs
public void removeDroppedContainerFileStubs(LogInstant redoLWM) throws StandardException
Delete the stub files that are not required for recovery. A stub file is not required to be around if the recovery is not going to see any log record that belongs to that container. Since the stub files are created as a post commit operation, they are not necessary during undo operation of the recovery. To remove a stub file we have to be sure that it was created before the redoLWM in the check point record. We can be sure that the stub is not required if the log instant when it was created is less than the redoLWM.- Specified by:
removeDroppedContainerFileStubs
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby error policy
-
findMaxContainerId
private long findMaxContainerId()
Find the largest containerid is seg 0.Do a file list of the files in seg0 and return the highest numbered file found.
Until I figure out some reliable place to store this information across a boot of the system, this is what is used following a boot to assign the next conglomerate id when a new conglomerate is created. It is only called at most once, and then the value is cached by calling store code.
- Returns:
- The largest containerid in seg0.
-
bootLogFactory
private void bootLogFactory(boolean create, java.util.Properties startParams) throws StandardException
- Throws:
StandardException
-
handleServiceType
private boolean handleServiceType(java.lang.String type)
Does this factory support this service type.
-
getJBMSLockOnDB
private void getJBMSLockOnDB(UUID myUUID, UUIDFactory uuidFactory, java.lang.String databaseDirectory) throws StandardException
check to see if we are the only JBMS opened against this database.
This method does nothing if this database is read only or we cannot access files directly on the database directory.
We first see if a file named db.lck exists on the top database directory (i.e., the directory where service.properties lives). If it doesn't exist, we create it and write to it our identity which is generated per boot of the JBMS.
If the db.lck file already exists when we boot this database, we try to delete it first, assuming that an opened RandomAccessFile can act as a file lock against delete. If that succeeds, we may hold a file lock against subsequent JBMS that tries to attach to this database before we exit.
We test to see if we think an opened file will prevent it from being deleted, if so, we will hold on to the open file descriptor and use it as a filelock. If not, and we started out deleting an existing db.lck file, we issue a warning message to the info stream that we are about to attached to a database which may already have another JBMS attached to it. Then we overwrite that db.lck file with our identity.
Upon shutdown, we delete the db.lck file. If the system crash instead of shutdown cleanly, it will be cleaned up the next time the system boots- Throws:
StandardException
- another JBMS is already attached to the database at this directory
-
privGetJBMSLockOnDB
private void privGetJBMSLockOnDB() throws StandardException
- Throws:
StandardException
-
releaseJBMSLockOnDB
private void releaseJBMSLockOnDB()
-
privReleaseJBMSLockOnDB
private void privReleaseJBMSLockOnDB() throws java.io.IOException
- Throws:
java.io.IOException
-
logMsg
private void logMsg(java.lang.String msg)
-
databaseEncrypted
public final boolean databaseEncrypted()
Description copied from interface:DataFactory
Returns if data base is in encrypted mode.- Specified by:
databaseEncrypted
in interfaceDataFactory
- Returns:
- true if database encrypted false otherwise
-
setDatabaseEncrypted
public void setDatabaseEncrypted(boolean isEncrypted)
Sets whether the database is encrypted.- Specified by:
setDatabaseEncrypted
in interfaceDataFactory
- Parameters:
isEncrypted
-true
if the database is encrypted,false
otherwise
-
encrypt
public int encrypt(byte[] cleartext, int offset, int length, byte[] ciphertext, int outputOffset, boolean newEngine) throws StandardException
Description copied from interface:DataFactory
Encrypt cleartext into ciphertext.- Specified by:
encrypt
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby Error Policy- See Also:
CipherProvider.encrypt(byte[], int, int, byte[], int)
-
decrypt
public int decrypt(byte[] ciphertext, int offset, int length, byte[] cleartext, int outputOffset) throws StandardException
Description copied from interface:DataFactory
Decrypt cleartext from ciphertext.- Specified by:
decrypt
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby Error Policy- See Also:
CipherProvider.decrypt(byte[], int, int, byte[], int)
-
decryptAllContainers
public void decryptAllContainers(RawTransaction t) throws StandardException
Decrypts all the containers in the data segment.- Specified by:
decryptAllContainers
in interfaceDataFactory
- Parameters:
t
- the transaction that is decrypting the container- Throws:
StandardException
- Standard Derby Error Policy
-
encryptAllContainers
public void encryptAllContainers(RawTransaction t) throws StandardException
Encrypt all the containers in the data segment.- Specified by:
encryptAllContainers
in interfaceDataFactory
- Parameters:
t
- the transaction that is encrypting the containers.- Throws:
StandardException
- Standard Derby Error Policy
-
removeOldVersionOfContainers
public void removeOldVersionOfContainers() throws StandardException
Removes old versions of the containers after a cryptographic operation on the database.- Specified by:
removeOldVersionOfContainers
in interfaceDataFactory
- Throws:
StandardException
-
jarClassPath
private static java.lang.String jarClassPath(java.lang.Class cls)
Return a jar file by asking the class's class loader for the location where the class was loaded from. If no value, it returns null- Parameters:
cls
- the Class to ask to print the class name of an object- Returns:
- the ClassPath of a jar file
-
buildOSinfo
private static java.lang.String buildOSinfo()
Return values of system properties that identify the OS. Will catch SecurityExceptions and note them for displaying information.- Returns:
- the Java system property value for the OS or a string capturing a security exception.
-
buildJvmVersion
private static java.lang.String buildJvmVersion()
Return values of system properties that identify the JVM. Will catch SecurityExceptions and note them for displaying information.- Returns:
- the Java system property value from the JVM or a string capturing a security exception.
-
getEncryptionBlockSize
public int getEncryptionBlockSize()
Returns the encryption block size used by the algorithm at time of creation of an encrypted database- Specified by:
getEncryptionBlockSize
in interfaceDataFactory
-
getVersionedName
public java.lang.String getVersionedName(java.lang.String name, long generationId)
-
getMaxContainerId
public long getMaxContainerId() throws StandardException
Return an id which can be used to create a container.Return an id number with is greater than any existing container in the current database. Caller will use this to allocate future container numbers - most likely caching the value and then incrementing it as it is used.
- Specified by:
getMaxContainerId
in interfaceDataFactory
- Returns:
- The an id which can be used to create a container.
- Throws:
StandardException
- Standard exception policy.
-
getNextId
long getNextId()
-
random
int random()
return a secure random number
-
fileToRemove
void fileToRemove(StorageFile file, boolean remove)
Add a file to the list of files to be removed post recovery.
-
postRecovery
public void postRecovery() throws StandardException
Called after recovery is performed.- Specified by:
postRecovery
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby Error Policy
-
setupCacheCleaner
public void setupCacheCleaner(DaemonService daemon)
Set up the cache cleaner for the container cache and the page cache.- Specified by:
setupCacheCleaner
in interfaceDataFactory
- Parameters:
daemon
- daemon service to use for background cleaning
-
freezePersistentStore
public void freezePersistentStore() throws StandardException
Description copied from interface:DataFactory
Backup restore - stop writing dirty pages or container to disk- Specified by:
freezePersistentStore
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby error policy
-
unfreezePersistentStore
public void unfreezePersistentStore()
Description copied from interface:DataFactory
Backup restore - start writing dirty pages or container to disk- Specified by:
unfreezePersistentStore
in interfaceDataFactory
-
writeInProgress
public void writeInProgress() throws StandardException
Description copied from interface:DataFactory
Backup restore - don't allow the persistent store to be frozen - or if it is already frozen, block. A write is about to commence.- Specified by:
writeInProgress
in interfaceDataFactory
- Throws:
StandardException
- Standard Derby error policy
-
writeFinished
public void writeFinished()
Description copied from interface:DataFactory
Backup restore - write finished, if this is the last writer, allow the persistent store to proceed.- Specified by:
writeFinished
in interfaceDataFactory
-
backupDataFiles
public void backupDataFiles(Transaction rt, java.io.File backupDir) throws StandardException
Description copied from interface:DataFactory
Back up the data segment of the database.- Specified by:
backupDataFiles
in interfaceDataFactory
- Throws:
StandardException
-
getContainerNames
java.lang.String[] getContainerNames()
get all the names of the files in seg 0. MT - This method needs to be synchronized to avoid conflicts with other privileged actions execution in this class.- Returns:
- An array of all the file names in seg0.
-
restoreDataDirectory
private void restoreDataDirectory(java.lang.String backupPath) throws StandardException
removes the data directory(seg*) from database home directory and restores it from backup location. This function gets called only when any of the folling attributes are specified on connection URL: Attribute.CREATE_FROM (Create database from backup if it does not exist) Attribute.RESTORE_FROM (Delete the whole database if it exists and then restore * it from backup) Attribute.ROLL_FORWARD_RECOVERY_FROM:(Perform Rollforward Recovery; except for the log directory everthing else is replced by the copy from backup. log files in the backup are copied to the existing online log directory. In all the cases, data directory(seg*) is replaced by the data directory directory from backup when this function is called.- Throws:
StandardException
-
privRestoreDataDirectory
private void privRestoreDataDirectory() throws StandardException
- Throws:
StandardException
-
isReadOnly
public boolean isReadOnly()
Is the store read-only.- Specified by:
isReadOnly
in interfaceDataFactory
-
luceneLoaded
public boolean luceneLoaded() throws StandardException
Return true if the Lucene plugin is loaded- Throws:
StandardException
-
getStorageFactory
public StorageFactory getStorageFactory()
- Specified by:
getStorageFactory
in interfaceDataFactory
- Returns:
- The StorageFactory used by this dataFactory
-
run
public final java.lang.Object run() throws java.io.IOException, StandardException
- Specified by:
run
in interfacejava.security.PrivilegedExceptionAction<java.lang.Object>
- Throws:
java.io.IOException
StandardException
-
getMonitor
private static ModuleFactory getMonitor()
Privileged Monitor lookup. Must be private so that user code can't call this entry point.
-
startSystemModule
private static java.lang.Object startSystemModule(java.lang.String factoryInterface) throws StandardException
Privileged startup. Must be private so that user code can't call this entry point.- Throws:
StandardException
-
bootServiceModule
private static java.lang.Object bootServiceModule(boolean create, java.lang.Object serviceModule, java.lang.String factoryInterface, java.util.Properties properties) throws StandardException
Privileged startup. Must be private so that user code can't call this entry point.- Throws:
StandardException
-
-