Module is.codion.common.rmi

Package is.codion.common.rmi.server

Class DefaultServerAdmin

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

is.codion.common.rmi.server.DefaultServerAdmin

All Implemented Interfaces:

ServerAdmin, Serializable, Remote

public class DefaultServerAdmin
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

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

Method Summary

Modifier and Type	Method	Description
final long	allocatedMemory()
final Collection<RemoteClient>	clients()
final Collection<RemoteClient>	clients(User user)
final Collection<RemoteClient>	clients(String clientTypeId)
final Collection<String>	clientTypes()
final int	connectionCount()
final void	disconnect(UUID clientId)	Unregisters the connection from the server, if connection pooling is enabled for the user the connection is pooled.
final List<ServerAdmin.GcEvent>	gcEvents(long since)
final int	getConnectionLimit()
final long	maxMemory()
final double	processCpuLoad()
int	requestsPerSecond()
final ServerInformation	serverInformation()
final ServerAdmin.ServerStatistics	serverStatistics(long since)
final void	setConnectionLimit(int value)
final void	shutdown()	Shuts down the server
final double	systemCpuLoad()
final String	systemProperties()
final ServerAdmin.ThreadStatistics	threadStatistics()
final long	usedMemory()
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

DefaultServerAdmin

public DefaultServerAdmin(AbstractServer<?,? extends ServerAdmin> server,
 ServerConfiguration configuration)
                   throws RemoteException

Instantiates a new DefaultServerAdmin 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

gcEvents

public final List<ServerAdmin.GcEvent> gcEvents(long since)

Specified by:

gcEvents in interface ServerAdmin

Parameters:

since - the time since from which to get gc events

Returns:

a list containing garbage collection notifications

threadStatistics

public final ServerAdmin.ThreadStatistics threadStatistics()
                                                    throws RemoteException

Specified by:

threadStatistics in interface ServerAdmin

Returns:

current thread statistics

Throws:

RemoteException - in case of an exception

users

public final Collection<User> users()
                             throws RemoteException

Specified by:

users in interface ServerAdmin

Returns:

the users currently connected to the server

Throws:

RemoteException - in case of a communication error

clients

public final Collection<RemoteClient> clients(User user)
                                       throws RemoteException

Specified by:

clients in interface ServerAdmin

Parameters:

user - the user for which to retrieve the clients

Returns:

the clients associated with the given user

Throws:

RemoteException - in case of a communication error

clients

public final Collection<RemoteClient> clients(String clientTypeId)

Specified by:

clients in interface ServerAdmin

Parameters:

clientTypeId - the client type for which to retrieve the clients

Returns:

the clients associated with the given user

clients

public final Collection<RemoteClient> clients()

Specified by:

clients in interface ServerAdmin

Returns:

all clients connected to the server

clientTypes

public final Collection<String> clientTypes()

Specified by:

clientTypes in interface ServerAdmin

Returns:

the identifiers of the client types connected to the server

disconnect

public final void disconnect(UUID clientId)
                      throws RemoteException

Description copied from interface: ServerAdmin

Unregisters the connection from the server, if connection pooling is enabled for the user the connection is pooled.

Specified by:

disconnect in interface ServerAdmin

Parameters:

clientId - the id of the client

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

requestsPerSecond

public int requestsPerSecond()

Specified by:

requestsPerSecond in interface ServerAdmin

Returns:

the number of service requests per second

serverStatistics

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

Specified by:

serverStatistics 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

allocatedMemory

public final long allocatedMemory()

Specified by:

allocatedMemory in interface ServerAdmin

Returns:

the total amount of memory allocated by the server process

usedMemory

public final long usedMemory()

Specified by:

usedMemory in interface ServerAdmin

Returns:

the amount of memory being used by the server process

maxMemory

public final long maxMemory()

Specified by:

maxMemory in interface ServerAdmin

Returns:

the maximum amount of memory available to the server process

systemCpuLoad

public final double systemCpuLoad()
                           throws RemoteException

Specified by:

systemCpuLoad in interface ServerAdmin

Returns:

the system cpu load, a negative number if not available

Throws:

RemoteException - in case of a communication error

See Also:

• OperatingSystemMXBean.getSystemCpuLoad()

processCpuLoad

public final double processCpuLoad()
                            throws RemoteException

Specified by:

processCpuLoad in interface ServerAdmin

Returns:

the java vm process cpu load, a negative number if not available

Throws:

RemoteException - in case of a communication error

See Also:

• OperatingSystemMXBean.getProcessCpuLoad()

connectionCount

public final int connectionCount()

Specified by:

connectionCount in interface ServerAdmin

Returns:

the number of active connections

getConnectionLimit

public final int getConnectionLimit()

Specified by:

getConnectionLimit in interface ServerAdmin

Returns:

the maximum number of concurrent connections this server accepts

setConnectionLimit

public final void setConnectionLimit(int value)

Specified by:

setConnectionLimit in interface ServerAdmin

Parameters:

value - the maximum number of concurrent connections this server accepts