-
- All Superinterfaces:
Remote
- All Known Subinterfaces:
EntityServerAdmin
- All Known Implementing Classes:
DefaultServerAdmin
public interface ServerAdmin extends Remote
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ServerAdmin.GcEvent
Garbage collection eventstatic interface
ServerAdmin.ServerStatistics
Basic server performance statistics.static interface
ServerAdmin.ThreadStatistics
Thread statistics
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
allocatedMemory()
Collection<RemoteClient>
clients()
Collection<RemoteClient>
clients(User user)
Collection<RemoteClient>
clients(String clientTypeId)
Collection<String>
clientTypes()
int
connectionCount()
void
disconnect(UUID clientId)
Unregisters the connection from the server, if connection pooling is enabled for the user the connection is pooled.List<ServerAdmin.GcEvent>
gcEvents(long since)
int
getConnectionLimit()
long
maxMemory()
double
processCpuLoad()
int
requestsPerSecond()
ServerInformation
serverInformation()
ServerAdmin.ServerStatistics
serverStatistics(long since)
void
setConnectionLimit(int value)
void
shutdown()
Shuts down the serverdouble
systemCpuLoad()
String
systemProperties()
ServerAdmin.ThreadStatistics
threadStatistics()
long
usedMemory()
Collection<User>
users()
-
-
-
Method Detail
-
disconnect
void disconnect(UUID clientId) throws RemoteException
Unregisters the connection from the server, if connection pooling is enabled for the user the connection is pooled.- Parameters:
clientId
- the id of the client- 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
-
clients
Collection<RemoteClient> clients(User user) throws RemoteException
- 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
Collection<RemoteClient> clients(String clientTypeId) throws RemoteException
- Parameters:
clientTypeId
- the client type for which to retrieve the clients- Returns:
- the clients associated with the given user
- Throws:
RemoteException
- in case of a communication error
-
clientTypes
Collection<String> clientTypes() throws RemoteException
- Returns:
- the identifiers of the client types connected to the server
- Throws:
RemoteException
- in case of an exception
-
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
-
requestsPerSecond
int requestsPerSecond() throws RemoteException
- Returns:
- the number of service requests per second
- 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
-
allocatedMemory
long allocatedMemory() throws RemoteException
- Returns:
- the total amount of memory allocated by the server process
- Throws:
RemoteException
- in case of a communication error
-
usedMemory
long usedMemory() throws RemoteException
- Returns:
- the amount of memory being used by the server process
- Throws:
RemoteException
- in case of a communication error
-
maxMemory
long maxMemory() throws RemoteException
- Returns:
- the maximum amount of memory available to the server process
- Throws:
RemoteException
- in case of a communication error
-
systemCpuLoad
double systemCpuLoad() throws RemoteException
- Returns:
- the system cpu load, a negative number if not available
- Throws:
RemoteException
- in case of a communication error- See Also:
OperatingSystemMXBean.getSystemCpuLoad()
-
processCpuLoad
double processCpuLoad() throws RemoteException
- 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()
-
systemProperties
String systemProperties() throws RemoteException
- Returns:
- the server system properties
- Throws:
RemoteException
- in case of an exception
-
gcEvents
List<ServerAdmin.GcEvent> gcEvents(long since) throws RemoteException
- Parameters:
since
- the time since from which to get gc events- Returns:
- a list containing garbage collection notifications
- Throws:
RemoteException
- in case of an exception
-
threadStatistics
ServerAdmin.ThreadStatistics threadStatistics() throws RemoteException
- Returns:
- current thread statistics
- 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
-
-