H2 Database Engine 2.3.232 · org.h2.engine.ConnectionInfo

Modifier and Type	Field and Description
private byte[]	fileEncryptionKey
private byte[]	filePasswordHash
private static final HashSet<String>	IGNORED_BY_PARSER
private static final HashSet<String>	KNOWN_SETTINGS
private String	name The database name
private String	nameNormalized
private NetworkConnectionInfo	networkConnectionInfo
private String	originalURL
private boolean	persistent
private Properties	prop
private boolean	remote
private boolean	ssl
private TimeZoneProvider	timeZone
private boolean	unnamed
private String	url
private String	user
private byte[]	userPasswordHash

Access	Constructor and Description
public	ConnectionInfo(String the database name (including tags), but without the "jdbc:h2:" prefix name) Create a connection info object.
public	ConnectionInfo(String the database URL (must start with jdbc:h2:) u, Properties the connection properties or `null` info, String the user name or `null` user, Object the password as `String` or `char[]`, or `null` password) Create a connection info object.

Method Summary

Modifier and Type	Method and Description
public void	cleanAuthenticationInfo() Clear authentication properties.
public ConnectionInfo	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
private void	convertPasswords() Split the password property into file password and user password if necessary, and convert them to the internal hash format.
public DbSettings	getDbSettings()
pack-priv byte[]	getFileEncryptionKey()
public byte[]	Returns: the password hash or null getFilePasswordHash() Get the file password hash if it is set.
pack-priv DbException	Returns: the exception getFormatException() Generate a URL format exception.
pack-priv int	Returns: the value as an integer getIntProperty(int the setting id setting, int the default value defaultValue) Get the value of the given property.
pack-priv String[]	Returns: the property keys getKeys() Get the property keys.
public String	Returns: the database name getName() Get the unique and normalized database name (excluding settings).
public NetworkConnectionInfo	Returns: the network connection information, or `null` getNetworkConnectionInfo() Returns the network connection information, or `null`.
public String	Returns: the database URL getOriginalURL() Get the complete original database URL.
public boolean	Returns: the value getProperty(String the property name key, boolean the default value defaultValue) Get a boolean property if it is set and return the value.
pack-priv String	Returns: the value as a String getProperty(String the property key key) Get the value of the given property.
pack-priv int	Returns: the value as a String getProperty(String the property key key, int the default value defaultValue) Get the value of the given property.
public String	Returns: the value as a String getProperty(String the property key key, String the default value defaultValue) Get the value of the given property.
pack-priv String	Returns: the value as a String getProperty(int the setting id setting, String the default value defaultValue) Get the value of the given property.
public TimeZoneProvider	Returns: the time zone getTimeZone() Returns the time zone.
public String	Returns: the URL getURL() Get the database URL.
public String	Returns: the user name getUserName() Get the name of the user.
pack-priv byte[]	Returns: the password hash getUserPasswordHash() Get the user password hash.
private static byte[]	hashPassword(boolean passwordHash, String userName, char[] password)
public static boolean	Returns: whether setting with the specified name should be ignored by parser isIgnoredByParser(String the name of the setting name) Returns whether setting with the specified name should be ignored by parser.
private static boolean	isKnownSetting(String s)
public boolean	Returns: true if it is isPersistent() Check if the referenced database is persistent.
public boolean	Returns: true if it is isRemote() Check if this is a remote connection.
pack-priv boolean	Returns: true if it is isSSL() Check if this is a remote connection with SSL enabled.
pack-priv boolean	Returns: true if it is isUnnamedInMemory() Check if the referenced database is an unnamed in-memory database.
private void	parseName()
private void	preservePasswordForAuthentication(Object password)
private void	readProperties(Properties info)
private void	readSettingsFromURL()
private static String	remapURL(String url)
private char[]	removePassword()
public boolean	Returns: the value removeProperty(String the property name key, boolean the default value defaultValue) Remove a boolean property if it is set and return the value.
pack-priv String	Returns: the value removeProperty(String the property name key, String the default value defaultValue) Remove a String property if it is set and return the value.
public void	setBaseDir(String the new base directory dir) Set the base directory of persistent databases, unless the database is in the user home folder (~).
public void	setFileEncryptionKey(byte[] key)
public void	setFilePasswordHash(byte[] the new hash value hash) Set the file password hash.
public void	setNetworkConnectionInfo(NetworkConnectionInfo the network connection information networkConnectionInfo) Sets the network connection information.
public void	setOriginalURL(String the database url url) Set the original database URL.
public void	setProperty(String the property name key, String the value value) Overwrite a property.
public void	setServerKey(String the server name, '/', and the security key serverKey) Switch to server mode, and set the server name and database key.
public void	setUserName(String the user name name) Overwrite the user name.
public void	setUserPasswordHash(byte[] the new hash value hash) Set the user password hash.

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

fileEncryptionKey	back to summary
private byte[] fileEncryptionKey

filePasswordHash	back to summary
private byte[] filePasswordHash

IGNORED_BY_PARSER	back to summary
private static final HashSet<String> IGNORED_BY_PARSER

KNOWN_SETTINGS	back to summary
private static final HashSet<String> KNOWN_SETTINGS

name	back to summary
private String name The database name

nameNormalized	back to summary
private String nameNormalized

networkConnectionInfo	back to summary
private NetworkConnectionInfo networkConnectionInfo

originalURL	back to summary
private String originalURL

persistent	back to summary
private boolean persistent

prop	back to summary
private Properties prop

remote	back to summary
private boolean remote

ssl	back to summary
private boolean ssl

timeZone	back to summary
private TimeZoneProvider timeZone

unnamed	back to summary
private boolean unnamed

url	back to summary
private String url

user	back to summary
private String user

userPasswordHash	back to summary
private byte[] userPasswordHash

ConnectionInfo	back to summary
public ConnectionInfo(String name) Create a connection info object. Parameters name:String the database name (including tags), but without the "jdbc:h2:" prefix

ConnectionInfo	back to summary
public ConnectionInfo(String u, Properties info, String user, Object password) Create a connection info object. Parameters u:String the database URL (must start with jdbc:h2:) info:Properties the connection properties or `null` user:String the user name or `null` password:Object the password as `String` or `char[]`, or `null`

Method Detail

cleanAuthenticationInfo	back to summary
public void cleanAuthenticationInfo() Clear authentication properties.

clone back to summary

clone	back to summary
public ConnectionInfo clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:ConnectionInfo a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

public ConnectionInfo clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:ConnectionInfo

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

convertPasswords	back to summary
private void convertPasswords() Split the password property into file password and user password if necessary, and convert them to the internal hash format.

getDbSettings	back to summary
public DbSettings getDbSettings()

getFileEncryptionKey	back to summary
pack-priv byte[] getFileEncryptionKey()

getFilePasswordHash	back to summary
public byte[] getFilePasswordHash() Get the file password hash if it is set. Returns:byte[] the password hash or null

getFilePasswordHash

public Class ConnectionInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail