DbServer (Tentackle Persistence 2.0.7 API)

java.lang.Object
- org.tentackle.persist.rmi.DbServer

```
public class DbServer
extends Object
```
A generic db-RMI-DbServer.
The db properties file is parsed for the following keywords:
- service=service-name: defaults to the basename of the DbServer-class instance, i.e. -> rmi://localhost:1099/<Basename>
- createregistry[=default|plain|ssl|compressed]: creates a local registry (on the port according to service, defaulting to 1099). By default, the created registry uses the system-default socket factories. However, it may be forced to use another one, for example ssl. (see socketfactory=... below). If set, the connection and session object will use the same factories as the registry. All other delegates will be created using the factories given by socketfactory=.. or the systen default.
- connectionclass=connection-class: defaults to org.tentackle.persist.rmi.RemoteDbConnectionImpl
- timeoutinterval=timeout-polling-interval-in-milliseconds: The polling interval for dead sessions in milliseconds. Defaults to 1000ms. 0 turns off the cleanup thread completely (risky!).
- timeout=session-timeout: The default session timeout (in polling-intervals) for dead client connections (see Db -> keepAlive). Defaults to 0, i.e. no timeout (sessions may request an individual timeout).
- port=port: for the connection object. default is 0, i.e. system default (or from fixed ports)
- Fixed ports:
  ports=28000: plain=28000, compressed=28001, ssl=28002, compressed+ssl=28003
  is the same as:
  ports=28000,28001,28002,28003
  Default is: ports=serviceport+0,serviceport+1,serviceport+2,serviceport+3 if the service port is not the default registry port, else ports=0,0,0,0.
  Use -1 to disable service at this port and 0 to use a system default port, i.e. "ports=-1,-1,28002,28003" means: ssl only, with or without compression.
- socketfactory=[system|default|plain|ssl|compressed]: the socket factory type:
  - system: use system default factories (this is the default)
  - default: same as system
  - plain: plain sockets (see ClientSocketFactory, ServerSocketFactory
  - ssl: use SSL (see SslClientSocketFactory, SslServerSocketFactory
  - compressed: use compression (see CompressedClientSocketFactory, CompressedServerSocketFactory
  If both ssl and compressed is given, the factories used are CompressedSslClientSocketFactory and CompressedSslServerSocketFactory.
- ciphersuites=...: comma separated list of enabled cipher suites
- protocols=...: comma separated list of enabled protocols
- clientauth: set if server requires client authentication
Author:

harald

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CIPHER_SUITES` The property key for the SSL cipher suites.
`static String`	`CLIENT_AUTH` The property key for the SSL client authentication.
`static String`	`CONNECTION_CLASS` The property key for the connection class to export.
`static String`	`CREATE_REGISTRY` The property key whether to create a registry or use an external one.
`static String`	`PORT` The property key for the single RMI port.
`static String`	`PORTS` The property key for the RMI ports.
`static String`	`PROTOCOLS` The property key for the SSL protocols.
`static String`	`RMI_SERVICE` The property key for the RMI service name.
`static String`	`TIMEOUT` The property key for the session timeout count.
`static String`	`TIMEOUT_INTERVAL` The property key for the session timeout interval units in milliseconds.

Constructor Summary

Constructors
Constructor and Description
`DbServer(SessionInfo serverInfo)` Creates an instance of an RMI-db-server with default connection object (or configured entirely by db properties file)
`DbServer(SessionInfo sessionInfo, Class<? extends RemoteDbConnectionImpl> connectionClass)` Creates an instance of an RMI-db-server.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RMIClientSocketFactory`	`getClientSocketFactory()` Gets the server's csf
`int`	`getCompressedPort()` Get the fixed port for compressed communication
`int`	`getCompressedSslPort()` Get the fixed port for compressed+ssl communication
`RMIClientSocketFactory`	`getLoginClientSocketFactory()` Gets the server's csf for the login phase.
`RMIServerSocketFactory`	`getLoginServerSocketFactory()` Gets the server's ssf for the login phase.
`int`	`getPlainPort()` Get the fixed port for plain communication.
`int`	`getPort()` Gets the port the server is listening on
`int`	`getPort(int requestedPort, SocketFactoryType factoryType)` Gets the rmi port for a new remote object.
`Registry`	`getRegistry()` Gets the local registry.
`RMIServerSocketFactory`	`getServerSocketFactory()` Gets the server's ssf
`SessionInfo`	`getSessionInfo()` Gets the server's user info.
`int`	`getSessionTimeout()` Gets the default session timeout.
`long`	`getSessionTimeoutCheckInterval()` Gets the timeout check interval in milliseconds.
`int`	`getSslPort()` Get the fixed port for ssl communication
`void`	`start()` Starts the server.
`void`	`stop()` Stops the server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONNECTION_CLASS
```
public static final String CONNECTION_CLASS
```
    The property key for the connection class to export.
    
    See Also:
    
    Constant Field Values
  - RMI_SERVICE
```
public static final String RMI_SERVICE
```
    The property key for the RMI service name.
    
    See Also:
    
    Constant Field Values
  - CREATE_REGISTRY
```
public static final String CREATE_REGISTRY
```
    The property key whether to create a registry or use an external one.
    
    See Also:
    
    Constant Field Values
  - TIMEOUT
```
public static final String TIMEOUT
```
    The property key for the session timeout count.
    
    See Also:
    
    Constant Field Values
  - TIMEOUT_INTERVAL
```
public static final String TIMEOUT_INTERVAL
```
    The property key for the session timeout interval units in milliseconds.
    
    See Also:
    
    Constant Field Values
  - PORTS
```
public static final String PORTS
```
    The property key for the RMI ports.
    
    See Also:
    
    Constant Field Values
  - PORT
```
public static final String PORT
```
    The property key for the single RMI port.
    
    See Also:
    
    Constant Field Values
  - CIPHER_SUITES
```
public static final String CIPHER_SUITES
```
    The property key for the SSL cipher suites.
    
    See Also:
    
    Constant Field Values
  - PROTOCOLS
```
public static final String PROTOCOLS
```
    The property key for the SSL protocols.
    
    See Also:
    
    Constant Field Values
  - CLIENT_AUTH
```
public static final String CLIENT_AUTH
```
    The property key for the SSL client authentication.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DbServer
```
public DbServer(SessionInfo sessionInfo,
                Class<? extends RemoteDbConnectionImpl> connectionClass)
         throws ApplicationException
```
    Creates an instance of an RMI-db-server.
    
    Parameters:
    
    sessionInfo - the servers db-connection user info
    
    connectionClass - the class of the connection object to instantiate, null = default or from serverInfo's properties file
    
    Throws:
    
    ApplicationException - if some configuration error
  - DbServer
```
public DbServer(SessionInfo serverInfo)
         throws ApplicationException
```
    Creates an instance of an RMI-db-server with default connection object (or configured entirely by db properties file)
    
    Parameters:
    
    serverInfo - the servers db-connection user info
    
    Throws:
    
    ApplicationException - if some configuration error
- Method Detail
  - getSessionInfo
```
public SessionInfo getSessionInfo()
```
    Gets the server's user info.
    
    Returns:
    
    the server info
  - getPort
```
public int getPort(int requestedPort,
                   SocketFactoryType factoryType)
            throws ApplicationException
```
    Gets the rmi port for a new remote object.
    
    Parameters:
    
    requestedPort - the requested port by the delegate, 0 = use system default
    
    factoryType - the socket factory type
    
    Returns:
    
    the granted port, 0 = use system default
    
    Throws:
    
    ApplicationException - if requested port could not be granted
  - getPlainPort
```
public int getPlainPort()
```
    Get the fixed port for plain communication.
    
    Returns:
    
    the port number, 0 = not fixed, i.e. system default
  - getCompressedPort
```
public int getCompressedPort()
```
    Get the fixed port for compressed communication
    
    Returns:
    
    the port number, 0 = not fixed, i.e. system default
  - getSslPort
```
public int getSslPort()
```
    Get the fixed port for ssl communication
    
    Returns:
    
    the port number, 0 = not fixed, i.e. system default
  - getCompressedSslPort
```
public int getCompressedSslPort()
```
    Get the fixed port for compressed+ssl communication
    
    Returns:
    
    the port number, 0 = not fixed, i.e. system default
  - getPort
```
public int getPort()
```
    Gets the port the server is listening on
    
    Returns:
    
    the port
  - getClientSocketFactory
```
public RMIClientSocketFactory getClientSocketFactory()
```
    Gets the server's csf
    
    Returns:
    
    the client socket factory
  - getServerSocketFactory
```
public RMIServerSocketFactory getServerSocketFactory()
```
    Gets the server's ssf
    
    Returns:
    
    the server socket factory
  - getLoginClientSocketFactory
```
public RMIClientSocketFactory getLoginClientSocketFactory()
```
    Gets the server's csf for the login phase.
    
    Returns:
    
    the client socket factory
  - getLoginServerSocketFactory
```
public RMIServerSocketFactory getLoginServerSocketFactory()
```
    Gets the server's ssf for the login phase.
    
    Returns:
    
    the server socket factory
  - getSessionTimeout
```
public int getSessionTimeout()
```
    Gets the default session timeout.
    
    Returns:
    
    the timeout in polling intervals.
    
    See Also:
    
    getSessionTimeoutCheckInterval()
  - getSessionTimeoutCheckInterval
```
public long getSessionTimeoutCheckInterval()
```
    Gets the timeout check interval in milliseconds.
    
    Returns:
    
    the polling interval
    
    See Also:
    
    getSessionTimeout()
  - start
```
public void start()
           throws ApplicationException
```
    Starts the server.
    
    Throws:
    
    ApplicationException - if startup failed
  - getRegistry
```
public Registry getRegistry()
```
    Gets the local registry.
    
    Returns:
    
    the registry, null if none created
  - stop
```
public void stop()
          throws ApplicationException
```
    Stops the server.
    Unbinds the connection object.
    
    Throws:
    
    ApplicationException

Class DbServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONNECTION_CLASS

RMI_SERVICE

CREATE_REGISTRY

TIMEOUT

TIMEOUT_INTERVAL

PORTS

PORT

CIPHER_SUITES

PROTOCOLS

CLIENT_AUTH

Constructor Detail

DbServer

DbServer

Method Detail

getSessionInfo

getPort

getPlainPort

getCompressedPort

getSslPort

getCompressedSslPort

getPort

getClientSocketFactory

getServerSocketFactory

getLoginClientSocketFactory

getLoginServerSocketFactory

getSessionTimeout

getSessionTimeoutCheckInterval

start

getRegistry

stop