Module is.codion.common.rmi

Package is.codion.common.rmi.server

Class AbstractServerAdmin

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

is.codion.common.rmi.server.AbstractServerAdmin

All Implemented Interfaces:

ServerAdmin, Serializable, Remote

public class AbstractServerAdmin
extends UnicastRemoteObject
implements ServerAdmin

A base server admin implementation.

See Also:

• Serialized Form

Nested Class Summary

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

ServerAdmin.GcEvent, ServerAdmin.ServerStatistics, ServerAdmin.ThreadStatistics

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractServerAdmin(AbstractServer<?,? extends ServerAdmin> server, ServerConfiguration configuration)	Instantiates a new AbstractServerAdmin instance.

Method Summary

Modifier and Type	Method	Description
final Collection<RemoteClient>	clients()
final int	connectionCount()
final int	connectionLimit()
final void	connectionLimit(int value)
final void	disconnect(UUID clientId)	Disconnects the given client from the server
long	lastMaintenance()
protected int	requestsPerSecond()
final String	serializationFilterPatterns()
final ServerInformation	serverInformation()
final void	shutdown()	Shuts down the server
final ServerAdmin.ServerStatistics	statistics(long since)
final String	systemProperties()
final Collection<User>	users()

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

AbstractServerAdmin

protected AbstractServerAdmin(AbstractServer<?,? extends ServerAdmin> server,
 ServerConfiguration configuration)
                       throws RemoteException

Instantiates a new AbstractServerAdmin instance.

Parameters:

server - the server to administer

configuration - the server configuration

Throws:

RemoteException - in case of an exception

Method Details

serverInformation

public final ServerInformation serverInformation()

Specified by:

serverInformation in interface ServerAdmin

Returns:

static information about the server

systemProperties

public final String systemProperties()

Specified by:

systemProperties in interface ServerAdmin

Returns:

the server system properties, or an empty string if system properties are not enabled

See Also:

• ServerConfiguration.SYSTEM_PROPERTIES
• ServerConfiguration.Builder.systemProperties(boolean)

serializationFilterPatterns

public final String serializationFilterPatterns()

Specified by:

serializationFilterPatterns in interface ServerAdmin

Returns:

the active serialization filter patterns, or an empty string if serialization filtering is not configured

users

public final Collection<User> users()

Specified by:

users in interface ServerAdmin

Returns:

the users currently connected to the server

clients

public final Collection<RemoteClient> clients()

Specified by:

clients in interface ServerAdmin

Returns:

all clients connected to the server

disconnect

public final void disconnect(UUID clientId)
                      throws RemoteException

Description copied from interface: ServerAdmin

Disconnects the given client from the server

Specified by:

disconnect in interface ServerAdmin

Parameters:

clientId - the id of the client to disconnect

Throws:

RemoteException - in case of a communication error

shutdown

public final void shutdown()
                    throws RemoteException

Description copied from interface: ServerAdmin

Shuts down the server

Specified by:

shutdown in interface ServerAdmin

Throws:

RemoteException - in case of a communication error

statistics

public final ServerAdmin.ServerStatistics statistics(long since)
                                              throws RemoteException

Specified by:

statistics in interface ServerAdmin

Parameters:

since - the time since from which to retrieve statistics

Returns:

current statistics for this server

Throws:

RemoteException - in case of an exception

connectionCount

public final int connectionCount()

Specified by:

connectionCount in interface ServerAdmin

Returns:

the number of active connections

lastMaintenance

public long lastMaintenance()

Specified by:

lastMaintenance in interface ServerAdmin

Returns:

the timestamp of the last maintenance run

connectionLimit

public final int connectionLimit()

Specified by:

connectionLimit in interface ServerAdmin

Returns:

the maximum number of concurrent connections this server accepts

connectionLimit

public final void connectionLimit(int value)

Specified by:

connectionLimit in interface ServerAdmin

Parameters:

value - the maximum number of concurrent connections this server accepts

requestsPerSecond

protected int requestsPerSecond()

Returns:

the number of service requests per second