- All Superinterfaces:
Remote
,ServerAdmin
Defines the entity server admin service methods.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Basic information about a entity definition.static interface
Basic information about an operation.static interface
Basic information about a report.Nested classes/interfaces inherited from interface is.codion.common.rmi.server.ServerAdmin
ServerAdmin.GcEvent, ServerAdmin.ServerStatistics, ServerAdmin.ThreadStatistics
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Clears any cached reportsconnectionPoolStatistics
(String username, long since) Returns the statistics gathered viaDatabase.queryCounter()
.void
Disconnects all connected clients.void
Disconnects all timed-out clients.int
getConnectionPoolCleanupInterval
(String username) int
Returns the idle connection timeout in msint
int
getMaximumConnectionPoolSize
(String username) int
getMaximumPoolCheckOutTime
(String username) int
getMinimumConnectionPoolSize
(String username) int
getPooledConnectionIdleTimeout
(String username) boolean
isCollectPoolCheckOutTimes
(String username) boolean
isCollectPoolSnapshotStatistics
(String username) boolean
isLoggingEnabled
(UUID clientId) Returns true if logging is enabled for the given connectionvoid
resetConnectionPoolStatistics
(String username) Resets the statistics that have been collected so farvoid
setCollectPoolCheckOutTimes
(String username, boolean collectCheckOutTimes) void
setCollectPoolSnapshotStatistics
(String username, boolean snapshotStatistics) void
setConnectionPoolCleanupInterval
(String username, int poolCleanupInterval) void
setIdleConnectionTimeout
(int idleConnectionTimeout) Sets the idle connection timeout in msvoid
setLoggingEnabled
(UUID clientId, boolean loggingEnabled) Sets the logging status for the given connectionvoid
setLogLevel
(Object level) void
setMaintenanceInterval
(int interval) void
setMaximumConnectionPoolSize
(String username, int value) void
setMaximumPoolCheckOutTime
(String username, int value) void
setMinimumConnectionPoolSize
(String username, int value) void
setPooledConnectionIdleTimeout
(String username, int pooledConnectionIdleTimeout) Methods inherited from interface is.codion.common.rmi.server.ServerAdmin
allocatedMemory, clients, clients, clients, clientTypes, connectionCount, disconnect, gcEvents, getConnectionLimit, maxMemory, processCpuLoad, requestsPerSecond, serverInformation, serverStatistics, setConnectionLimit, shutdown, systemCpuLoad, systemProperties, threadStatistics, usedMemory, users
-
Method Details
-
databaseUrl
- Returns:
- the database URL
- Throws:
RemoteException
- in case of a communication error
-
getMaintenanceInterval
- Returns:
- the number of ms that should pass between maintenance cycles, that is, when inactive clients are purged
- Throws:
RemoteException
- in case of a communication error
-
setMaintenanceInterval
- Parameters:
interval
- the number of ms that should pass between maintenance cycles, that is, when inactive clients are purged- Throws:
RemoteException
- in case of a communication error
-
clientLog
- Parameters:
clientId
- the id of the client for which to retrieve the log- Returns:
- the log for the given connection
- Throws:
RemoteException
- in case of a communication error
-
isLoggingEnabled
Returns true if logging is enabled for the given connection- Parameters:
clientId
- the id of the client- Returns:
- true if logging is on for the given connection
- Throws:
RemoteException
- in case of a communication error
-
setLoggingEnabled
Sets the logging status for the given connection- Parameters:
clientId
- the id of the clientloggingEnabled
- the new logging status- Throws:
RemoteException
- in case of a communication error
-
getLogLevel
- Returns:
- the server log level
- Throws:
RemoteException
- in case of a communication error
-
setLogLevel
- Parameters:
level
- the log level- Throws:
RemoteException
- in case of a communication error
-
getIdleConnectionTimeout
Returns the idle connection timeout in ms- Returns:
- the idle connection timeout in ms
- Throws:
RemoteException
- in case of a communication error
-
setIdleConnectionTimeout
Sets the idle connection timeout in ms- Parameters:
idleConnectionTimeout
- the timeout in ms- Throws:
RemoteException
- in case of a communication errorIllegalArgumentException
- in case timeout is less than zero
-
connectionPoolUsernames
- Returns:
- a collection containing usernames backed by a connection pool
- Throws:
RemoteException
- in case of an exception
-
connectionPoolStatistics
ConnectionPoolStatistics connectionPoolStatistics(String username, long since) throws RemoteException - Parameters:
username
- the usernamesince
- the time since from which to retrieve pool statistics- Returns:
- the pool statistics
- Throws:
RemoteException
- in case of an exception
-
databaseStatistics
Returns the statistics gathered viaDatabase.queryCounter()
.- Returns:
- a
Database.Statistics
object containing query statistics collected since the last time this function was called. - Throws:
RemoteException
- in case of an exception
-
disconnectTimedOutClients
Disconnects all timed-out clients.- Throws:
RemoteException
- in case of an exception
-
disconnectAllClients
Disconnects all connected clients.- Throws:
RemoteException
- in case of an exception
-
resetConnectionPoolStatistics
Resets the statistics that have been collected so far- Parameters:
username
- the username- Throws:
RemoteException
- in case of an exception
-
isCollectPoolSnapshotStatistics
- Parameters:
username
- the username- Returns:
- true if snapshot statistics should be collected for the given connection pool
- Throws:
RemoteException
- in case of an exception
-
setCollectPoolSnapshotStatistics
void setCollectPoolSnapshotStatistics(String username, boolean snapshotStatistics) throws RemoteException - Parameters:
username
- the usernamesnapshotStatistics
- true if statistics should be collected for a snapshot of the given connection pool- Throws:
RemoteException
- in case of an exception
-
isCollectPoolCheckOutTimes
- Parameters:
username
- the username- Returns:
- true if check out times statistics should be collected for the given connection pool
- Throws:
RemoteException
- in case of an exception
-
setCollectPoolCheckOutTimes
void setCollectPoolCheckOutTimes(String username, boolean collectCheckOutTimes) throws RemoteException - Parameters:
username
- the usernamecollectCheckOutTimes
- true if check out times should be collected for the given connection pool- Throws:
RemoteException
- in case of an exception
-
domainEntityDefinitions
Map<String,Collection<EntityServerAdmin.DomainEntityDefinition>> domainEntityDefinitions() throws RemoteException- Returns:
- a map containing each domain name and its entity definitions
- Throws:
RemoteException
- in case of an exception
-
domainReports
- Returns:
- a map containing each domain name with its reports
- Throws:
RemoteException
- in case of an exception
-
domainOperations
- Returns:
- a map containing each domain name with its operations
- Throws:
RemoteException
- in case of an exception
-
clearReportCache
Clears any cached reports- Throws:
RemoteException
- in case of an exception
-
getConnectionPoolCleanupInterval
- Parameters:
username
- the username- Returns:
- the pool cleanup interval in ms
- Throws:
RemoteException
- in case of an exception
-
setConnectionPoolCleanupInterval
void setConnectionPoolCleanupInterval(String username, int poolCleanupInterval) throws RemoteException - Parameters:
username
- the usernamepoolCleanupInterval
- the pool cleanup interval in ms- Throws:
RemoteException
- in case of an exception
-
getPooledConnectionIdleTimeout
- Parameters:
username
- the username- Returns:
- the pooled connection timeout in ms
- Throws:
RemoteException
- in case of an exception
-
setPooledConnectionIdleTimeout
void setPooledConnectionIdleTimeout(String username, int pooledConnectionIdleTimeout) throws RemoteException - Parameters:
username
- the usernamepooledConnectionIdleTimeout
- the pooled connection timeout in ms- Throws:
RemoteException
- in case of an exception
-
getMaximumPoolCheckOutTime
- Parameters:
username
- the username- Returns:
- the maximum time in ms to retry checking out a connection before throwing an exception
- Throws:
RemoteException
- in case of an exception
-
setMaximumPoolCheckOutTime
- Parameters:
username
- the usernamevalue
- the maximum time in ms to retry checking out a connection before throwing an exception- Throws:
RemoteException
- in case of an exception
-
getMaximumConnectionPoolSize
- Parameters:
username
- the username- Returns:
- the maximum connection pool size
- Throws:
RemoteException
- in case of an exception
-
setMaximumConnectionPoolSize
- Parameters:
username
- the usernamevalue
- the maximum connection pool size- Throws:
RemoteException
- in case of an exception
-
getMinimumConnectionPoolSize
- Parameters:
username
- the username- Returns:
- the minimum connection pool size
- Throws:
RemoteException
- in case of an exception
-
setMinimumConnectionPoolSize
- Parameters:
username
- the usernamevalue
- the minimum connection pool size- Throws:
RemoteException
- in case of an exception
-