| com.rift.coad.daemon.hsqldb.HsqlDBEngineMBean
All known Subclasses: com.rift.coad.daemon.hsqldb.HsqlDBEngine,
| HsqlDBEngineMBean | | public interface HsqlDBEngineMBean extends Remote(Code) | | This interface supplies access to the Hsql server methods.
author:
Brett Chaldecott |
| Method Summary | |
| public String | getAddress()
Retrieves, in string form, this server's host address. | | public String | getDatabaseName(int index, boolean asconfigured)
Retrieves the url alias (network name) of the i'th database
that this Server hosts. | | public String | getDatabasePath(int index, boolean asconfigured)
Retrieves the HSQLDB path descriptor (uri) of the i'th
Database that this Server hosts. | | public String | getDatabaseType(int index)
| | public int | getPort()
Retrieves this server's host port. | | public String | getProductName()
Retrieves this server's product name. | | public String | getProductVersion()
Retrieves the server's product version, as a String. | | public String | getProtocol()
Retrieves a string respresentaion of the network protocol
this server offers, typically one of 'HTTP', HTTPS', 'HSQL' or 'HSQLS'. | | public String | getServerId()
Retrieves a String identifying this Server object. | | public int | getState()
Retrieves current state of this server in numerically coded form. | | public String | getStateDescriptor()
Retrieves a character sequence describing this server's current state,
including the message of the last exception, if there is one and it
is still in context. | | public boolean | isTls()
Retrieves whether the use of secure sockets was requested in the
server properties. | | public boolean | putPropertiesFromFile(String path)
Attempts to put properties from the file
with the specified path. | | public void | putPropertiesFromString(String s)
Puts properties from the supplied string argument. |
| getDatabaseName | | public String getDatabaseName(int index, boolean asconfigured) throws RemoteException, HsqlDBEngineException(Code) | | Retrieves the url alias (network name) of the i'th database
that this Server hosts.
Parameters:
index - the index of the url alias upon which to report
Parameters:
asconfigured - if true, report the configured value, elsethe live value the url alias component of the i'th databasethat this Server hosts, or null if no such name exists.
exception:
RemoteException -
exception:
HsqlDBEngineException - |
| getDatabasePath | | public String getDatabasePath(int index, boolean asconfigured) throws RemoteException, HsqlDBEngineException(Code) | | Retrieves the HSQLDB path descriptor (uri) of the i'th
Database that this Server hosts.
Parameters:
index - the index of the uri upon which to report
Parameters:
asconfigured - if true, report the configured value, elsethe live value the HSQLDB database path descriptor of the i'th databasethat this Server hosts, or null if no such path descriptorexists
exception:
RemoteException -
exception:
HsqlDBEngineException - |
| getState | | public int getState() throws RemoteException, HsqlDBEngineException(Code) | | Retrieves current state of this server in numerically coded form.
Typically, this will be one of:
- ServerProperties.SERVER_STATE_ONLINE (1)
- ServerProperties.SERVER_STATE_OPENING (4)
- ServerProperties.SERVER_STATE_CLOSING (8)
- ServerProperties.SERVER_STATE_SHUTDOWN (16)
this server's state code.
exception:
RemoteException -
exception:
HsqlDBEngineException - |
| putPropertiesFromFile | | public boolean putPropertiesFromFile(String path) throws RemoteException, HsqlDBEngineException(Code) | | Attempts to put properties from the file
with the specified path. The file
extension '.properties' is implicit and should not
be included in the path specification.
Parameters:
path - the path of the desired properties file, without the'.properties' file extension
throws:
RuntimeException - if this server is running true if the indicated file was read sucessfully, else false
exception:
RemoteException -
exception:
HsqlDBEngineException - |
| putPropertiesFromString | | public void putPropertiesFromString(String s) throws RemoteException, HsqlDBEngineException(Code) | | Puts properties from the supplied string argument. The relevant
key value pairs are the same as those for the (web)server.properties
file format, except that the 'server.' prefix should not be specified.
Parameters:
s - semicolon-delimited key=value pair string,e.g. k1=v1;k2=v2;k3=v3...
throws:
RuntimeException - if this server is running
exception:
RemoteException -
exception:
HsqlDBEngineException - |
|
|