Module is.codion.framework.server
Package is.codion.framework.server

Interface EntityServerAdmin

All Superinterfaces:
Remote, ServerAdmin
public interface EntityServerAdmin extends ServerAdmin
Defines the entity server admin service methods.

  • Method Details

    • databaseUrl

      String databaseUrl() throws RemoteException
      Returns:
      the database URL
      Throws:
      RemoteException - in case of a communication error

    • maintenanceInterval

      int maintenanceInterval() throws RemoteException
      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

    • maintenanceInterval

      void maintenanceInterval(int interval) throws RemoteException
      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

    • methodTraces

      List<MethodTrace> methodTraces(UUID clientId) throws RemoteException
      Parameters:
      clientId - the id of the client for which to retrieve the log
      Returns:
      the method trace log for the given connection
      Throws:
      RemoteException - in case of a communication error

    • traceToFile

      boolean traceToFile(UUID clientId) throws RemoteException
      Parameters:
      clientId - the client id
      Returns:
      true if method traces are written to file for the given client
      Throws:
      RemoteException - in case of a communication error

    • traceToFile

      void traceToFile(UUID clientId, boolean traceToFile) throws RemoteException
      Parameters:
      clientId - the client id
      traceToFile - true if method traces should be written to file
      Throws:
      RemoteException - in case of a communication error

    • tracingEnabled

      boolean tracingEnabled(UUID clientId) throws RemoteException
      Returns true if logging is enabled for the given connection
      Parameters:
      clientId - the id of the client
      Returns:
      true if method tracing is enabled for the given connection
      Throws:
      RemoteException - in case of a communication error

    • tracingEnabled

      void tracingEnabled(UUID clientId, boolean tracingEnabled) throws RemoteException
      Sets the method tracing status for the given connection
      Parameters:
      clientId - the id of the client
      tracingEnabled - the new tracing status
      Throws:
      RemoteException - in case of a communication error

    • logLevel

      Object logLevel(String logger) throws RemoteException
      Parameters:
      logger - the logger
      Returns:
      the log level
      Throws:
      RemoteException - in case of a communication error

    • logLevel

      void logLevel(String logger, Object level) throws RemoteException
      Parameters:
      logger - the logger
      level - the log level
      Throws:
      RemoteException - in case of a communication error

    • rootLogger

      String rootLogger() throws RemoteException
      Returns:
      the root logger name
      Throws:
      RemoteException

    • loggers

      Collection<String> loggers() throws RemoteException
      Returns:
      the active server loggers
      Throws:
      RemoteException - in case of a communication error

    • logLevels

      Collection<Object> logLevels() throws RemoteException
      Returns:
      the server log levels
      Throws:
      RemoteException - in case of a communication error

    • idleConnectionTimeout

      int idleConnectionTimeout() throws RemoteException
      Returns the idle connection timeout in ms
      Returns:
      the idle connection timeout in ms
      Throws:
      RemoteException - in case of a communication error

    • idleConnectionTimeout

      void idleConnectionTimeout(int idleConnectionTimeout) throws RemoteException
      Sets the idle connection timeout in ms
      Parameters:
      idleConnectionTimeout - the timeout in ms
      Throws:
      RemoteException - in case of a communication error
      IllegalArgumentException - in case timeout is less than zero

    • connectionPoolUsernames

      Collection<String> connectionPoolUsernames() throws RemoteException
      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 username
      since - the time since from which to retrieve pool statistics
      Returns:
      the pool statistics
      Throws:
      RemoteException - in case of an exception

    • databaseStatistics

      Database.Statistics databaseStatistics() throws RemoteException
      Returns the statistics gathered via Database.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

      void disconnectTimedOutClients() throws RemoteException
      Disconnects all timed-out clients.
      Throws:
      RemoteException - in case of an exception

    • disconnectAllClients

      void disconnectAllClients() throws RemoteException
      Disconnects all connected clients.
      Throws:
      RemoteException - in case of an exception

    • resetConnectionPoolStatistics

      void resetConnectionPoolStatistics(String username) throws RemoteException
      Resets the statistics that have been collected so far
      Parameters:
      username - the username
      Throws:
      RemoteException - in case of an exception

    • collectPoolSnapshotStatistics

      boolean collectPoolSnapshotStatistics(String username) throws RemoteException
      Parameters:
      username - the username
      Returns:
      true if snapshot statistics should be collected for the given connection pool
      Throws:
      RemoteException - in case of an exception

    • collectPoolSnapshotStatistics

      void collectPoolSnapshotStatistics(String username, boolean snapshotStatistics) throws RemoteException
      Parameters:
      username - the username
      snapshotStatistics - true if statistics should be collected for a snapshot of the given connection pool
      Throws:
      RemoteException - in case of an exception

    • collectPoolCheckOutTimes

      boolean collectPoolCheckOutTimes(String username) throws RemoteException
      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

    • collectPoolCheckOutTimes

      void collectPoolCheckOutTimes(String username, boolean collectCheckOutTimes) throws RemoteException
      Parameters:
      username - the username
      collectCheckOutTimes - 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

      Map<String,Collection<EntityServerAdmin.DomainReport>> domainReports() throws RemoteException
      Returns:
      a map containing each domain name with its reports
      Throws:
      RemoteException - in case of an exception

    • domainOperations

      Map<String,Collection<EntityServerAdmin.DomainOperation>> domainOperations() throws RemoteException
      Returns:
      a map containing each domain name with its operations
      Throws:
      RemoteException - in case of an exception

    • clearReportCache

      void clearReportCache() throws RemoteException
      Clears any cached reports
      Throws:
      RemoteException - in case of an exception

    • connectionPoolCleanupInterval

      int connectionPoolCleanupInterval(String username) throws RemoteException
      Parameters:
      username - the username
      Returns:
      the pool cleanup interval in ms
      Throws:
      RemoteException - in case of an exception

    • connectionPoolCleanupInterval

      void connectionPoolCleanupInterval(String username, int poolCleanupInterval) throws RemoteException
      Parameters:
      username - the username
      poolCleanupInterval - the pool cleanup interval in ms
      Throws:
      RemoteException - in case of an exception

    • pooledConnectionIdleTimeout

      int pooledConnectionIdleTimeout(String username) throws RemoteException
      Parameters:
      username - the username
      Returns:
      the pooled connection timeout in ms
      Throws:
      RemoteException - in case of an exception

    • pooledConnectionIdleTimeout

      void pooledConnectionIdleTimeout(String username, int pooledConnectionIdleTimeout) throws RemoteException
      Parameters:
      username - the username
      pooledConnectionIdleTimeout - the pooled connection timeout in ms
      Throws:
      RemoteException - in case of an exception

    • maximumPoolCheckOutTime

      int maximumPoolCheckOutTime(String username) throws RemoteException
      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

    • maximumPoolCheckOutTime

      void maximumPoolCheckOutTime(String username, int value) throws RemoteException
      Parameters:
      username - the username
      value - the maximum time in ms to retry checking out a connection before throwing an exception
      Throws:
      RemoteException - in case of an exception

    • maximumConnectionPoolSize

      int maximumConnectionPoolSize(String username) throws RemoteException
      Parameters:
      username - the username
      Returns:
      the maximum connection pool size
      Throws:
      RemoteException - in case of an exception

    • maximumConnectionPoolSize

      void maximumConnectionPoolSize(String username, int value) throws RemoteException
      Parameters:
      username - the username
      value - the maximum connection pool size
      Throws:
      RemoteException - in case of an exception

    • minimumConnectionPoolSize

      int minimumConnectionPoolSize(String username) throws RemoteException
      Parameters:
      username - the username
      Returns:
      the minimum connection pool size
      Throws:
      RemoteException - in case of an exception

    • minimumConnectionPoolSize

      void minimumConnectionPoolSize(String username, int value) throws RemoteException
      Parameters:
      username - the username
      value - the minimum connection pool size
      Throws:
      RemoteException - in case of an exception