Module is.codion.common.rmi

Package is.codion.common.rmi.server

Interface Server<C extends Remote,A extends ServerAdmin>

Type Parameters:

C - the type of remote interface this server supplies to clients

A - the type of the admin interface this server supplies

All Superinterfaces:

Remote

All Known Implementing Classes:

AbstractServer, EntityServer

public interface Server<C extends Remote,A extends ServerAdmin>
extends Remote

A server for serving remote interfaces

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Server.Locator	Locates Servers by name on a registry.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_HOST	Specifies the client host connection parameter

Method Summary

Modifier and Type	Method	Description
C	connect(ConnectionRequest connectionRequest)	Establishes a connection to this Server
boolean	connectionsAvailable()
void	disconnect(UUID clientId)	Disconnects the connection identified by the given key.
A	serverAdmin(User user)	Returns the admin interface used to administer this server
ServerInformation	serverInformation()
int	serverLoad()

Field Details

CLIENT_HOST

static final String CLIENT_HOST

Specifies the client host connection parameter

See Also:

• Constant Field Values

Method Details

connect

C connect(ConnectionRequest connectionRequest)
   throws RemoteException,
ConnectionNotAvailableException,
LoginException

Establishes a connection to this Server

Parameters:

connectionRequest - the information required for establishing a connection

Returns:

a remote connection instance

Throws:

RemoteException - in case of a communication error

ConnectionNotAvailableException - in case the server isn't accepting more connections

LoginException - in case the login fails

serverAdmin

A serverAdmin(User user)
       throws RemoteException,
ServerAuthenticationException

Returns the admin interface used to administer this server

Parameters:

user - the admin user credentials

Returns:

the admin interface

Throws:

RemoteException - in case of a communication error

ServerAuthenticationException - in case authentication fails

disconnect

void disconnect(UUID clientId)
         throws RemoteException

Disconnects the connection identified by the given key.

Parameters:

clientId - the UUID identifying the client that should be disconnected

Throws:

RemoteException - in case of a communication error

serverInformation

ServerInformation serverInformation()
                             throws RemoteException

Returns:

static information about this server

Throws:

RemoteException - in case of an exception

serverLoad

int serverLoad()
        throws RemoteException

Returns:

the server load as number of service requests per second

Throws:

RemoteException - in case of an exception

connectionsAvailable

boolean connectionsAvailable()
                      throws RemoteException

Returns:

true if there are connections available

Throws:

RemoteException - in case of an exception