org.jminor.common.remote

Class AbstractServer<T extends java.rmi.Remote,A extends java.rmi.Remote>

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.jminor.common.remote.AbstractServer<T,A>

Type Parameters:

T - the type of remote interface served by this server

A - the type of the admin interface this server provides

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, Server<T,A>

Direct Known Subclasses:

DefaultEntityConnectionServer

public abstract class AbstractServer<T extends java.rmi.Remote,A extends java.rmi.Remote>
extends java.rmi.server.UnicastRemoteObject
implements Server<T,A>

A default Server implementation.

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 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
AbstractServer(int serverPort, java.lang.String serverName) Instantiates a new AbstractServer
AbstractServer(int serverPort, java.lang.String serverName, java.rmi.server.RMIClientSocketFactory clientSocketFactory, java.rmi.server.RMIServerSocketFactory serverSocketFactory) Instantiates a new AbstractServer

Method Summary

Modifier and Type	Method and Description
void	addSharedLoginProxy(LoginProxy loginProxy) Adds a shared LoginProxy, used for all connection requests.
T	connect(ConnectionRequest connectionRequest) Establishes a connection to this Server
boolean	connectionsAvailable()
void	disconnect(java.util.UUID clientId) Disconnects the connection identified by the given key.
protected abstract T	doConnect(RemoteClient remoteClient) Establishes the actual client connection.
protected abstract void	doDisconnect(T connection) Disconnects the given connection.
T	getConnection(java.util.UUID clientId)
int	getConnectionCount()
int	getConnectionLimit()
java.util.Map<RemoteClient,T>	getConnections()
Server.ServerInfo	getServerInfo()
protected void	handleShutdown() Called after shutdown has finished, for subclasses
boolean	isShuttingDown()
void	setConnectionLimit(int connectionLimit)
void	setConnectionValidator(java.lang.String clientTypeId, ConnectionValidator connectionValidator) Sets the ConnectionValidator for the given client type id, if connectionValidator is null the current connection validator (if any) is removed.
void	setLoginProxy(java.lang.String clientTypeId, LoginProxy loginProxy) Sets the LoginProxy for the given client type id, if loginProxy is null the current login proxy (if any) is closed and removed.
void	shutdown() Shuts down this server.
protected static void	validateUserCredentials(User userToCheck, User requiredUser) Validates the given user credentials

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

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

getServerAdmin, getServerLoad

Constructor Detail

AbstractServer

public AbstractServer(int serverPort,
                      java.lang.String serverName)
               throws java.rmi.RemoteException

Instantiates a new AbstractServer

Parameters:

serverPort - the port on which the server should be exported

serverName - the name used when exporting this server

Throws:

java.rmi.RemoteException - in case of an exception

AbstractServer

public AbstractServer(int serverPort,
                      java.lang.String serverName,
                      java.rmi.server.RMIClientSocketFactory clientSocketFactory,
                      java.rmi.server.RMIServerSocketFactory serverSocketFactory)
               throws java.rmi.RemoteException

Instantiates a new AbstractServer

Parameters:

serverPort - the port on which the server should be exported

serverName - the name used when exporting this server

clientSocketFactory - the client socket factory to use, null for default

serverSocketFactory - the server socket factory to use, null for default

Throws:

java.rmi.RemoteException - in case of an exception

Method Detail

getConnections

public final java.util.Map<RemoteClient,T> getConnections()

Returns:

a map containing the current connections

getConnection

public final T getConnection(java.util.UUID clientId)

Parameters:

clientId - the client id

Returns:

the connection associated with the given client, null if none exists

getConnectionCount

public final int getConnectionCount()

Returns:

the current number of connections

getConnectionLimit

public final int getConnectionLimit()

Returns:

the maximum number of concurrent connections accepted by this server, a negative number means no limit while 0 means the server is closed.

setConnectionLimit

public final void setConnectionLimit(int connectionLimit)

Parameters:

connectionLimit - the maximum number of concurrent connections accepted by this server, a negative number means no limit while 0 means the server is closed.

getServerInfo

public final Server.ServerInfo getServerInfo()

Specified by:

getServerInfo in interface Server<T extends java.rmi.Remote,A extends java.rmi.Remote>

Returns:

static information about this server

connectionsAvailable

public final boolean connectionsAvailable()

Specified by:

connectionsAvailable in interface Server<T extends java.rmi.Remote,A extends java.rmi.Remote>

Returns:

true if there are connections available

connect

public final T connect(ConnectionRequest connectionRequest)
                throws java.rmi.RemoteException,
                       ServerException.ServerFullException,
                       ServerException.LoginException,
                       ServerException.ConnectionValidationException

Establishes a connection to this Server

Specified by:

connect in interface Server<T extends java.rmi.Remote,A extends java.rmi.Remote>

Parameters:

connectionRequest - the information required for establishing a connection

Returns:

a remote connection instance

Throws:

java.rmi.RemoteException - in case of a communitation error

ServerException.ServerFullException - in case the server isn't accepting more connections

ServerException.LoginException - in case the login fails

ServerException.ConnectionValidationException - in case connection validation fails

disconnect

public final void disconnect(java.util.UUID clientId)
                      throws java.rmi.RemoteException

Disconnects the connection identified by the given key.

Specified by:

disconnect in interface Server<T extends java.rmi.Remote,A extends java.rmi.Remote>

Parameters:

clientId - the UUID identifying the client that should be disconnected

Throws:

java.rmi.RemoteException - in case of a communication error

addSharedLoginProxy

public final void addSharedLoginProxy(LoginProxy loginProxy)

Adds a shared LoginProxy, used for all connection requests.

Parameters:

loginProxy - the login proxy

Throws:

java.lang.IllegalStateException - in case the given login proxy has already been added

setLoginProxy

public final void setLoginProxy(java.lang.String clientTypeId,
                                LoginProxy loginProxy)

Sets the LoginProxy for the given client type id, if loginProxy is null the current login proxy (if any) is closed and removed.

Parameters:

clientTypeId - the client type ID with which to associate the given login proxy

loginProxy - the login proxy

Throws:

java.lang.IllegalStateException - in case the login proxy has already been set for the given client type

setConnectionValidator

public final void setConnectionValidator(java.lang.String clientTypeId,
                                         ConnectionValidator connectionValidator)

Sets the ConnectionValidator for the given client type id, if connectionValidator is null the current connection validator (if any) is removed.

Parameters:

clientTypeId - the client type ID with which to associate the given connection validator

connectionValidator - the connection validator

Throws:

java.lang.IllegalStateException - in case the connection validator has already been set for the given client type

isShuttingDown

public final boolean isShuttingDown()

Returns:

true if this server is in the process of shutting down

shutdown

public final void shutdown()
                    throws java.rmi.RemoteException

Shuts down this server.

Throws:

java.rmi.RemoteException - in case of an exception

handleShutdown

protected void handleShutdown()
                       throws java.rmi.RemoteException

Called after shutdown has finished, for subclasses

Throws:

java.rmi.RemoteException - in case of an exception

doConnect

protected abstract T doConnect(RemoteClient remoteClient)
                        throws java.rmi.RemoteException,
                               ServerException.LoginException,
                               ServerException.ServerFullException

Establishes the actual client connection.

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 abstract void doDisconnect(T connection)
                              throws java.rmi.RemoteException

Disconnects the given connection.

Parameters:

connection - the connection to disconnect

Throws:

java.rmi.RemoteException - in case of an exception

validateUserCredentials

protected static final void validateUserCredentials(User userToCheck,
                                                    User requiredUser)
                                             throws ServerException.AuthenticationException

Validates the given user credentials

Parameters:

userToCheck - the credentials to check

requiredUser - the required credentials

Throws:

ServerException.AuthenticationException - in case either User instance is null or if the username or password does not match