Module is.codion.framework.server

Package is.codion.framework.server

Class EntityServer

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

is.codion.common.rmi.server.AbstractServer<AbstractRemoteEntityConnection,EntityServerAdmin>

is.codion.framework.server.EntityServer

All Implemented Interfaces:

Server<AbstractRemoteEntityConnection,EntityServerAdmin>, Serializable, Remote

public class EntityServer
extends AbstractServer<AbstractRemoteEntityConnection,EntityServerAdmin>

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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class is.codion.common.rmi.server.AbstractServer

AbstractServer.ClientConnection<T>

Nested classes/interfaces inherited from interface is.codion.common.rmi.server.Server

Server.Locator

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface is.codion.common.rmi.server.Server

CLIENT_HOST

Constructor Summary

Constructors

Constructor	Description
EntityServer(EntityServerConfiguration configuration)	Constructs a new EntityServer and binds it to a registry on the port found in the configuration.

Method Summary

Modifier and Type	Method	Description
protected final AbstractRemoteEntityConnection	connect(RemoteClient remoteClient)	Establishes the actual client connection.
protected AbstractRemoteEntityConnection	createRemoteConnection(Database database, RemoteClient remoteClient, int port, RMIClientSocketFactory clientSocketFactory, RMIServerSocketFactory serverSocketFactory)	Creates the remote connection provided by this server
protected final void	disconnect(AbstractRemoteEntityConnection connection)	Disconnects the given connection.
static void	main(String[] arguments)	If no arguments are supplied a new EntityServer is started.
protected final void	maintainConnections(Collection<AbstractServer.ClientConnection<AbstractRemoteEntityConnection>> connections)	Maintains the given connections, that is, disconnects inactive or invalid connections, if required.
final EntityServerAdmin	serverAdmin(User user)	Returns the admin interface used to administer this server
final int	serverLoad()
static EntityServer	startServer()	Starts the server, using the configuration from system properties.
static EntityServer	startServer(EntityServerConfiguration configuration)	Starts the server.

Methods inherited from class is.codion.common.rmi.server.AbstractServer

addAuthenticator, addShutdownListener, auxiliaryServers, clients, connect, connection, connectionCount, connections, connectionsAvailable, disconnect, getAdmin, getConnectionLimit, getMaintenanceInterval, logShutdownAndReturn, registry, serverInformation, setAdmin, setConnectionLimit, setMaintenanceInterval, shutdown, validateUserCredentials

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, 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

Constructor Details

EntityServer

public EntityServer(EntityServerConfiguration configuration)
             throws RemoteException

Constructs a new EntityServer and binds it to a registry on the port found in the configuration.

Parameters:

configuration - the server configuration

Throws:

RemoteException - in case of a remote exception

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 Details

serverAdmin

public final EntityServerAdmin serverAdmin(User user)
                                    throws ServerAuthenticationException

Description copied from interface: Server

Returns the admin interface used to administer this server

Parameters:

user - the server admin user

Returns:

the administration interface for this server

Throws:

ServerAuthenticationException - in case authentication fails

IllegalStateException - in case no server admin instance is available

serverLoad

public final int serverLoad()

Returns:

the server load as number of service requests per second

connect

protected final AbstractRemoteEntityConnection connect(RemoteClient remoteClient)
                                                throws RemoteException,
LoginException

Description copied from class: AbstractServer

Establishes the actual client connection.

Specified by:

connect in class AbstractServer<AbstractRemoteEntityConnection,EntityServerAdmin>

Parameters:

remoteClient - the client connection info

Returns:

a connection servicing the given client

Throws:

RemoteException - in case of an exception

LoginException - in case of an error during the login

disconnect

protected final void disconnect(AbstractRemoteEntityConnection connection)
                         throws RemoteException

Description copied from class: AbstractServer

Disconnects the given connection.

Specified by:

disconnect in class AbstractServer<AbstractRemoteEntityConnection,EntityServerAdmin>

Parameters:

connection - the connection to disconnect

Throws:

RemoteException - in case of an exception

createRemoteConnection

protected AbstractRemoteEntityConnection createRemoteConnection(Database database,
 RemoteClient remoteClient,
 int port,
 RMIClientSocketFactory clientSocketFactory,
 RMIServerSocketFactory serverSocketFactory)
                                                         throws RemoteException,
DatabaseException

Creates the remote connection provided by this server

Parameters:

database - the underlying database

remoteClient - the client requesting the connection

port - the port to use when exporting this remote connection

clientSocketFactory - the client socket factory, null for default

serverSocketFactory - the server socket factory, null for default

Returns:

a remote connection

Throws:

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

maintainConnections

protected final void maintainConnections(Collection<AbstractServer.ClientConnection<AbstractRemoteEntityConnection>> connections)
                                  throws RemoteException

Description copied from class: AbstractServer

Maintains the given connections, that is, disconnects inactive or invalid connections, if required.

Specified by:

maintainConnections in class AbstractServer<AbstractRemoteEntityConnection,EntityServerAdmin>

Parameters:

connections - all current connections

Throws:

RemoteException - in case of an exception

startServer

public static EntityServer startServer()
                                throws RemoteException

Starts the server, using the configuration from system properties.

Returns:

the server instance

Throws:

RemoteException - in case of an exception

startServer

public static EntityServer startServer(EntityServerConfiguration configuration)
                                throws RemoteException

Starts the server.

Parameters:

configuration - the configuration

Returns:

the server instance

Throws:

RemoteException - in case of an exception

main

public static void main(String[] arguments)
                 throws RemoteException,
ServerAuthenticationException

If no arguments are supplied a new EntityServer is started.

Parameters:

arguments - 'shutdown' (case-insensitive) causes a running server to be shut down, otherwise a server is started

Throws:

RemoteException - in case of a remote exception during service export

ServerAuthenticationException - in case of missing or incorrect admin user information