org.jminor.framework.server

Class DefaultEntityConnectionServer

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.jminor.common.remote.AbstractServer<AbstractRemoteEntityConnection,EntityConnectionServerAdmin>

org.jminor.framework.server.DefaultEntityConnectionServer

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, Server<AbstractRemoteEntityConnection,EntityConnectionServerAdmin>

public class DefaultEntityConnectionServer
extends AbstractServer<AbstractRemoteEntityConnection,EntityConnectionServerAdmin>

A remote server class, responsible for handling requests for AbstractRemoteEntityConnections.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.jminor.common.remote.Server

Server.AuxiliaryServer, Server.ServerInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG
protected static java.lang.String	RESTART
static PropertyValue<java.lang.Boolean>	SERIALIZATION_FILTER_DRYRUN If true then the serialization whitelist specified by SERIALIZATION_FILTER_WHITELIST is populated with the names of all deserialized classes on server shutdown.
static PropertyValue<java.lang.String>	SERIALIZATION_FILTER_WHITELIST The serialization whitelist file to use if any
static PropertyValue<java.lang.String>	SERVER_CLIENT_CONNECTION_TIMEOUT Specifies the default client connection timeout (ms) in a comma separated list.
static PropertyValue<java.lang.Boolean>	SERVER_CLIENT_LOGGING_ENABLED The initial connection logging status on the server, either true (on) or false (off) Value type: Boolean Default value: false
static PropertyValue<java.lang.Integer>	SERVER_CONNECTION_LIMIT Specifies maximum number of concurrent connections the server accepts -1 indicates no limit and 0 indicates a closed server.
static PropertyValue<java.lang.String>	SERVER_CONNECTION_POOL_PROVIDER_CLASS Specifies the class name of the connection pool provider to user, if none is specified the internal connection pool is used if necessary Value type: String Default value: none
static PropertyValue<java.lang.String>	SERVER_CONNECTION_POOLING_STARTUP_POOL_USERS Specifies a comma separated list of username:password combinations for which to create connection pools on startup Example: scott:tiger,john:foo,paul:bar
static PropertyValue<java.lang.String>	SERVER_CONNECTION_VALIDATOR_CLASSES Specifies a comma separated list of ConnectionValidator class names, which should be initialized on server startup, these classes must be available on the server classpath and contain a parameterless constructor
static PropertyValue<java.lang.String>	SERVER_DOMAIN_MODEL_CLASSES Specifies a comma separated list of domain model class names, these classes must be available on the server classpath
static PropertyValue<java.lang.String>	SERVER_LOGIN_PROXY_CLASSES Specifies a comma separated list of LoginProxy class names, which should be initialized on server startup, these classes must be available on the server classpath and contain a parameterless constructor
protected static java.lang.String	SHUTDOWN
protected static java.lang.String	START
protected static java.lang.String	STOP

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface org.jminor.common.remote.Server

AUXILIARY_SERVER_CLASS_NAMES, CLIENT_HOST_KEY, DEFAULT_SERVER_CONNECTION_TIMEOUT, JAVAX_NET_KEYSTORE, JAVAX_NET_KEYSTORE_PASSWORD, JAVAX_NET_TRUSTSTORE, JAVAX_NET_TRUSTSTORE_PASSWORD, KEYSTORE, KEYSTORE_PASSWORD, LOCALHOST, REGISTRY_PORT, RMI_SERVER_HOSTNAME, SERVER_ADMIN_PORT, SERVER_ADMIN_USER, SERVER_CONNECTION_SSL_ENABLED, SERVER_CONNECTION_TIMEOUT, SERVER_HOST_NAME, SERVER_NAME_PREFIX, SERVER_PORT, TRUSTSTORE, TRUSTSTORE_PASSWORD

Constructor Summary

Constructors

Constructor and Description

DefaultEntityConnectionServer(java.lang.String serverName, int serverPort, int serverAdminPort, int registryPort, Database database, boolean sslEnabled, int connectionLimit, java.util.Collection<java.lang.String> domainModelClassNames, java.util.Collection<java.lang.String> loginProxyClassNames, java.util.Collection<java.lang.String> connectionValidatorClassNames, java.util.Collection<User> startupPoolUsers, java.util.Collection<java.lang.String> auxiliaryServerClassNames, boolean clientLoggingEnabled, int connectionTimeout, java.util.Map<java.lang.String,java.lang.Integer> clientSpecificConnectionTimeouts, User adminUser) Constructs a new DefaultEntityConnectionServer and binds it to a registry on the given port

Method Summary

Modifier and Type	Method and Description
protected AbstractRemoteEntityConnection	createRemoteConnection(ConnectionPool connectionPool, Database database, RemoteClient remoteClient, int port, boolean clientLoggingEnabled, java.rmi.server.RMIClientSocketFactory clientSocketFactory, java.rmi.server.RMIServerSocketFactory serverSocketFactory) Creates the remote connection provided by this server
protected AbstractRemoteEntityConnection	doConnect(RemoteClient remoteClient) Establishes the actual client connection.
protected void	doDisconnect(AbstractRemoteEntityConnection connection) Disconnects the given connection.
protected static java.util.Map<java.lang.String,java.lang.Integer>	getClientTimeoutValues()
protected static java.util.Collection<User>	getPoolUsers(java.util.Collection<java.lang.String> poolUsers)
EntityConnectionServerAdmin	getServerAdmin(User user) Returns the admin intarface used to administer this server
int	getServerLoad()
protected void	handleShutdown() Called after shutdown has finished, for subclasses
protected static java.lang.String	initializeServerName(java.lang.String databaseHost, java.lang.String sid)
boolean	isClientLoggingEnabled()
static void	main(java.lang.String[] arguments) If no arguments are supplied a new DefaultEntityConnectionServer is started.
static DefaultEntityConnectionServer	startServer() Starts the server

Methods inherited from class org.jminor.common.remote.AbstractServer

addSharedLoginProxy, connect, connectionsAvailable, disconnect, getConnection, getConnectionCount, getConnectionLimit, getConnections, getServerInfo, isShuttingDown, setConnectionLimit, setConnectionValidator, setLoginProxy, shutdown, validateUserCredentials

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZATION_FILTER_WHITELIST

public static final PropertyValue<java.lang.String> SERIALIZATION_FILTER_WHITELIST

The serialization whitelist file to use if any

SERIALIZATION_FILTER_DRYRUN

public static final PropertyValue<java.lang.Boolean> SERIALIZATION_FILTER_DRYRUN

If true then the serialization whitelist specified by SERIALIZATION_FILTER_WHITELIST is populated with the names of all deserialized classes on server shutdown. Note this overwrites the file if it already exists.

SERVER_CONNECTION_POOL_PROVIDER_CLASS

public static final PropertyValue<java.lang.String> SERVER_CONNECTION_POOL_PROVIDER_CLASS

Specifies the class name of the connection pool provider to user, if none is specified the internal connection pool is used if necessary
Value type: String
Default value: none

See Also:

ConnectionPoolProvider

SERVER_CONNECTION_LIMIT

public static final PropertyValue<java.lang.Integer> SERVER_CONNECTION_LIMIT

Specifies maximum number of concurrent connections the server accepts
-1 indicates no limit and 0 indicates a closed server. Value type: Integer
Default value: -1

SERVER_CLIENT_CONNECTION_TIMEOUT

public static final PropertyValue<java.lang.String> SERVER_CLIENT_CONNECTION_TIMEOUT

Specifies the default client connection timeout (ms) in a comma separated list. Example: org.jminor.demos.empdept.client.ui.EmpDeptAppPanel:60000,org.jminor.demos.chinook.ui.ChinookAppPanel:120000 Value type: String
Default value: none

SERVER_CLIENT_LOGGING_ENABLED

public static final PropertyValue<java.lang.Boolean> SERVER_CLIENT_LOGGING_ENABLED

The initial connection logging status on the server, either true (on) or false (off)
Value type: Boolean
Default value: false

SERVER_CONNECTION_POOLING_STARTUP_POOL_USERS

public static final PropertyValue<java.lang.String> SERVER_CONNECTION_POOLING_STARTUP_POOL_USERS

Specifies a comma separated list of username:password combinations for which to create connection pools on startup Example: scott:tiger,john:foo,paul:bar

SERVER_CONNECTION_VALIDATOR_CLASSES

public static final PropertyValue<java.lang.String> SERVER_CONNECTION_VALIDATOR_CLASSES

Specifies a comma separated list of ConnectionValidator class names, which should be initialized on server startup, these classes must be available on the server classpath and contain a parameterless constructor

See Also:

ConnectionValidator

SERVER_LOGIN_PROXY_CLASSES

public static final PropertyValue<java.lang.String> SERVER_LOGIN_PROXY_CLASSES

Specifies a comma separated list of LoginProxy class names, which should be initialized on server startup, these classes must be available on the server classpath and contain a parameterless constructor

See Also:

LoginProxy

SERVER_DOMAIN_MODEL_CLASSES

public static final PropertyValue<java.lang.String> SERVER_DOMAIN_MODEL_CLASSES

Specifies a comma separated list of domain model class names, these classes must be available on the server classpath

LOG

protected static final org.slf4j.Logger LOG

START

protected static final java.lang.String START

See Also:

Constant Field Values

STOP

protected static final java.lang.String STOP

See Also:

Constant Field Values

SHUTDOWN

protected static final java.lang.String SHUTDOWN

See Also:

Constant Field Values

RESTART

protected static final java.lang.String RESTART

See Also:

Constant Field Values

Constructor Detail

DefaultEntityConnectionServer

public DefaultEntityConnectionServer(java.lang.String serverName,
                                     int serverPort,
                                     int serverAdminPort,
                                     int registryPort,
                                     Database database,
                                     boolean sslEnabled,
                                     int connectionLimit,
                                     java.util.Collection<java.lang.String> domainModelClassNames,
                                     java.util.Collection<java.lang.String> loginProxyClassNames,
                                     java.util.Collection<java.lang.String> connectionValidatorClassNames,
                                     java.util.Collection<User> startupPoolUsers,
                                     java.util.Collection<java.lang.String> auxiliaryServerClassNames,
                                     boolean clientLoggingEnabled,
                                     int connectionTimeout,
                                     java.util.Map<java.lang.String,java.lang.Integer> clientSpecificConnectionTimeouts,
                                     User adminUser)
                              throws java.rmi.RemoteException

Constructs a new DefaultEntityConnectionServer and binds it to a registry on the given port

Parameters:

serverName - the serverName

serverPort - the port on which to make the server accessible

serverAdminPort - the port on which to make the server admin interface accessible

registryPort - the registry port to use

database - the Database implementation

sslEnabled - if true then ssl is enabled

connectionLimit - the maximum number of concurrent connections, -1 for no limit

domainModelClassNames - the domain model classes to load on startup

loginProxyClassNames - the login proxy classes to initialize on startup

connectionValidatorClassNames - the connection validation classes to initialize on startup

startupPoolUsers - the users for which to initialize connection pools on startup

auxiliaryServerClassNames - the class names of auxiliary servers to run alongside this server

clientLoggingEnabled - if true then client logging is enabled on startup

connectionTimeout - the idle connection timeout

clientSpecificConnectionTimeouts - client specific connection timeouts, mapped to clientTypeId

adminUser - the admin user

Throws:

java.rmi.RemoteException - in case of a remote exception

java.lang.RuntimeException - in case the domain model classes are not found on the classpath or if the jdbc driver class is not found or in case of an exception while constructing the initial pooled connections

Method Detail

getServerAdmin

public final EntityConnectionServerAdmin getServerAdmin(User user)
                                                 throws ServerException.AuthenticationException

Description copied from interface: Server

Returns the admin intarface used to administer this server

Parameters:

user - the server admin user

Returns:

the administration interface for this server

Throws:

ServerException.AuthenticationException - in case authentication fails

getServerLoad

public final int getServerLoad()

Returns:

the server load as number of service requests per second

isClientLoggingEnabled

public final boolean isClientLoggingEnabled()

Returns:

true if client logging is enabled

doConnect

protected final AbstractRemoteEntityConnection doConnect(RemoteClient remoteClient)
                                                  throws java.rmi.RemoteException,
                                                         ServerException.LoginException,
                                                         ServerException.ServerFullException

Establishes the actual client connection.

Specified by:

doConnect in class AbstractServer<AbstractRemoteEntityConnection,EntityConnectionServerAdmin>

Parameters:

remoteClient - the client connection info

Returns:

a connection servicing the given client

Throws:

java.rmi.RemoteException - in case of an exception

ServerException.LoginException - in case of an error during the login

ServerException.ServerFullException - in case the server is not accepting new connections

doDisconnect

protected final void doDisconnect(AbstractRemoteEntityConnection connection)
                           throws java.rmi.RemoteException

Disconnects the given connection.

Specified by:

doDisconnect in class AbstractServer<AbstractRemoteEntityConnection,EntityConnectionServerAdmin>

Parameters:

connection - the connection to disconnect

Throws:

java.rmi.RemoteException - in case of an exception

createRemoteConnection

protected AbstractRemoteEntityConnection createRemoteConnection(ConnectionPool connectionPool,
                                                                Database database,
                                                                RemoteClient remoteClient,
                                                                int port,
                                                                boolean clientLoggingEnabled,
                                                                java.rmi.server.RMIClientSocketFactory clientSocketFactory,
                                                                java.rmi.server.RMIServerSocketFactory serverSocketFactory)
                                                         throws java.rmi.RemoteException,
                                                                DatabaseException

Creates the remote connection provided by this server

Parameters:

connectionPool - the connection pool to use, if none is provided a local connection is established

database - the underlying database

remoteClient - the client requesting the connection

port - the port to use when exporting this remote connection

clientLoggingEnabled - specifies whether or not method logging is enabled

clientSocketFactory - the client socket factory, null for default

serverSocketFactory - the server socket factory, null for default

Returns:

a remote connection

Throws:

java.rmi.RemoteException - in case of an exception

DatabaseException - in case a database connection can not be established, for example if a wrong username or password is provided

handleShutdown

protected final void handleShutdown()
                             throws java.rmi.RemoteException

Called after shutdown has finished, for subclasses

Overrides:

handleShutdown in class AbstractServer<AbstractRemoteEntityConnection,EntityConnectionServerAdmin>

Throws:

java.rmi.RemoteException - in case of an exception

initializeServerName

protected static java.lang.String initializeServerName(java.lang.String databaseHost,
                                                       java.lang.String sid)

getPoolUsers

protected static java.util.Collection<User> getPoolUsers(java.util.Collection<java.lang.String> poolUsers)

getClientTimeoutValues

protected static java.util.Map<java.lang.String,java.lang.Integer> getClientTimeoutValues()

startServer

public static DefaultEntityConnectionServer startServer()
                                                 throws java.rmi.RemoteException

Starts the server

Returns:

the server instance

Throws:

java.rmi.RemoteException - in case of an exception

main

public static void main(java.lang.String[] arguments)
                 throws java.rmi.RemoteException,
                        ServerException.AuthenticationException

If no arguments are supplied a new DefaultEntityConnectionServer is started.

Parameters:

arguments - 'start' (or no argument) starts the server, 'stop' or 'shutdown' causes a running server to be shut down and 'restart' restarts the server

Throws:

java.rmi.RemoteException - in case of a remote exception during service export

ServerException.AuthenticationException - in case of missing or incorrect admin user information