Module is.codion.common.rmi

Package is.codion.common.rmi.server

Interface ServerAdmin

All Superinterfaces:

Remote

All Known Subinterfaces:

EntityServerAdmin

All Known Implementing Classes:

DefaultServerAdmin

public interface ServerAdmin
extends Remote

Administration interface for a RemoteServer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ServerAdmin.GcEvent	Garbage collection event
static interface	ServerAdmin.ServerStatistics	Basic server performance statistics.
static interface	ServerAdmin.ThreadStatistics	Thread statistics

Method Summary

Modifier and Type	Method	Description
Collection<RemoteClient>	clients()
int	connectionCount()
void	disconnect(UUID clientId)	Disconnects the given client from the server
int	getConnectionLimit()
ServerInformation	serverInformation()
ServerAdmin.ServerStatistics	serverStatistics(long since)
void	setConnectionLimit(int value)
void	shutdown()	Shuts down the server
String	systemProperties()
Collection<User>	users()

Method Details

disconnect

void disconnect(UUID clientId)
         throws RemoteException

Disconnects the given client from the server

Parameters:

clientId - the id of the client to disconnect

Throws:

RemoteException - in case of a communication error

users

Collection<User> users()
                throws RemoteException

Returns:

the users currently connected to the server

Throws:

RemoteException - in case of a communication error

clients

Collection<RemoteClient> clients()
                          throws RemoteException

Returns:

all clients connected to the server

Throws:

RemoteException - in case of a communication error

shutdown

void shutdown()
       throws RemoteException

Shuts down the server

Throws:

RemoteException - in case of a communication error

serverInformation

ServerInformation serverInformation()
                             throws RemoteException

Returns:

static information about the server

Throws:

RemoteException - in case of an exception

connectionCount

int connectionCount()
             throws RemoteException

Returns:

the number of active connections

Throws:

RemoteException - in case of a communication error

getConnectionLimit

int getConnectionLimit()
                throws RemoteException

Returns:

the maximum number of concurrent connections this server accepts

Throws:

RemoteException - in case of a communication error

setConnectionLimit

void setConnectionLimit(int value)
                 throws RemoteException

Parameters:

value - the maximum number of concurrent connections this server accepts

Throws:

RemoteException - in case of a communication error

systemProperties

String systemProperties()
                 throws RemoteException

Returns:

the server system properties

Throws:

RemoteException - in case of an exception

serverStatistics

ServerAdmin.ServerStatistics serverStatistics(long since)
                                       throws RemoteException

Parameters:

since - the time since from which to retrieve statistics

Returns:

current statistics for this server

Throws:

RemoteException - in case of an exception