Modifier and Type	Class and Description
private static class	DBReference.MemoryTimer
private static class	DBReference.UniqueString Unique string based on current date/time and a unique id.

Field Summary

Modifier and Type	Field and Description
private boolean	allowRemoteLinks Whether the `io.github.spannm.jackcess.util.LinkResolver` registered below may automatically resolve linked tables that point to a network/UNC path.
private Charset	charset
private static final String	CIPHER_SPEC
private boolean	columnOrderDisplay
private boolean	concatNulls
private final File	dbFile
private Database.FileFormat	dbFormat
private Database	dbIO
private boolean	encryptHSQLDB
private String	encryptionKey
private Map<String, String>	externalResourcesMapping
private FileLock	fileLock
private boolean	firstConnection
private boolean	hsqldbShutdown
private String	id
private boolean	ignoreCase
private boolean	immediatelyReleaseResources
private boolean	inMemory
private final IJackcessOpenerInterface	jko
private long	lastModified
private final Set<File>	links
private Integer	lobScale
private final System.Logger	logger
private final DBReference.MemoryTimer	memoryTimer
private File	mirrorFolder
private boolean	mirrorReadOnly
private boolean	mirrorRecreated
private static final String	MSG_COULD_NOT_CREATE
private static final String	MSG_COULD_NOT_DELETE
private static final String	MSG_CREATED_FILE
private static List<IOnReloadReferenceListener>	onReloadListeners
private boolean	openExclusive
private final Map<String, Table>	pinnedAutoNumberTables Holds strong references to `Table` instances on which a caller has explicitly toggled `allowAutoNumberInsert` (via `DISABLE`/`ENABLE AUTOINCREMENT ON`).
private boolean	preventReloading
private final String	pwd
private boolean	readOnly
private boolean	readOnlyFileFormat
private boolean	showSchema
private boolean	skipIndexes
private boolean	sysSchema
private File	tempHsql
private File	toKeepHsql
private static String	version

Constructor Summary

Access	Constructor and Description
public	DBReference(File fl, Database.FileFormat ff, IJackcessOpenerInterface jko, final String pwd, Charset charset)

Method Summary

Modifier and Type	Method and Description
public static boolean	addOnReloadRefListener(IOnReloadReferenceListener action)
private boolean	checkInside(Database db)
private boolean	checkInside()
pack-priv Connection	checkLastModified(Connection conn, Session session)
private void	closeHsqlDb(Session session)
private void	closeHsqlDb(Session session, boolean firstConnectionKeeptMirror)
private String	createId()
public void	decrementActiveConnection(Session session)
private File	fileLock()
private long	filesUpdateTime()
private void	finalizeHsqlDb(Session session)
pack-priv File	getDbFile()
public Database	getDbIO()
public Connection	getHSQLDBConnection(Session session)
private List<File>	getHSQLDBFiles()
private String	getHsqlUrl(Session session)
pack-priv String	getId()
public long	getInactivityTimeout()
private String	getKey()
private long	getLastUpdateHSQLDB()
public File	getToKeepHsql()
public static String	getVersion()
public void	incrementActiveConnection()
private void	initHSQLDB(Connection conn)
private static synchronized void	initVersion(Connection conn)
public static boolean	is2xx()
public boolean	isConcatNulls()
public boolean	isEncryptHSQLDB()
public boolean	isIgnoreCase()
public boolean	isInMemory()
pack-priv static boolean	Returns: `true` if the path is a network/UNC path, `false` otherwise isNetworkPath(String the linked database path as stored in the Access database file fileName) Determines whether the given linked database path is a network/UNC path, e.g. `\\server\share\db.accdb`, `//server/share/db.accdb` or a device-style UNC path such as `\\?\UNC\server\share\db.accdb`.
public boolean	isPreventReloading()
public boolean	isReadOnly()
pack-priv boolean	isReadOnlyFileFormat()
pack-priv boolean	isShowSchema()
pack-priv boolean	loadedFromKeptMirror(Session session)
private void	lockMdbFile()
public Database	open(File dbfl, String password)
pack-priv void	pinAutoNumberTable(String tableName, Table table) Pins the given table so it is not garbage-collected while an explicit `allowAutoNumberInsert` toggle (from `DISABLE`/`ENABLE AUTOINCREMENT ON`) is in effect on it.
public void	releaseLock()
public void	reloadDbIO()
public void	setAllowRemoteLinks(boolean `true` to allow automatic resolution of network/UNC linked paths allowRemoteLinks) Enables or disables automatic resolution of linked tables that point to a network/UNC path.
public void	setColumnOrderDisplay()
public void	setConcatNulls(boolean concatNulls)
public void	setEncryptHSQLDB(boolean encryptHSQLDB)
public void	setExternalResourcesMapping(Map<String, String> externalResourcesMapping)
private void	setIgnoreCase(Connection conn)
public void	setIgnoreCase(boolean ignoreCase)
public void	setImmediatelyReleaseResources(boolean immediatelyReleaseResources)
public void	setInactivityTimeout(int inactivityTimeout)
public void	setInMemory(boolean inMemory)
public void	setLobScale(Integer lobScale)
public void	setMirrorFolder(File mirrorFolder)
public void	setMirrorReadOnly(boolean mirrorReadOnly)
public void	setOpenExclusive(boolean openExclusive)
public void	setPreventReloading(boolean preventReloading)
public void	setShowSchema(boolean showSchema)
public void	setSkipIndexes(boolean skipIndexes)
public void	setSysSchema(boolean sysSchema)
public void	setToKeepHsql(File toKeepHsql)
pack-priv void	shutdown(Session session)
public void	updateLastModified()

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

Field Detail

allowRemoteLinks	back to summary
private boolean allowRemoteLinks Whether the `io.github.spannm.jackcess.util.LinkResolver` registered below may automatically resolve linked tables that point to a network/UNC path. `false` by default; see `net.ucanaccess.converters.Metadata.Property#allowRemoteLinks`.

charset	back to summary
private Charset charset

CIPHER_SPEC	back to summary
private static final String CIPHER_SPEC

columnOrderDisplay	back to summary
private boolean columnOrderDisplay

concatNulls	back to summary
private boolean concatNulls

dbFile	back to summary
private final File dbFile

dbFormat	back to summary
private Database.FileFormat dbFormat

dbIO	back to summary
private Database dbIO

encryptHSQLDB	back to summary
private boolean encryptHSQLDB

encryptionKey	back to summary
private String encryptionKey

externalResourcesMapping	back to summary
private Map<String, String> externalResourcesMapping

fileLock	back to summary
private FileLock fileLock

firstConnection	back to summary
private boolean firstConnection

hsqldbShutdown	back to summary
private boolean hsqldbShutdown

id	back to summary
private String id

ignoreCase	back to summary
private boolean ignoreCase

immediatelyReleaseResources	back to summary
private boolean immediatelyReleaseResources

inMemory	back to summary
private boolean inMemory

jko	back to summary
private final IJackcessOpenerInterface jko

lastModified	back to summary
private long lastModified

links	back to summary
private final Set<File> links

lobScale	back to summary
private Integer lobScale

logger	back to summary
private final System.Logger logger

memoryTimer	back to summary
private final DBReference.MemoryTimer memoryTimer

mirrorFolder	back to summary
private File mirrorFolder

mirrorReadOnly	back to summary
private boolean mirrorReadOnly

mirrorRecreated	back to summary
private boolean mirrorRecreated

MSG_COULD_NOT_CREATE	back to summary
private static final String MSG_COULD_NOT_CREATE

MSG_COULD_NOT_DELETE	back to summary
private static final String MSG_COULD_NOT_DELETE

MSG_CREATED_FILE	back to summary
private static final String MSG_CREATED_FILE

onReloadListeners	back to summary
private static List<IOnReloadReferenceListener> onReloadListeners

openExclusive	back to summary
private boolean openExclusive

pinnedAutoNumberTables back to summary

pinnedAutoNumberTables	back to summary
private final Map<String, Table> pinnedAutoNumberTables Holds strong references to `Table` instances on which a caller has explicitly toggled `allowAutoNumberInsert` (via `DISABLE`/`ENABLE AUTOINCREMENT ON`). Jackcess's internal table cache only holds `Table` objects via `WeakReference`s, so without this pin the GC could collect such a table between statements; the table would then be transparently reloaded on next access, silently resetting `allowAutoNumberInsert` to its default and losing the toggle.

private final Map<String, Table> pinnedAutoNumberTables

Holds strong references to Table instances on which a caller has explicitly toggled allowAutoNumberInsert (via DISABLE/ENABLE AUTOINCREMENT ON). Jackcess's internal table cache only holds Table objects via WeakReferences, so without this pin the GC could collect such a table between statements; the table would then be transparently reloaded on next access, silently resetting allowAutoNumberInsert to its default and losing the toggle.

preventReloading	back to summary
private boolean preventReloading

pwd	back to summary
private final String pwd

readOnly	back to summary
private boolean readOnly

readOnlyFileFormat	back to summary
private boolean readOnlyFileFormat

showSchema	back to summary
private boolean showSchema

skipIndexes	back to summary
private boolean skipIndexes

sysSchema	back to summary
private boolean sysSchema

tempHsql	back to summary
private File tempHsql

toKeepHsql	back to summary
private File toKeepHsql

version	back to summary
private static String version

Constructor Detail

DBReference	back to summary
public DBReference(File fl, Database.FileFormat ff, IJackcessOpenerInterface jko, final String pwd, Charset charset) throws IOException

Method Detail

addOnReloadRefListener	back to summary
public static boolean addOnReloadRefListener(IOnReloadReferenceListener action)

checkInside	back to summary
private boolean checkInside(Database db) throws IOException

checkInside	back to summary
private boolean checkInside() throws IOException

checkLastModified	back to summary
pack-priv Connection checkLastModified(Connection conn, Session session) throws UcanaccessSQLException

closeHsqlDb	back to summary
private void closeHsqlDb(Session session) throws IOException

closeHsqlDb	back to summary
private void closeHsqlDb(Session session, boolean firstConnectionKeeptMirror) throws IOException

createId	back to summary
private String createId()

decrementActiveConnection	back to summary
public void decrementActiveConnection(Session session)

fileLock	back to summary
private File fileLock()

filesUpdateTime	back to summary
private long filesUpdateTime()

finalizeHsqlDb	back to summary
private void finalizeHsqlDb(Session session) throws IOException

getDbFile	back to summary
pack-priv File getDbFile()

getDbIO	back to summary
public Database getDbIO()

getHSQLDBConnection	back to summary
public Connection getHSQLDBConnection(Session session) throws SQLException

getHSQLDBFiles	back to summary
private List<File> getHSQLDBFiles()

getHsqlUrl	back to summary
private String getHsqlUrl(Session session) throws SQLException

getId	back to summary
pack-priv String getId()

getInactivityTimeout	back to summary
public long getInactivityTimeout()

getKey	back to summary
private String getKey() throws SQLException

getLastUpdateHSQLDB	back to summary
private long getLastUpdateHSQLDB()

getToKeepHsql	back to summary
public File getToKeepHsql()

getVersion	back to summary
public static String getVersion()

incrementActiveConnection	back to summary
public void incrementActiveConnection()

initHSQLDB	back to summary
private void initHSQLDB(Connection conn)

initVersion	back to summary
private static synchronized void initVersion(Connection conn) throws SQLException

is2xx	back to summary
public static boolean is2xx()

isConcatNulls	back to summary
public boolean isConcatNulls()

isEncryptHSQLDB	back to summary
public boolean isEncryptHSQLDB()

isIgnoreCase	back to summary
public boolean isIgnoreCase()

isInMemory	back to summary
public boolean isInMemory()

isNetworkPath back to summary

pack-priv static boolean isNetworkPath(String fileName)

Determines whether the given linked database path is a network/UNC path, e.g. \\server\share\db.accdb, //server/share/db.accdb or a device-style UNC path such as \\?\UNC\server\share\db.accdb.

Such paths are excluded from automatic resolution by default since they let an untrusted Access database file trigger an outbound network connection (see allowRemoteLinks).

Parameters

fileName:String: the linked database path as stored in the Access database file

Returns:boolean

true if the path is a network/UNC path, false otherwise

isPreventReloading	back to summary
public boolean isPreventReloading()

isReadOnly	back to summary
public boolean isReadOnly() throws UcanaccessSQLException

isReadOnlyFileFormat	back to summary
pack-priv boolean isReadOnlyFileFormat()

isShowSchema	back to summary
pack-priv boolean isShowSchema()

loadedFromKeptMirror	back to summary
pack-priv boolean loadedFromKeptMirror(Session session) throws UcanaccessSQLException

lockMdbFile	back to summary
private void lockMdbFile() throws UcanaccessSQLException

open	back to summary
public Database open(File dbfl, String password) throws IOException

pinAutoNumberTable	back to summary
pack-priv void pinAutoNumberTable(String tableName, Table table) Pins the given table so it is not garbage-collected while an explicit `allowAutoNumberInsert` toggle (from `DISABLE`/`ENABLE AUTOINCREMENT ON`) is in effect on it.

releaseLock	back to summary
public void releaseLock() throws IOException

reloadDbIO	back to summary
public void reloadDbIO() throws IOException

setAllowRemoteLinks back to summary

public void setAllowRemoteLinks(boolean allowRemoteLinks)

Enables or disables automatic resolution of linked tables that point to a network/UNC path.

Disabled by default; see the security note on net.ucanaccess.converters.Metadata.Property#allowRemoteLinks for why this matters when opening database files from an untrusted source.

Parameters

allowRemoteLinks:boolean: true to allow automatic resolution of network/UNC linked paths

setColumnOrderDisplay	back to summary
public void setColumnOrderDisplay()

setConcatNulls	back to summary
public void setConcatNulls(boolean concatNulls)

setEncryptHSQLDB	back to summary
public void setEncryptHSQLDB(boolean encryptHSQLDB)

setExternalResourcesMapping	back to summary
public void setExternalResourcesMapping(Map<String, String> externalResourcesMapping)

setIgnoreCase	back to summary
private void setIgnoreCase(Connection conn)

setIgnoreCase	back to summary
public void setIgnoreCase(boolean ignoreCase)

setImmediatelyReleaseResources	back to summary
public void setImmediatelyReleaseResources(boolean immediatelyReleaseResources)

setInactivityTimeout	back to summary
public void setInactivityTimeout(int inactivityTimeout)

setInMemory	back to summary
public void setInMemory(boolean inMemory)

setLobScale	back to summary
public void setLobScale(Integer lobScale)

setMirrorFolder	back to summary
public void setMirrorFolder(File mirrorFolder)

setMirrorReadOnly	back to summary
public void setMirrorReadOnly(boolean mirrorReadOnly)

setOpenExclusive	back to summary
public void setOpenExclusive(boolean openExclusive)

setPreventReloading	back to summary
public void setPreventReloading(boolean preventReloading)

setShowSchema	back to summary
public void setShowSchema(boolean showSchema)

setSkipIndexes	back to summary
public void setSkipIndexes(boolean skipIndexes)

setSysSchema	back to summary
public void setSysSchema(boolean sysSchema)

setToKeepHsql	back to summary
public void setToKeepHsql(File toKeepHsql)

shutdown	back to summary
pack-priv void shutdown(Session session) throws Exception

updateLastModified	back to summary
public void updateLastModified()

net.ucanaccess.jdbc back to summary

private Class DBReference.MemoryTimer

Class Inheritance

extends Object

java.lang.Object
net.ucanaccess.jdbc.DBReference.MemoryTimer

Field Summary

Modifier and Type	Field and Description
private int	activeConnection
private final DBReference	dbReference
private static final long	INACTIVITY_TIMEOUT_DEFAULT
private long	inactivityTimeout
private long	lastConnectionTime
private final System.Logger	logger
private final Timer	timer

Constructor Summary

Access	Constructor and Description
pack-priv	MemoryTimer(DBReference dbReference)

Method Summary

Modifier and Type	Method and Description
pack-priv synchronized void	decrementActiveConnection(final Session session)
pack-priv synchronized int	getActiveConnection()
pack-priv synchronized long	getLastConnectionTime()
pack-priv synchronized void	incrementActiveConnection()
pack-priv void	setInactivityTimeout(int inactivityTimeout)

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

Field Detail

activeConnection	back to summary
private int activeConnection

dbReference	back to summary
private final DBReference dbReference

INACTIVITY_TIMEOUT_DEFAULT	back to summary
private static final long INACTIVITY_TIMEOUT_DEFAULT

inactivityTimeout	back to summary
private long inactivityTimeout

lastConnectionTime	back to summary
private long lastConnectionTime

logger	back to summary
private final System.Logger logger

timer	back to summary
private final Timer timer

Constructor Detail

MemoryTimer	back to summary
pack-priv MemoryTimer(DBReference dbReference)

Method Detail

decrementActiveConnection	back to summary
pack-priv synchronized void decrementActiveConnection(final Session session)

getActiveConnection	back to summary
pack-priv synchronized int getActiveConnection()

getLastConnectionTime	back to summary
pack-priv synchronized long getLastConnectionTime()

incrementActiveConnection	back to summary
pack-priv synchronized void incrementActiveConnection()

setInactivityTimeout	back to summary
pack-priv void setInactivityTimeout(int inactivityTimeout)

net.ucanaccess.jdbc back to summary

private final Class DBReference.UniqueString

Class Inheritance

extends Object

java.lang.Object
net.ucanaccess.jdbc.DBReference.UniqueString

Unique string based on current date/time and a unique id.

Field Summary

Modifier and Type	Field and Description
private static final AtomicInteger	COUNTER
private static final DateTimeFormatter	FORMATTER
private final String	name

Constructor Summary

Access	Constructor and Description
private	UniqueString()

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

COUNTER	back to summary
private static final AtomicInteger COUNTER

FORMATTER	back to summary
private static final DateTimeFormatter FORMATTER

name	back to summary
private final String name

Constructor Detail

UniqueString	back to summary
private UniqueString()

Method Detail

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public final Class DBReference

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DBReference.MemoryTimer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DBReference.UniqueString

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail