Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.io.BaseStorageFactory

Modifier and Type	Field and Description
protected String	canonicalName
protected String	dataDirectory
pack-priv String	home
protected String	separatedDataDirectory
private static final String	TEMP_DIR_PREFIX
protected StorageFile	tempDir
protected String	tempDirPath
protected String	uniqueName

Access	Constructor and Description
pack-priv	BaseStorageFactory() Most of the initialization is done in the init method.

Method Summary

Modifier and Type	Method and Description
pack-priv void	createTempDir()
public StorageFile	Returns: StorageFile createTemporaryFile(String String to prefix the random name generator. prefix, String String to suffix the random name generator. suffix) Implements org.apache.derby.io.StorageFactory.createTemporaryFile. Create and returns a temporary file in temporary file system of database.
pack-priv abstract void	doInit()
public String	Returns: the canonical name getCanonicalName() Implements org.apache.derby.io.StorageFactory.getCanonicalName. Get the canonical name of the database.
public char	Returns: the pathname separator character. (Normally '/' or '\'). getSeparator() Implements org.apache.derby.io.StorageFactory.getSeparator. Get the pathname separator character used by the StorageFile implementation.
public int	getStorageFactoryVersion() Implements org.apache.derby.io.StorageFactory.getStorageFactoryVersion.
public StorageFile	Returns: a directory name getTempDir() Implements org.apache.derby.io.StorageFactory.getTempDir. Get the abstract name of the directory that holds temporary files.
public void	init(String The name of the directory containing the database. It comes from the system.home system property. It may be null. A storage factory may decide to ignore this parameter. (For instance the classpath storage factory ignores it. home, String The name of the database (directory). All relative pathnames are relative to this directory. If null then the storage factory will only be used to deal with the directory containing the databases. databaseName, String The name of the temporary file directory set in properties. If null then a default directory should be used. Each database should get a separate temporary file directory within this one to avoid collisions. tempDirName, String A unique name that can be used to create the temporary file directory for this database. uniqueName) Implements org.apache.derby.io.StorageFactory.init. Classes implementing the StorageFactory interface must have a null constructor.
public boolean	Returns: true if the storage is fast, false if it is slow. isFast() Implements org.apache.derby.io.StorageFactory.isFast. This method is used to determine whether the storage is fast (RAM based) or slow (disk based).
public boolean	isReadOnlyDatabase() Implements org.apache.derby.io.StorageFactory.isReadOnlyDatabase. Determine whether the database is read only.
pack-priv abstract StorageFile	Returns: A corresponding StorageFile object newPersistentFile(String The path name of the file. Guaranteed not to be in the temporary file directory. If null then the database directory should be returned. path) Construct a persistent StorageFile from a path name.
pack-priv abstract StorageFile	Returns: A corresponding StorageFile object newPersistentFile(String The path name of the directory. Guaranteed not to be in the temporary file directory. Guaranteed not to be null directoryName, String The name of the file within the directory. Guaranteed not to be null. fileName) Construct a persistent StorageFile from a directory and path name.
pack-priv abstract StorageFile	Returns: A corresponding StorageFile object newPersistentFile(StorageFile The path name of the directory. Guaranteed not to be to be null. Guaranteed to be created by a call to one of the newPersistentFile methods. directoryName, String The name of the file within the directory. Guaranteed not to be null. fileName) Construct a persistent StorageFile from a directory and path name.
public StorageFile	Returns: A corresponding StorageFile object newStorageFile(String The path name of the file path) Implements org.apache.derby.io.StorageFactory.newStorageFile. Construct a StorageFile from a path name.
public StorageFile	Returns: A corresponding StorageFile object newStorageFile(String The directory part of the path name. directoryName, String The name of the file within the directory. fileName) Implements org.apache.derby.io.StorageFactory.newStorageFile. Construct a StorageFile from a directory and file name.
public StorageFile	Returns: A corresponding StorageFile object newStorageFile(StorageFile The directory part of the path name. directoryName, String The name of the file within the directory. fileName) Implements org.apache.derby.io.StorageFactory.newStorageFile. Construct a StorageFile from a directory and file name.
private String	readOnlyTempRoot()
public void	setCanonicalName(String uniquely identifiable name for this database name) Implements org.apache.derby.io.StorageFactory.setCanonicalName. Set the canonicalName.
public void	shutdown() Implements org.apache.derby.io.StorageFactory.shutdown. The shutdown method is called during the normal shutdown of the database.
public boolean	Returns: true if the storage supports random access, false if it is writable. supportsRandomAccess() Implements org.apache.derby.io.StorageFactory.supportsRandomAccess. Determine whether the storage supports random access.

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

canonicalName	back to summary
protected String canonicalName

dataDirectory	back to summary
protected String dataDirectory

home	back to summary
pack-priv String home

separatedDataDirectory	back to summary
protected String separatedDataDirectory

TEMP_DIR_PREFIX	back to summary
private static final String TEMP_DIR_PREFIX

tempDir	back to summary
protected StorageFile tempDir

tempDirPath	back to summary
protected String tempDirPath

uniqueName	back to summary
protected String uniqueName

BaseStorageFactory	back to summary
pack-priv BaseStorageFactory() Most of the initialization is done in the init method.

Method Detail

createTempDir	back to summary
pack-priv void createTempDir() throws IOException

createTemporaryFile	back to summary
public StorageFile createTemporaryFile(String prefix, String suffix) throws IOException Implements org.apache.derby.io.StorageFactory.createTemporaryFile. Create and returns a temporary file in temporary file system of database. Parameters prefix:String String to prefix the random name generator. suffix:String String to suffix the random name generator. Returns:StorageFile StorageFile

createTemporaryFile

back to summary

public StorageFile createTemporaryFile(String prefix, String suffix) throws IOException

Implements org.apache.derby.io.StorageFactory.createTemporaryFile.

Create and returns a temporary file in temporary file system of database.

Parameters

prefix:String: String to prefix the random name generator.
suffix:String: String to suffix the random name generator.

Returns:StorageFile

StorageFile

doInit	back to summary
pack-priv abstract void doInit() throws IOException

getCanonicalName	back to summary
public String getCanonicalName() throws IOException Implements org.apache.derby.io.StorageFactory.getCanonicalName. Get the canonical name of the database. This is a name that uniquely identifies it. It is system dependent. The normal, disk based implementation uses method java.io.File.getCanonicalPath on the directory holding the database to construct the canonical name. Returns:String the canonical name Exceptions IOException: if an IO error occurred during the construction of the name.

getCanonicalName

back to summary

public String getCanonicalName() throws IOException

Implements org.apache.derby.io.StorageFactory.getCanonicalName.

Get the canonical name of the database. This is a name that uniquely identifies it. It is system dependent. The normal, disk based implementation uses method java.io.File.getCanonicalPath on the directory holding the database to construct the canonical name.

Returns:String

the canonical name

Exceptions

IOException:: if an IO error occurred during the construction of the name.

getSeparator	back to summary
public char getSeparator() Implements org.apache.derby.io.StorageFactory.getSeparator. Get the pathname separator character used by the StorageFile implementation. Returns:char the pathname separator character. (Normally '/' or '\').

getSeparator

back to summary

public char getSeparator()

Implements org.apache.derby.io.StorageFactory.getSeparator.

Get the pathname separator character used by the StorageFile implementation.

Returns:char: the pathname separator character. (Normally '/' or '\').

getStorageFactoryVersion	back to summary
public int getStorageFactoryVersion() Implements org.apache.derby.io.StorageFactory.getStorageFactoryVersion. Returns:int Doc from org.apache.derby.io.StorageFactory.getStorageFactoryVersion. the StorageFactory version supported by this implementation

getStorageFactoryVersion

back to summary

public int getStorageFactoryVersion()

Implements org.apache.derby.io.StorageFactory.getStorageFactoryVersion.

Returns:int

Doc from org.apache.derby.io.StorageFactory.getStorageFactoryVersion.

the StorageFactory version supported by this implementation

getTempDir	back to summary
public StorageFile getTempDir() Implements org.apache.derby.io.StorageFactory.getTempDir. Get the abstract name of the directory that holds temporary files. Returns:StorageFile a directory name

getTempDir

back to summary

public StorageFile getTempDir()

Implements org.apache.derby.io.StorageFactory.getTempDir.

Get the abstract name of the directory that holds temporary files.

Returns:StorageFile: a directory name

init	back to summary
public void init(String home, String databaseName, String tempDirName, String uniqueName) throws IOException Implements org.apache.derby.io.StorageFactory.init. Classes implementing the StorageFactory interface must have a null constructor. This method is called when the database is booted up to initialize the class. It should perform all actions necessary to start the basic storage, such as creating a temporary file directory. The init method will be called once, before any other method is called, and will not be called again. Parameters home:String The name of the directory containing the database. It comes from the system.home system property. It may be null. A storage factory may decide to ignore this parameter. (For instance the classpath storage factory ignores it. databaseName:String The name of the database (directory). All relative pathnames are relative to this directory. If null then the storage factory will only be used to deal with the directory containing the databases. tempDirName:String The name of the temporary file directory set in properties. If null then a default directory should be used. Each database should get a separate temporary file directory within this one to avoid collisions. uniqueName:String A unique name that can be used to create the temporary file directory for this database. Exceptions IOException: on an error (unexpected).

init

back to summary

public void init(String home, String databaseName, String tempDirName, String uniqueName) throws IOException

Implements org.apache.derby.io.StorageFactory.init.

Classes implementing the StorageFactory interface must have a null constructor. This method is called when the database is booted up to initialize the class. It should perform all actions necessary to start the basic storage, such as creating a temporary file directory. The init method will be called once, before any other method is called, and will not be called again.

Parameters

home:String: The name of the directory containing the database. It comes from the system.home system property. It may be null. A storage factory may decide to ignore this parameter. (For instance the classpath storage factory ignores it.
databaseName:String: The name of the database (directory). All relative pathnames are relative to this directory. If null then the storage factory will only be used to deal with the directory containing the databases.
tempDirName:String: The name of the temporary file directory set in properties. If null then a default directory should be used. Each database should get a separate temporary file directory within this one to avoid collisions.
uniqueName:String: A unique name that can be used to create the temporary file directory for this database.

Exceptions

IOException:: on an error (unexpected).

isFast	back to summary
public boolean isFast() Implements org.apache.derby.io.StorageFactory.isFast. This method is used to determine whether the storage is fast (RAM based) or slow (disk based). It may be used by the database engine to determine the default size of the page cache. Returns:boolean true if the storage is fast, false if it is slow.

isFast

back to summary

public boolean isFast()

Implements org.apache.derby.io.StorageFactory.isFast.

This method is used to determine whether the storage is fast (RAM based) or slow (disk based). It may be used by the database engine to determine the default size of the page cache.

Returns:boolean: true if the storage is fast, false if it is slow.

isReadOnlyDatabase	back to summary
public boolean isReadOnlyDatabase() Implements org.apache.derby.io.StorageFactory.isReadOnlyDatabase. Doc from org.apache.derby.io.StorageFactory.isReadOnlyDatabase. Determine whether the database is read only. The database engine supports read-only databases, even in file systems that are writable. Returns:boolean true if the storage is read only, false if it is writable.

isReadOnlyDatabase

back to summary

public boolean isReadOnlyDatabase()

Implements org.apache.derby.io.StorageFactory.isReadOnlyDatabase.

Doc from org.apache.derby.io.StorageFactory.isReadOnlyDatabase.

Determine whether the database is read only. The database engine supports read-only databases, even in file systems that are writable.

Returns:boolean: true if the storage is read only, false if it is writable.

newPersistentFile	back to summary
pack-priv abstract StorageFile newPersistentFile(String path) Construct a persistent StorageFile from a path name. Parameters path:String The path name of the file. Guaranteed not to be in the temporary file directory. If null then the database directory should be returned. Returns:StorageFile A corresponding StorageFile object

newPersistentFile

back to summary

pack-priv abstract StorageFile newPersistentFile(String path)

Construct a persistent StorageFile from a path name.

Parameters

path:String: The path name of the file. Guaranteed not to be in the temporary file directory. If null then the database directory should be returned.

Returns:StorageFile

A corresponding StorageFile object

newPersistentFile	back to summary
pack-priv abstract StorageFile newPersistentFile(String directoryName, String fileName) Construct a persistent StorageFile from a directory and path name. Parameters directoryName:String The path name of the directory. Guaranteed not to be in the temporary file directory. Guaranteed not to be null fileName:String The name of the file within the directory. Guaranteed not to be null. Returns:StorageFile A corresponding StorageFile object

newPersistentFile

back to summary

pack-priv abstract StorageFile newPersistentFile(String directoryName, String fileName)

Construct a persistent StorageFile from a directory and path name.

Parameters

directoryName:String: The path name of the directory. Guaranteed not to be in the temporary file directory. Guaranteed not to be null
fileName:String: The name of the file within the directory. Guaranteed not to be null.

Returns:StorageFile

A corresponding StorageFile object

newPersistentFile	back to summary
pack-priv abstract StorageFile newPersistentFile(StorageFile directoryName, String fileName) Construct a persistent StorageFile from a directory and path name. Parameters directoryName:StorageFile The path name of the directory. Guaranteed not to be to be null. Guaranteed to be created by a call to one of the newPersistentFile methods. fileName:String The name of the file within the directory. Guaranteed not to be null. Returns:StorageFile A corresponding StorageFile object

newPersistentFile

back to summary

pack-priv abstract StorageFile newPersistentFile(StorageFile directoryName, String fileName)

Construct a persistent StorageFile from a directory and path name.

Parameters

directoryName:StorageFile: The path name of the directory. Guaranteed not to be to be null. Guaranteed to be created by a call to one of the newPersistentFile methods.
fileName:String: The name of the file within the directory. Guaranteed not to be null.

Returns:StorageFile

A corresponding StorageFile object

newStorageFile	back to summary
public StorageFile newStorageFile(String path) Implements org.apache.derby.io.StorageFactory.newStorageFile. Construct a StorageFile from a path name. Parameters path:String The path name of the file Returns:StorageFile A corresponding StorageFile object

newStorageFile

back to summary

public StorageFile newStorageFile(String path)

Implements org.apache.derby.io.StorageFactory.newStorageFile.

Construct a StorageFile from a path name.

Parameters

path:String: The path name of the file

Returns:StorageFile

A corresponding StorageFile object

newStorageFile	back to summary
public StorageFile newStorageFile(String directoryName, String fileName) Implements org.apache.derby.io.StorageFactory.newStorageFile. Construct a StorageFile from a directory and file name. Parameters directoryName:String The directory part of the path name. fileName:String The name of the file within the directory. Returns:StorageFile A corresponding StorageFile object

newStorageFile

back to summary

public StorageFile newStorageFile(String directoryName, String fileName)

Implements org.apache.derby.io.StorageFactory.newStorageFile.

Construct a StorageFile from a directory and file name.

Parameters

directoryName:String: The directory part of the path name.
fileName:String: The name of the file within the directory.

Returns:StorageFile

A corresponding StorageFile object

newStorageFile	back to summary
public StorageFile newStorageFile(StorageFile directoryName, String fileName) Implements org.apache.derby.io.StorageFactory.newStorageFile. Construct a StorageFile from a directory and file name. Parameters directoryName:StorageFile The directory part of the path name. fileName:String The name of the file within the directory. Returns:StorageFile A corresponding StorageFile object

newStorageFile

back to summary

public StorageFile newStorageFile(StorageFile directoryName, String fileName)

Implements org.apache.derby.io.StorageFactory.newStorageFile.

Construct a StorageFile from a directory and file name.

Parameters

directoryName:StorageFile: The directory part of the path name.
fileName:String: The name of the file within the directory.

Returns:StorageFile

A corresponding StorageFile object

readOnlyTempRoot	back to summary
private String readOnlyTempRoot() throws IOException

setCanonicalName	back to summary
public void setCanonicalName(String name) Implements org.apache.derby.io.StorageFactory.setCanonicalName. Set the canonicalName. May need adjustment due to DERBY-5096 Parameters name:String uniquely identifiable name for this database

setCanonicalName

back to summary

public void setCanonicalName(String name)

Implements org.apache.derby.io.StorageFactory.setCanonicalName.

Set the canonicalName. May need adjustment due to DERBY-5096

Parameters

name:String: uniquely identifiable name for this database

shutdown	back to summary
public void shutdown() Implements org.apache.derby.io.StorageFactory.shutdown. Doc from org.apache.derby.io.StorageFactory.shutdown. The shutdown method is called during the normal shutdown of the database. However, the database engine cannot guarantee that shutdown will be called. If the JVM terminates abnormally then it will not be called.

shutdown

back to summary

public void shutdown()

Implements org.apache.derby.io.StorageFactory.shutdown.

Doc from org.apache.derby.io.StorageFactory.shutdown.

The shutdown method is called during the normal shutdown of the database. However, the database engine cannot guarantee that shutdown will be called. If the JVM terminates abnormally then it will not be called.

supportsRandomAccess	back to summary
public boolean supportsRandomAccess() Implements org.apache.derby.io.StorageFactory.supportsRandomAccess. Determine whether the storage supports random access. If random access is not supported then it will only be accessed using InputStreams and OutputStreams (if the database is writable). Returns:boolean true if the storage supports random access, false if it is writable.

supportsRandomAccess

back to summary

public boolean supportsRandomAccess()

Implements org.apache.derby.io.StorageFactory.supportsRandomAccess.

Determine whether the storage supports random access. If random access is not supported then it will only be accessed using InputStreams and OutputStreams (if the database is writable).

Returns:boolean: true if the storage supports random access, false if it is writable.

pack-priv abstract Class BaseStorageFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail