Modifier and Type	Class and Description
public static enum	Metadata.Property Enum of Ucanaccess driver properties.

Modifier and Type	Field and Description
private static final String	COLUMN_RECORD
private static final String	COLUMNS
private static final String	COLUMNS_VIEW
private final Connection	conn
private static final String	DROP_TABLE
private static final String	FK
private static final System.Logger	LOGGER
private static final String	PROP
private static final String	RENAME
private static final String	SCHEMA
private static final String	SELECT_COLUMN
private static final String	SELECT_COLUMN_ESCAPED
private static final String	SELECT_COLUMNS
private static final String	SELECT_NATIVE_COLUMN_DEF
private static final String	SELECT_TABLE_ESCAPED
private static final String	SELECT_TABLE_METADATA
private static final String	TABLE_RECORD
private static final String	TABLES
private static final String	UPDATE_COLUMN_DEF
private static final String	UPDATE_IS_GENERATEDCOLUMN

Access	Constructor and Description
public	Metadata(Connection conn)

Method Summary

Modifier and Type	Method and Description
public void	calculatedField(String tableName, String columnName)
public void	columnDef(String tableName, String columnName, String def)
public void	createMetadata()
public void	dropTable(String tableName)
public String	getColumnName(String escapedTableName, String escapedColumnName)
public List<String>	getColumnNames(String tableName)
public String	getEscapedColumnName(String tableName, String columnName)
public String	getEscapedTableName(String tableName)
public Integer	getTableId(String escapedName)
public String	getTableName(String escapedName)
public boolean	hasNativeColumnDefault(String tableName, String columnName) Returns whether the HSQLDB column has a default value, as opposed to a default applied by trigger or none at all.
public boolean	isAutoIncrement(String tableName, String columnName)
public boolean	isCurrency(String tableName, String columnName)
public void	loadProp()
public void	newColumn(String name, String escaped, String originalType, Integer idTable)
public Integer	newTable(String name, String escaped, ObjectType type)
public void	rename(String oldTableName, String newTableName, String newEscapedTableName)

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

COLUMN_RECORD	back to summary
private static final String COLUMN_RECORD

COLUMNS	back to summary
private static final String COLUMNS

COLUMNS_VIEW	back to summary
private static final String COLUMNS_VIEW

conn	back to summary
private final Connection conn

DROP_TABLE	back to summary
private static final String DROP_TABLE

FK	back to summary
private static final String FK

LOGGER	back to summary
private static final System.Logger LOGGER

PROP	back to summary
private static final String PROP

RENAME	back to summary
private static final String RENAME

SCHEMA	back to summary
private static final String SCHEMA

SELECT_COLUMN	back to summary
private static final String SELECT_COLUMN

SELECT_COLUMN_ESCAPED	back to summary
private static final String SELECT_COLUMN_ESCAPED

SELECT_COLUMNS	back to summary
private static final String SELECT_COLUMNS

SELECT_NATIVE_COLUMN_DEF	back to summary
private static final String SELECT_NATIVE_COLUMN_DEF

SELECT_TABLE_ESCAPED	back to summary
private static final String SELECT_TABLE_ESCAPED

TABLE_RECORD	back to summary
private static final String TABLE_RECORD

TABLES	back to summary
private static final String TABLES

UPDATE_COLUMN_DEF	back to summary
private static final String UPDATE_COLUMN_DEF

UPDATE_IS_GENERATEDCOLUMN	back to summary
private static final String UPDATE_IS_GENERATEDCOLUMN

Constructor Detail

Metadata	back to summary
public Metadata(Connection conn)

Method Detail

calculatedField	back to summary
public void calculatedField(String tableName, String columnName) throws SQLException

columnDef	back to summary
public void columnDef(String tableName, String columnName, String def) throws SQLException

createMetadata	back to summary
public void createMetadata() throws SQLException

dropTable	back to summary
public void dropTable(String tableName) throws SQLException

getColumnName	back to summary
public String getColumnName(String escapedTableName, String escapedColumnName) throws SQLException

getColumnNames	back to summary
public List<String> getColumnNames(String tableName) throws SQLException

getEscapedColumnName	back to summary
public String getEscapedColumnName(String tableName, String columnName) throws SQLException

getEscapedTableName	back to summary
public String getEscapedTableName(String tableName) throws SQLException

getTableId	back to summary
public Integer getTableId(String escapedName) throws SQLException

getTableName	back to summary
public String getTableName(String escapedName) throws SQLException

hasNativeColumnDefault	back to summary
public boolean hasNativeColumnDefault(String tableName, String columnName) throws SQLException Returns whether the HSQLDB column has a default value, as opposed to a default applied by trigger or none at all.

isAutoIncrement	back to summary
public boolean isAutoIncrement(String tableName, String columnName) throws SQLException

isCurrency	back to summary
public boolean isCurrency(String tableName, String columnName) throws SQLException

loadProp	back to summary
public void loadProp() throws SQLException

newColumn	back to summary
public void newColumn(String name, String escaped, String originalType, Integer idTable)

newTable	back to summary
public Integer newTable(String name, String escaped, ObjectType type) throws SQLException

rename	back to summary
public void rename(String oldTableName, String newTableName, String newEscapedTableName) throws SQLException

net.ucanaccess.converters back to summary

public final Enum Metadata.Property

Class Inheritance

extends Enum<Metadata.Property>

java.lang.Object
java.lang.Enum
net.ucanaccess.converters.Metadata.Property

Annotations

@SuppressWarnings:java:S115, ImmutableEnumChecker

Enum of Ucanaccess driver properties.

Author: Markus Spann
Since: v5.1.0

Field Summary

Modifier and Type	Field and Description
public static final Metadata.Property	allowRemoteLinks Whether linked tables that point to a network/UNC path (e.g. `\\server\share\db.accdb`) may be resolved automatically.
public static final Metadata.Property	charset
public static final Metadata.Property	columnOrder
public static final Metadata.Property	concatNulls
private final Object	defaultValue
private final String	description
public static final Metadata.Property	encrypt
public static final Metadata.Property	ignoreCase
public static final Metadata.Property	immediatelyReleaseResources
public static final Metadata.Property	inactivityTimeout
public static final Metadata.Property	jackcessOpener Fully qualified class name of a custom `IJackcessOpenerInterface` implementation to use for opening/decrypting the database file.
public static final Metadata.Property	keepMirror
public static final Metadata.Property	lobScale
public static final Metadata.Property	lockMdb
private final int	maxLen
public static final Metadata.Property	memory
public static final Metadata.Property	mirrorFolder
public static final Metadata.Property	newDatabaseVersion
public static final Metadata.Property	openExclusive
public static final Metadata.Property	password
public static final Metadata.Property	preventReloading
public static final Metadata.Property	readOnlyMirror
public static final Metadata.Property	reMap
public static final Metadata.Property	showSchema
public static final Metadata.Property	singleConnection
public static final Metadata.Property	skipIndexes
public static final Metadata.Property	supportsAccessLike
public static final Metadata.Property	sysSchema
private final Class<?>	type
public static final Metadata.Property	user
private final List<Object>	validValues

Constructor Summary

Access	Constructor and Description
private < property data type parameter T>	Property(Class<T> data type type, T default value defaultValue, int maximum length maxLen, Object... optional valid values validValues) Constructs a Property enum member.

Method Summary

Modifier and Type	Method and Description
public Object	getDefaultValue()
public String	getDescription()
public int	getMaxLen()
public Class<?>	getType()
public boolean	isValidValue(Object val)
public static Metadata.Property	parse(Object val)
public static Metadata.Property	valueOf(String name)
public static Metadata.Property[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

allowRemoteLinks back to summary

allowRemoteLinks	back to summary
public static final Metadata.Property allowRemoteLinks Whether linked tables that point to a network/UNC path (e.g. `\\server\share\db.accdb`) may be resolved automatically. Security Note the path of a linked table is taken verbatim from the Access database file being opened. If that file is not fully trusted, an attacker-controlled link could otherwise make the JVM open an arbitrary network/UNC path as soon as the linked table is accessed (e.g. to reach an internal host or trigger an outbound credential-relay attempt). Automatic resolution of such paths is therefore denied by default; enable this property only when linked network paths are known to be trusted. Local (non-UNC) linked paths are not affected by this property.

public static final Metadata.Property allowRemoteLinks

Whether linked tables that point to a network/UNC path (e.g. \\server\share\db.accdb) may be resolved automatically.

Security Note

the path of a linked table is taken verbatim from the Access database file being opened. If that file is not fully trusted, an attacker-controlled link could otherwise make the JVM open an arbitrary network/UNC path as soon as the linked table is accessed (e.g. to reach an internal host or trigger an outbound credential-relay attempt). Automatic resolution of such paths is therefore denied by default; enable this property only when linked network paths are known to be trusted. Local (non-UNC) linked paths are not affected by this property.

charset	back to summary
public static final Metadata.Property charset

columnOrder	back to summary
public static final Metadata.Property columnOrder

concatNulls	back to summary
public static final Metadata.Property concatNulls

defaultValue	back to summary
private final Object defaultValue

description	back to summary
private final String description

encrypt	back to summary
public static final Metadata.Property encrypt

ignoreCase	back to summary
public static final Metadata.Property ignoreCase

immediatelyReleaseResources	back to summary
public static final Metadata.Property immediatelyReleaseResources

inactivityTimeout	back to summary
public static final Metadata.Property inactivityTimeout

jackcessOpener back to summary

public static final Metadata.Property jackcessOpener

Fully qualified class name of a custom IJackcessOpenerInterface implementation to use for opening/decrypting the database file.

Security Note

the value of this property is instantiated via reflection using its public no-arg constructor. It must therefore only ever be set from trusted, static application configuration. Never populate this property from untrusted or user-supplied input (e.g. HTTP request parameters, values forwarded unchecked from an external system), as doing so allows an attacker to trigger the construction of an arbitrary class implementing IJackcessOpenerInterface that is reachable on the application's classpath.

keepMirror	back to summary
public static final Metadata.Property keepMirror

lobScale	back to summary
public static final Metadata.Property lobScale

lockMdb	back to summary
public static final Metadata.Property lockMdb

maxLen	back to summary
private final int maxLen

memory	back to summary
public static final Metadata.Property memory

mirrorFolder	back to summary
public static final Metadata.Property mirrorFolder

newDatabaseVersion	back to summary
public static final Metadata.Property newDatabaseVersion

openExclusive	back to summary
public static final Metadata.Property openExclusive

password	back to summary
public static final Metadata.Property password

preventReloading	back to summary
public static final Metadata.Property preventReloading

readOnlyMirror	back to summary
public static final Metadata.Property readOnlyMirror

reMap	back to summary
public static final Metadata.Property reMap

showSchema	back to summary
public static final Metadata.Property showSchema

singleConnection	back to summary
public static final Metadata.Property singleConnection

skipIndexes	back to summary
public static final Metadata.Property skipIndexes

supportsAccessLike	back to summary
public static final Metadata.Property supportsAccessLike

sysSchema	back to summary
public static final Metadata.Property sysSchema

type	back to summary
private final Class<?> type

user	back to summary
public static final Metadata.Property user

validValues	back to summary
private final List<Object> validValues

Constructor Detail

Property

back to summary

private <T> Property(Class<T> type, T defaultValue, int maxLen, Object... validValues)

Constructs a Property enum member.

Parameters

<T>: property data type parameter
type:Class<T>: data type
defaultValue:T: default value
maxLen:int: maximum length
validValues:Object[]: optional valid values

Method Detail

getDefaultValue	back to summary
public Object getDefaultValue()

getDescription	back to summary
public String getDescription()

getMaxLen	back to summary
public int getMaxLen()

getType	back to summary
public Class<?> getType()

isValidValue	back to summary
public boolean isValidValue(Object val)

parse	back to summary
public static Metadata.Property parse(Object val)

valueOf	back to summary
public static Metadata.Property valueOf(String name)

values	back to summary
public static Metadata.Property[] values()

public Class Metadata

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Metadata.Property

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail