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

    • getMaintenanceInterval

      int getMaintenanceInterval() 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

    • setMaintenanceInterval

      void setMaintenanceInterval(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

    • clientLog

      ClientLog clientLog(UUID clientId) throws RemoteException
      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

      boolean isLoggingEnabled(UUID clientId) throws RemoteException
      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

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

    • getLogLevel

      Object getLogLevel() throws RemoteException
      Returns:
      the server log level
      Throws:
      RemoteException - in case of a communication error

    • setLogLevel

      void setLogLevel(Object level) throws RemoteException
      Parameters:
      level - the log level
      Throws:
      RemoteException - in case of a communication error

    • getIdleConnectionTimeout

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

    • setIdleConnectionTimeout

      void setIdleConnectionTimeout(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

    • isCollectPoolSnapshotStatistics

      boolean isCollectPoolSnapshotStatistics(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

    • setCollectPoolSnapshotStatistics

      void setCollectPoolSnapshotStatistics(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

    • isCollectPoolCheckOutTimes

      boolean isCollectPoolCheckOutTimes(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

    • setCollectPoolCheckOutTimes

      void setCollectPoolCheckOutTimes(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

    • getConnectionPoolCleanupInterval

      int getConnectionPoolCleanupInterval(String username) throws RemoteException
      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 username
      poolCleanupInterval - the pool cleanup interval in ms
      Throws:
      RemoteException - in case of an exception

    • getPooledConnectionIdleTimeout

      int getPooledConnectionIdleTimeout(String username) throws RemoteException
      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 username
      pooledConnectionIdleTimeout - the pooled connection timeout in ms
      Throws:
      RemoteException - in case of an exception

    • getMaximumPoolCheckOutTime

      int getMaximumPoolCheckOutTime(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

    • setMaximumPoolCheckOutTime

      void setMaximumPoolCheckOutTime(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

    • getMaximumConnectionPoolSize

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

    • setMaximumConnectionPoolSize

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

    • getMinimumConnectionPoolSize

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

    • setMinimumConnectionPoolSize

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