Module is.codion.framework.server

Package is.codion.framework.server

Class EntityServer

java.lang.Object

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

is.codion.framework.server.EntityServer

All Implemented Interfaces:

Server<AbstractServerEntityConnection,EntityServerAdmin>, Remote

public class EntityServer
extends AbstractServer<AbstractServerEntityConnection,EntityServerAdmin>

A remote server serving ServerEntityConnection instances to clients.

Nested Class Summary

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

AbstractServer.SessionConnection<T>

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

Server.Locator

Field Summary

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

CLIENT_HOST

Constructor Summary

Constructors

Constructor	Description
EntityServer(EntityServerConfiguration configuration)	Constructs a new EntityServer, publishing nothing until started.

Method Summary

Modifier and Type	Method	Description
final EntityServerAdmin	admin(User user)	Returns the admin interface used to administer this server
protected final AbstractServerEntityConnection	connect(RemoteSession session)	Establishes the actual connection.
protected AbstractServerEntityConnection	createConnection(Database database, RemoteSession session, int port, @Nullable RMIClientSocketFactory clientSocketFactory, @Nullable RMIServerSocketFactory serverSocketFactory)	Creates the connection this server provides to a client session
protected final void	disconnect(AbstractServerEntityConnection 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.SessionConnection<AbstractServerEntityConnection>> connections)	Maintains the given connections, that is, disconnects inactive or invalid connections, if required.
static EntityServer	startServer()	Constructs and starts the server, using the configuration from system properties.
static EntityServer	startServer(EntityServerConfiguration configuration)	Constructs and starts the server.

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

addShutdownListener, auxiliaryServers, connect, connection, connectionCount, connectionLimit, connectionLimit, connections, connectionsAvailable, disconnect, getAdmin, information, logShutdownAndReturn, maintenanceInterval, maintenanceInterval, registry, setAdmin, shutdown, start, validateUserCredentials

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EntityServer

public EntityServer(EntityServerConfiguration configuration)
             throws RemoteException

Constructs a new EntityServer, publishing nothing until started.

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

admin

public final EntityServerAdmin admin(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

connect

protected final AbstractServerEntityConnection connect(RemoteSession session)
                                                throws RemoteException,
LoginException

Description copied from class: AbstractServer

Establishes the actual connection.

Specified by:

connect in class AbstractServer<AbstractServerEntityConnection,EntityServerAdmin>

Parameters:

session - the remote session

Returns:

a connection for the given session

Throws:

RemoteException - in case of an exception

LoginException - in case of an error during the login

disconnect

protected final void disconnect(AbstractServerEntityConnection connection)
                         throws RemoteException

Description copied from class: AbstractServer

Disconnects the given connection.

Specified by:

disconnect in class AbstractServer<AbstractServerEntityConnection,EntityServerAdmin>

Parameters:

connection - the connection to disconnect

Throws:

RemoteException - in case of an exception

createConnection

protected AbstractServerEntityConnection createConnection(Database database,
 RemoteSession session,
 int port,
 @Nullable RMIClientSocketFactory clientSocketFactory,
 @Nullable RMIServerSocketFactory serverSocketFactory)
                                                   throws RemoteException

Creates the connection this server provides to a client session

Parameters:

database - the underlying database

session - the session the connection serves

port - the port to use when exporting the connection, negative to not export it

clientSocketFactory - the client socket factory, null for default

serverSocketFactory - the server socket factory, null for default

Returns:

the 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.SessionConnection<AbstractServerEntityConnection>> 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<AbstractServerEntityConnection,EntityServerAdmin>

Parameters:

connections - all current connections

Throws:

RemoteException - in case of an exception

startServer

public static EntityServer startServer()
                                throws RemoteException

Constructs and 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

Constructs and starts the server.

Parameters:

configuration - the configuration

Returns:

the server instance

Throws:

RemoteException - in case of an exception

See Also:

• AbstractServer.start()

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