Modifier and Type	Class and Description
private class	WebServer.TranslateThread The translate thread reads and writes the file translation.properties once a second.

Modifier and Type	Field and Description
private byte[]	adminPassword
private boolean	allowChunked
private boolean	allowOthers
private boolean	allowSecureCreation
private static final String	COMMAND_HISTORY
private String	commandHistoryString
private final HashMap<String, ConnectionInfo>	connInfoMap
private static final String	DEFAULT_LANGUAGE
private String	externalNames
private static final String[]	GENERIC
private String	host
private boolean	ifExists
private boolean	isDaemon
private String	key
pack-priv static final String[][]	LANGUAGES
private final HashSet<String>	languages
private long	lastTimeoutCheck
private Thread	listenerThread
private int	port
private final Set<WebThread>	running
private String	serverPropertiesDir
private ServerSocket	serverSocket
private static final long	SESSION_TIMEOUT The session timeout (the default is 30 minutes).
private final HashMap<String, WebSession>	sessions
private ShutdownHandler	shutdownHandler
private boolean	ssl
private String	startDateTime
private static int	ticker
private boolean	trace
private WebServer.TranslateThread	translateThread
private String	url
pack-priv boolean	virtualThreads

Access	Constructor and Description
public	WebServer()

Method Summary

Modifier and Type	Method and Description
public String	Returns: the URL of the web site to access this connection addSession(Connection the connection conn) Create a session with a given connection.
pack-priv boolean	Returns: true if admin password not configure, or admin password correct checkAdminPassword(String the password to test password) Check the admin password.
pack-priv WebSession	Returns: the web session object createNewSession(String the host address hostAddr) Create a new web session id and object.
public static String	Returns: a salt and hash of salted password as a hex encoded string to be used in configuration file encodeAdminPassword(String the password password) Generates a random salt and returns it with a hash of specified password with this salt.
private static String	generateSessionId()
pack-priv byte[]	getAdminPassword()
pack-priv boolean	getAllowChunked()
public boolean	getAllowOthers() Implements org.h2.server.Service.getAllowOthers. Check if remote connections are allowed.
public ArrayList<String>	getCommandHistoryList()
pack-priv Connection	Returns: the database connection getConnection(String the driver class name driver, String the database URL databaseUrl, String the user name user, String the password password, String the key of privileged user userKey, NetworkConnectionInfo the network connection information networkConnectionInfo) Open a database connection.
pack-priv String	getExternalNames()
pack-priv byte[]	Returns: the data getFile(String the file name file) Read the given file from the file system or from the resources.
public String	Returns: host name getHost()
pack-priv String	Returns: key key, or null getKey() Returns the key for privileged connections.
public String	getName() Implements org.h2.server.Service.getName. Get the human readable name of the service.
public int	getPort() Implements org.h2.server.Service.getPort. Gets the port this service is listening on.
pack-priv WebSession	Returns: the web session or null getSession(String the session id sessionId) Get the web session object for the given session id.
pack-priv ArrayList<HashMap<String, Object>>	getSessions()
pack-priv ConnectionInfo	Returns: the connection information getSetting(String the setting name name) Get the connection information for this setting.
pack-priv String[]	Returns: the connection info names getSettingNames() Get the list of connection information setting names.
pack-priv synchronized ArrayList<ConnectionInfo>	Returns: the list getSettings() Get the list of connection info objects.
pack-priv boolean	getSSL()
pack-priv String	getStartDateTime()
public String	getType() Implements org.h2.server.Service.getType. Get the human readable short name of the service.
public String	getURL() Implements org.h2.server.Service.getURL. Get the URL of this service in a human readable form
public void	init(String... the command line options args) Implements org.h2.server.Service.init. Initialize the service from command line options.
public boolean	isCommandHistoryAllowed()
public boolean	isDaemon() Implements org.h2.server.Service.isDaemon. Check if a daemon thread should be used.
public boolean	isRunning(boolean if errors should be written traceError) Implements org.h2.server.Service.isRunning. Check if the service is running.
public boolean	isStopped()
public void	listen() Implements org.h2.server.Service.listen. Listen for incoming connections.
private Properties	loadProperties()
pack-priv void	readTranslations(WebSession the session session, String the language language) Read the translation for this language and save them in the 'text' property of this session.
pack-priv synchronized void	remove(WebThread the thread to remove t) Remove this web thread from the set of running threads.
pack-priv void	removeSetting(String the setting to remove name) Remove a connection information setting from the list
public void	saveCommandHistoryList(ArrayList<String> the history commandHistory) Save the command history to the properties file.
pack-priv synchronized void	saveProperties(Properties null or the properties webPort, webAllowOthers, and webSSL prop) Save the settings to the properties file.
pack-priv void	setAdminPassword(String password)
pack-priv void	setAllowChunked(boolean allowChunked)
pack-priv void	setAllowOthers(boolean b)
public void	setAllowSecureCreation(boolean whether creation of databases using the key should be allowed allowSecureCreation)
public void	setCommandHistoryAllowed(boolean allowed)
pack-priv void	setExternalNames(String externalNames)
public void	setKey(String key, or null key) Sets the key for privileged connections.
pack-priv void	setPort(int port)
public void	setShutdownHandler(ShutdownHandler shutdownHandler)
pack-priv void	setSSL(boolean b)
pack-priv void	shutdown() Shut down the web server.
public void	start() Implements org.h2.server.Service.start. Start the service.
pack-priv String	Returns: the name of the file to translate startTranslate(Map<Object, Object> the translation map translation) Start the translation thread that reads the file once a second.
public void	stop() Implements org.h2.server.Service.stop. Stop the service.
pack-priv boolean	Returns: true if a translation is available supportsLanguage(String the language language) Check if this language is supported / translated.
pack-priv void	trace(String the message to write s) Write trace information if trace is enabled.
pack-priv void	traceError(Throwable the exception e) Write the stack trace if trace is enabled.
pack-priv void	updateSetting(ConnectionInfo the connection information info) Update a connection information setting.
private void	updateURL()

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

Field Detail

adminPassword	back to summary
private byte[] adminPassword

allowChunked	back to summary
private boolean allowChunked

allowOthers	back to summary
private boolean allowOthers

allowSecureCreation	back to summary
private boolean allowSecureCreation

COMMAND_HISTORY	back to summary
private static final String COMMAND_HISTORY

commandHistoryString	back to summary
private String commandHistoryString

connInfoMap	back to summary
private final HashMap<String, ConnectionInfo> connInfoMap

DEFAULT_LANGUAGE	back to summary
private static final String DEFAULT_LANGUAGE

externalNames	back to summary
private String externalNames

GENERIC	back to summary
private static final String[] GENERIC

host	back to summary
private String host

ifExists	back to summary
private boolean ifExists

isDaemon	back to summary
private boolean isDaemon

key	back to summary
private String key

LANGUAGES	back to summary
pack-priv static final String[][] LANGUAGES

languages	back to summary
private final HashSet<String> languages

lastTimeoutCheck	back to summary
private long lastTimeoutCheck

listenerThread	back to summary
private Thread listenerThread

port	back to summary
private int port

running	back to summary
private final Set<WebThread> running

serverPropertiesDir	back to summary
private String serverPropertiesDir

serverSocket	back to summary
private ServerSocket serverSocket

SESSION_TIMEOUT	back to summary
private static final long SESSION_TIMEOUT The session timeout (the default is 30 minutes).

sessions	back to summary
private final HashMap<String, WebSession> sessions

shutdownHandler	back to summary
private ShutdownHandler shutdownHandler

ssl	back to summary
private boolean ssl

startDateTime	back to summary
private String startDateTime

ticker	back to summary
private static int ticker

trace	back to summary
private boolean trace

translateThread	back to summary
private WebServer.TranslateThread translateThread

url	back to summary
private String url

virtualThreads	back to summary
pack-priv boolean virtualThreads

Constructor Detail

WebServer	back to summary
public WebServer()

Method Detail

addSession	back to summary
public String addSession(Connection conn) throws SQLException Create a session with a given connection. Parameters conn:Connection the connection Returns:String the URL of the web site to access this connection Exceptions SQLException: on failure

addSession

back to summary

public String addSession(Connection conn) throws SQLException

Create a session with a given connection.

Parameters

conn:Connection: the connection

Returns:String

the URL of the web site to access this connection

Exceptions

SQLException:: on failure

checkAdminPassword	back to summary
pack-priv boolean checkAdminPassword(String password) Check the admin password. Parameters password:String the password to test Returns:boolean true if admin password not configure, or admin password correct

checkAdminPassword

back to summary

pack-priv boolean checkAdminPassword(String password)

Check the admin password.

Parameters

password:String: the password to test

Returns:boolean

true if admin password not configure, or admin password correct

createNewSession	back to summary
pack-priv WebSession createNewSession(String hostAddr) Create a new web session id and object. Parameters hostAddr:String the host address Returns:WebSession the web session object

createNewSession

back to summary

pack-priv WebSession createNewSession(String hostAddr)

Create a new web session id and object.

Parameters

hostAddr:String: the host address

Returns:WebSession

the web session object

encodeAdminPassword	back to summary
public static String encodeAdminPassword(String password) Generates a random salt and returns it with a hash of specified password with this salt. Parameters password:String the password Returns:String a salt and hash of salted password as a hex encoded string to be used in configuration file Exceptions IllegalArgumentException: when password is too short

encodeAdminPassword

back to summary

public static String encodeAdminPassword(String password)

Generates a random salt and returns it with a hash of specified password with this salt.

Parameters

password:String: the password

Returns:String

a salt and hash of salted password as a hex encoded string to be used in configuration file

Exceptions

IllegalArgumentException:: when password is too short

generateSessionId	back to summary
private static String generateSessionId()

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

getAllowChunked	back to summary
pack-priv boolean getAllowChunked()

getAllowOthers	back to summary
public boolean getAllowOthers() Implements org.h2.server.Service.getAllowOthers. Doc from org.h2.server.Service.getAllowOthers. Check if remote connections are allowed. Returns:boolean true if remote connections are allowed Annotations @Override

getAllowOthers

back to summary

public boolean getAllowOthers()

Implements org.h2.server.Service.getAllowOthers.

Doc from org.h2.server.Service.getAllowOthers.

Check if remote connections are allowed.

Returns:boolean

true if remote connections are allowed

Annotations

@Override

getCommandHistoryList	back to summary
public ArrayList<String> getCommandHistoryList()

getConnection	back to summary
pack-priv Connection getConnection(String driver, String databaseUrl, String user, String password, String userKey, NetworkConnectionInfo networkConnectionInfo) throws SQLException Open a database connection. Parameters driver:String the driver class name databaseUrl:String the database URL user:String the user name password:String the password userKey:String the key of privileged user networkConnectionInfo:NetworkConnectionInfo the network connection information Returns:Connection the database connection Exceptions SQLException: on failure

getConnection

back to summary

pack-priv Connection getConnection(String driver, String databaseUrl, String user, String password, String userKey, NetworkConnectionInfo networkConnectionInfo) throws SQLException

Open a database connection.

Parameters

driver:String: the driver class name
databaseUrl:String: the database URL
user:String: the user name
password:String: the password
userKey:String: the key of privileged user
networkConnectionInfo:NetworkConnectionInfo: the network connection information

Returns:Connection

the database connection

Exceptions

SQLException:: on failure

getExternalNames	back to summary
pack-priv String getExternalNames()

getFile	back to summary
pack-priv byte[] getFile(String file) throws IOException Read the given file from the file system or from the resources. Parameters file:String the file name Returns:byte[] the data Exceptions IOException: on failure

getFile

back to summary

pack-priv byte[] getFile(String file) throws IOException

Read the given file from the file system or from the resources.

Parameters

file:String: the file name

Returns:byte[]

the data

Exceptions

IOException:: on failure

getHost	back to summary
public String getHost() Returns:String host name

getKey

back to summary

pack-priv String getKey()

Returns the key for privileged connections.

Returns:String: key key, or null

getName

back to summary

public String getName()

Implements org.h2.server.Service.getName.

Doc from org.h2.server.Service.getName.

Get the human readable name of the service.

Returns:String

the name

Annotations

@Override

getPort

back to summary

public int getPort()

Implements org.h2.server.Service.getPort.

Doc from org.h2.server.Service.getPort.

Gets the port this service is listening on.

Returns:int

the port

Annotations

@Override

getSession

back to summary

pack-priv WebSession getSession(String sessionId)

Get the web session object for the given session id.

Parameters

sessionId:String: the session id

Returns:WebSession

the web session or null

getSessions	back to summary
pack-priv ArrayList<HashMap<String, Object>> getSessions()

getSetting

back to summary

pack-priv ConnectionInfo getSetting(String name)

Get the connection information for this setting.

Parameters

name:String: the setting name

Returns:ConnectionInfo

the connection information

getSettingNames

back to summary

pack-priv String[] getSettingNames()

Get the list of connection information setting names.

Returns:String[]: the connection info names

getSettings

back to summary

pack-priv synchronized ArrayList<ConnectionInfo> getSettings()

Get the list of connection info objects.

Returns:ArrayList<ConnectionInfo>: the list

getSSL	back to summary
pack-priv boolean getSSL()

getStartDateTime	back to summary
pack-priv String getStartDateTime()

getType

back to summary

public String getType()

Implements org.h2.server.Service.getType.

Doc from org.h2.server.Service.getType.

Get the human readable short name of the service.

Returns:String

the type

Annotations

@Override

getURL

back to summary

public String getURL()

Implements org.h2.server.Service.getURL.

Doc from org.h2.server.Service.getURL.

Get the URL of this service in a human readable form

Returns:String

the url

Annotations

@Override

init

back to summary

public void init(String... args)

Implements org.h2.server.Service.init.

Doc from org.h2.server.Service.init.

Initialize the service from command line options.

Parameters

args:String[]: the command line options

Annotations

@Override

isCommandHistoryAllowed	back to summary
public boolean isCommandHistoryAllowed()

isDaemon

back to summary

public boolean isDaemon()

Implements org.h2.server.Service.isDaemon.

Doc from org.h2.server.Service.isDaemon.

Check if a daemon thread should be used.

Returns:boolean

true if a daemon thread should be used

Annotations

@Override

isRunning

back to summary

public boolean isRunning(boolean traceError)

Implements org.h2.server.Service.isRunning.

Doc from org.h2.server.Service.isRunning.

Check if the service is running.

Parameters

traceError:boolean: if errors should be written

Returns:boolean

if the server is running

Annotations

@Override

isStopped	back to summary
public boolean isStopped()

listen

back to summary

public void listen()

Implements org.h2.server.Service.listen.

Doc from org.h2.server.Service.listen.

Listen for incoming connections. This method blocks.

Annotations

@Override

loadProperties	back to summary
private Properties loadProperties()

readTranslations

back to summary

pack-priv void readTranslations(WebSession session, String language)

Read the translation for this language and save them in the 'text' property of this session.

Parameters

session:WebSession: the session
language:String: the language

remove

back to summary

pack-priv synchronized void remove(WebThread t)

Remove this web thread from the set of running threads.

Parameters

t:WebThread: the thread to remove

removeSetting

back to summary

pack-priv void removeSetting(String name)

Remove a connection information setting from the list

Parameters

name:String: the setting to remove

saveCommandHistoryList

back to summary

public void saveCommandHistoryList(ArrayList<String> commandHistory)

Save the command history to the properties file.

Parameters

commandHistory:ArrayList<String>: the history

saveProperties

back to summary

pack-priv synchronized void saveProperties(Properties prop)

Save the settings to the properties file.

Parameters

prop:Properties: null or the properties webPort, webAllowOthers, and webSSL

setAdminPassword	back to summary
pack-priv void setAdminPassword(String password)

setAllowChunked	back to summary
pack-priv void setAllowChunked(boolean allowChunked)

setAllowOthers	back to summary
pack-priv void setAllowOthers(boolean b)

setAllowSecureCreation	back to summary
public void setAllowSecureCreation(boolean allowSecureCreation) Parameters allowSecureCreation:boolean whether creation of databases using the key should be allowed

setCommandHistoryAllowed	back to summary
public void setCommandHistoryAllowed(boolean allowed)

setExternalNames	back to summary
pack-priv void setExternalNames(String externalNames)

setKey

back to summary

public void setKey(String key)

Sets the key for privileged connections.

Parameters

key:String: key, or null

setPort	back to summary
pack-priv void setPort(int port)

setShutdownHandler	back to summary
public void setShutdownHandler(ShutdownHandler shutdownHandler)

setSSL	back to summary
pack-priv void setSSL(boolean b)

shutdown	back to summary
pack-priv void shutdown() Shut down the web server.

start

back to summary

public void start()

Implements org.h2.server.Service.start.

Doc from org.h2.server.Service.start.

Start the service. This usually means create the server socket. This method must not block.

Annotations

@Override

startTranslate

back to summary

pack-priv String startTranslate(Map<Object, Object> translation)

Start the translation thread that reads the file once a second.

Parameters

translation:Map<Object, Object>: the translation map

Returns:String

the name of the file to translate

stop

back to summary

public void stop()

Implements org.h2.server.Service.stop.

Doc from org.h2.server.Service.stop.

Stop the service.

Annotations

@Override

supportsLanguage

back to summary

pack-priv boolean supportsLanguage(String language)

Check if this language is supported / translated.

Parameters

language:String: the language

Returns:boolean

true if a translation is available

trace

back to summary

pack-priv void trace(String s)

Write trace information if trace is enabled.

Parameters

s:String: the message to write

traceError

back to summary

pack-priv void traceError(Throwable e)

Write the stack trace if trace is enabled.

Parameters

e:Throwable: the exception

updateSetting

back to summary

pack-priv void updateSetting(ConnectionInfo info)

Update a connection information setting.

Parameters

info:ConnectionInfo: the connection information

updateURL	back to summary
private void updateURL()

org.h2.server.web back to summary

private Class WebServer.TranslateThread

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
org.h2.server.web.WebServer.TranslateThread

The translate thread reads and writes the file translation.properties once a second.

Field Summary

Modifier and Type	Field and Description
private final Path	file
private volatile boolean	stopNow
private final Map<Object, Object>	translation

Inherited from java.lang.Thread:: MAX_PRIORITY MIN_PRIORITY NORM_PRIORITY

Constructor Summary

Access	Constructor and Description
pack-priv	TranslateThread(Map<Object, Object> translation)

Method Summary

Modifier and Type	Method and Description
public String	getFileName()
public void	run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. This method is run by the thread when it executes.
public void	stopNow()

Field Detail

file	back to summary
private final Path file

stopNow	back to summary
private volatile boolean stopNow

translation	back to summary
private final Map<Object, Object> translation

Constructor Detail

TranslateThread	back to summary
pack-priv TranslateThread(Map<Object, Object> translation)

Method Detail

getFileName	back to summary
public String getFileName()

run back to summary

public void run()

Overrides java.lang.Thread.run.

Implements java.lang.Runnable.run.

Doc from java.lang.Thread.run.

This method is run by the thread when it executes. Subclasses of Thread may override this method.

This method is not intended to be invoked directly. If this thread is a platform thread created with a Runnable task then invoking this method will invoke the task's run method. If this thread is a virtual thread then invoking this method directly does nothing.

Annotations

@Override

stopNow	back to summary
public void stopNow()

public Class WebServer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WebServer.TranslateThread

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail