WebServer has two distinct functions:
The primary function is to allow client/server access to HSQLDB databases via the HTTP protocol. This protocol is less efficient than the HSQL protocol used by the Server class and should be used only in situations where sandboxes or firewalls between the client and the server do not allow the use of the HSQL protocol. One example is client/server access by an applet running in browsers on remote hosts and accessing the database engine on the HTTP server from which the applet originated. From version 1.7.2, HTTP database connections are persistent and support transactions. Similar to HSQL connections, they should be explicitly closed to free the server resources.
The secondary function of WebServer is to act as a simple general purpose HTTP server. It is aimed to support the minimum requirements set out by the HTTP/1.0 standard. The HEAD and GET methods can be used to query and retrieve static files from the HTTP server.
Both the database server and HTTP server functions of WebServer can be configured with the webserver.properties file. It contains entries for the database server similar to those for the HSQL protocol Server class. In addition, a list mapping different file endings to their mime types may be included in this file. (fredt@users)
From the command line, the options are as follows:
+-----------------+-------------+----------+------------------------------+ | OPTION | TYPE | DEFAULT | DESCRIPTION | +-----------------+-------------+----------+------------------------------| | --help | | | prints this message | | --address | name|number | any | server inet address | | --port | number | 80 | port at which server listens | | --database.i | [type]spec | 0=test | path of database i | | --dbname.i | alias | | url alias for database i | | --silent | true|false | true | false => display all queries | | --trace | true|false | false | display JDBC trace messages | | --no_system_exit| true|false | false | do not issue System.exit() | +-----------------+-------------+----------+------------------------------+Example of the webserver.properties file:
server.port=80 server.database.0=test server.dbname.0=... ... server.database.n=... server.dbname.n=... server.silent=true .htm=text/html .html=text/html .txt=text/plain .gif=image/gif .class=application/octet-stream .jpg=image/jpeg .jgep=image/jpeg .zip=application/x-zip-compressed
| Modifier and Type | Field and Description |
|---|---|
| pack-priv static int | webBundleHandle
Handle to resource bundle providing i18n for things like HTTP error pages. |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public String | Returns: the name of the web page served when no page is specifiedOverrides org. Retrieves the name of the web page served when no page is specified. |
| public String | Returns: the command line and properties options help for this ServerOverrides org. Retrieves a String object describing the command line and properties options for this Server. |
| public String | Returns: the product name of this serverOverrides org. Retrieves this server's product name. |
| public String | Returns: string representation of this server's protocolOverrides org. Retrieves a string representation of the network protocol this server offers, typically one of 'HTTP', HTTPS', 'HSQL' or 'HSQLS'. |
| public String | Returns: the root context (directory) from which web content is servedOverrides org. Retrieves the root context (directory) from which web content is served. |
| public static void | main(String[]
the "command line" parameters with which to start
the WebServer. "-?" will cause the command line arguments
help to be printed to the standard output args)Hides org. Starts a new WebServer. |
| webBundleHandle | back to summary |
|---|---|
| pack-priv static int webBundleHandle Handle to resource bundle providing i18n for things like HTTP error pages. | |
| WebServer | back to summary |
|---|---|
| public WebServer() | |
| getDefaultWebPage | back to summary |
|---|---|
| public String getDefaultWebPage() Overrides org. Retrieves the name of the web page served when no page is specified. This attribute is relevant only when server protocol is HTTP(S).
| |
| getHelpString | back to summary |
|---|---|
| public String getHelpString() Overrides org. Retrieves a String object describing the command line and properties options for this Server.
| |
| getProductName | back to summary |
|---|---|
| public String getProductName() Overrides org. Retrieves this server's product name. Typically, this will be something like: "HSQLDB xxx server".
| |
| getProtocol | back to summary |
|---|---|
| public String getProtocol() Overrides org. Retrieves a string representation of the network protocol this server offers, typically one of 'HTTP', HTTPS', 'HSQL' or 'HSQLS'.
| |
| getWebRoot | back to summary |
|---|---|
| public String getWebRoot() Overrides org. Retrieves the root context (directory) from which web content is served. This property is relevant only when the server protocol is HTTP(S). Although unlikely, it may be that in the future other contexts, such as jar urls may be supported, so that pages can be served from the contents of a jar or from the JVM class path.
| |
| main | back to summary |
|---|---|
| public static void main(String[] args) Hides org. Starts a new WebServer.
| |