org.jminor.framework.server

Interface EntityConnectionServerAdmin

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

DefaultEntityConnectionServerAdmin

public interface EntityConnectionServerAdmin
extends java.rmi.Remote

Defines the server admin service methods.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EntityConnectionServerAdmin.GcEvent Garbage collection event
static interface	EntityConnectionServerAdmin.ThreadStatistics Thread statistics

Method Summary

Modifier and Type	Method and Description
void	disconnect(java.util.UUID clientId) Unregisters the connection from the server, if connection pooling is enabled for the user the connection is pooled.
int	getActiveConnectionCount()
long	getAllocatedMemory()
ClientLog	getClientLog(java.util.UUID clientId)
java.util.Collection<RemoteClient>	getClients()
java.util.Collection<RemoteClient>	getClients(java.lang.String clientTypeId)
java.util.Collection<RemoteClient>	getClients(User user)
java.util.Collection<java.lang.String>	getClientTypes()
int	getConnectionCount()
int	getConnectionLimit()
int	getConnectionPoolCleanupInterval(User user)
java.util.List<User>	getConnectionPools()
ConnectionPoolStatistics	getConnectionPoolStatistics(User user, long since)
int	getConnectionTimeout() Returns the connection timeout in ms
Database.Statistics	getDatabaseStatistics()
java.lang.String	getDatabaseURL()
java.util.Map<java.lang.String,java.lang.String>	getEntityDefinitions()
java.util.List<EntityConnectionServerAdmin.GcEvent>	getGcEvents(long since)
java.lang.Object	getLoggingLevel()
int	getMaintenanceInterval()
int	getMaximumConnectionPoolSize(User user)
int	getMaximumPoolCheckOutTime(User user)
int	getMaximumPoolRetryWaitPeriod(User user)
long	getMaxMemory()
int	getMinimumConnectionPoolSize(User user)
int	getPoolConnectionThreshold(User user)
int	getPooledConnectionTimeout(User user)
double	getProcessCpuLoad()
int	getRequestsPerSecond()
Server.ServerInfo	getServerInfo()
double	getSystemCpuLoad()
java.lang.String	getSystemProperties()
EntityConnectionServerAdmin.ThreadStatistics	getThreadStatistics()
long	getUsedMemory()
java.util.Collection<User>	getUsers()
boolean	isCollectFineGrainedPoolStatistics(User user)
boolean	isLoggingEnabled(java.util.UUID clientId) Returns true if logging is enabled for the given connection
void	removeConnections(boolean timedOutOnly) Removes connections.
void	resetConnectionPoolStatistics(User user) Resets the statistics that have been collected so far
void	setCollectFineGrainedPoolStatistics(User user, boolean value)
void	setConnectionLimit(int value)
void	setConnectionPoolCleanupInterval(User user, int poolCleanupInterval)
void	setConnectionTimeout(int timeout) Sets the connection timeout in ms
void	setLoggingEnabled(java.util.UUID clientId, boolean status) Sets the logging status for the given connection
void	setLoggingLevel(java.lang.Object level)
void	setMaintenanceInterval(int interval)
void	setMaximumConnectionPoolSize(User user, int value)
void	setMaximumPoolCheckOutTime(User user, int value)
void	setMaximumPoolRetryWaitPeriod(User user, int value)
void	setMinimumConnectionPoolSize(User user, int value)
void	setPoolConnectionThreshold(User user, int value)
void	setPooledConnectionTimeout(User user, int timeout)
void	shutdown() Shuts down the server

Method Detail

shutdown

void shutdown()
       throws java.rmi.RemoteException

Shuts down the server

Throws:

java.rmi.RemoteException - in case of a communication error

getDatabaseURL

java.lang.String getDatabaseURL()
                         throws java.rmi.RemoteException

Returns:

the database URL

Throws:

java.rmi.RemoteException - in case of a communication error

getServerInfo

Server.ServerInfo getServerInfo()
                         throws java.rmi.RemoteException

Returns:

static information about the server

Throws:

java.rmi.RemoteException - in case of an exception

getConnectionCount

int getConnectionCount()
                throws java.rmi.RemoteException

Returns:

the number of active connections

Throws:

java.rmi.RemoteException - in case of a communication error

getConnectionLimit

int getConnectionLimit()
                throws java.rmi.RemoteException

Returns:

the maximum number of concurrent connections this servers accepts

Throws:

java.rmi.RemoteException - in case of a communication error

setConnectionLimit

void setConnectionLimit(int value)
                 throws java.rmi.RemoteException

Parameters:

value - the maximum number of concurrent connections this servers accepts

Throws:

java.rmi.RemoteException - in case of a communication error

getMaintenanceInterval

int getMaintenanceInterval()
                    throws java.rmi.RemoteException

Returns:

the number of ms that should pass between maintenance cycles, that is, when inactive clients are purged

Throws:

java.rmi.RemoteException - in case of a communication error

setMaintenanceInterval

void setMaintenanceInterval(int interval)
                     throws java.rmi.RemoteException

Parameters:

interval - the number of ms that should pass between maintenance cycles, that is, when inactive clients are purged

Throws:

java.rmi.RemoteException - in case of a communication error

getClientLog

ClientLog getClientLog(java.util.UUID clientId)
                throws java.rmi.RemoteException

Parameters:

clientId - the ID of the client for which to retrieve the log

Returns:

the log for the given connection

Throws:

java.rmi.RemoteException - in case of a communication error

getActiveConnectionCount

int getActiveConnectionCount()
                      throws java.rmi.RemoteException

Returns:

the number of active connections

Throws:

java.rmi.RemoteException - in case of a communication error

isLoggingEnabled

boolean isLoggingEnabled(java.util.UUID clientId)
                  throws java.rmi.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:

java.rmi.RemoteException - in case of a communication error

setLoggingEnabled

void setLoggingEnabled(java.util.UUID clientId,
                       boolean status)
                throws java.rmi.RemoteException

Sets the logging status for the given connection

Parameters:

clientId - the ID of the client

status - the new logging status

Throws:

java.rmi.RemoteException - in case of a communication error

getAllocatedMemory

long getAllocatedMemory()
                 throws java.rmi.RemoteException

Returns:

the total amount of memory allocated by the server process

Throws:

java.rmi.RemoteException - in case of a communication error

getUsedMemory

long getUsedMemory()
            throws java.rmi.RemoteException

Returns:

the amount of memory being used by the server process

Throws:

java.rmi.RemoteException - in case of a communication error

getMaxMemory

long getMaxMemory()
           throws java.rmi.RemoteException

Returns:

the maximum amount of memory available to the server process

Throws:

java.rmi.RemoteException - in case of a communication error

getSystemCpuLoad

double getSystemCpuLoad()
                 throws java.rmi.RemoteException

Returns:

the system cpu load, a negative number if not available

Throws:

java.rmi.RemoteException - in case of a communication error

See Also:

OperatingSystemMXBean.getSystemCpuLoad()

getProcessCpuLoad

double getProcessCpuLoad()
                  throws java.rmi.RemoteException

Returns:

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

Throws:

java.rmi.RemoteException - in case of a communication error

See Also:

OperatingSystemMXBean.getProcessCpuLoad()

disconnect

void disconnect(java.util.UUID clientId)
         throws java.rmi.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:

java.rmi.RemoteException - in case of a communication error

getLoggingLevel

java.lang.Object getLoggingLevel()
                          throws java.rmi.RemoteException

Returns:

the server logging level

Throws:

java.rmi.RemoteException - in case of a communication error

setLoggingLevel

void setLoggingLevel(java.lang.Object level)
              throws java.rmi.RemoteException

Parameters:

level - the logging level

Throws:

java.rmi.RemoteException - in case of a communication error

getUsers

java.util.Collection<User> getUsers()
                             throws java.rmi.RemoteException

Returns:

the users currently connected to the server

Throws:

java.rmi.RemoteException - in case of a communication error

getClients

java.util.Collection<RemoteClient> getClients()
                                       throws java.rmi.RemoteException

Returns:

all clients connected to the server

Throws:

java.rmi.RemoteException - in case of a communication error

getClients

java.util.Collection<RemoteClient> getClients(User user)
                                       throws java.rmi.RemoteException

Parameters:

user - the user for which to retrieve the clients

Returns:

the clients associated with the given user

Throws:

java.rmi.RemoteException - in case of a communication error

getClients

java.util.Collection<RemoteClient> getClients(java.lang.String clientTypeId)
                                       throws java.rmi.RemoteException

Parameters:

clientTypeId - the client type for which to retrieve the clients

Returns:

the clients associated with the given user

Throws:

java.rmi.RemoteException - in case of a communication error

getConnectionTimeout

int getConnectionTimeout()
                  throws java.rmi.RemoteException

Returns the connection timeout in ms

Returns:

the connection timeout in ms

Throws:

java.rmi.RemoteException - in case of a communication error

setConnectionTimeout

void setConnectionTimeout(int timeout)
                   throws java.rmi.RemoteException

Sets the connection timeout in ms

Parameters:

timeout - the timeout in ms

Throws:

java.rmi.RemoteException - in case of a communication error

java.lang.IllegalArgumentException - in case timeout is less than zero

getClientTypes

java.util.Collection<java.lang.String> getClientTypes()
                                               throws java.rmi.RemoteException

Returns:

the identifiers of the client types connected to the server

Throws:

java.rmi.RemoteException - in case of an exception

getConnectionPools

java.util.List<User> getConnectionPools()
                                 throws java.rmi.RemoteException

Returns:

a list containing users backed by a connection pool

Throws:

java.rmi.RemoteException - in case of an exception

getConnectionPoolStatistics

ConnectionPoolStatistics getConnectionPoolStatistics(User user,
                                                     long since)
                                              throws java.rmi.RemoteException

Parameters:

user - the pool user

since - the time since from which to retrieve pool statistics

Returns:

the pool statistics

Throws:

java.rmi.RemoteException - in case of an exception

getDatabaseStatistics

Database.Statistics getDatabaseStatistics()
                                   throws java.rmi.RemoteException

Returns:

usage statistics for the underlying database

Throws:

java.rmi.RemoteException - in case of an exception

getRequestsPerSecond

int getRequestsPerSecond()
                  throws java.rmi.RemoteException

Returns:

the number of service requests per second

Throws:

java.rmi.RemoteException - in case of an exception

removeConnections

void removeConnections(boolean timedOutOnly)
                throws java.rmi.RemoteException

Removes connections.

Parameters:

timedOutOnly - if true only connections that have timed out are culled

Throws:

java.rmi.RemoteException - in case of an exception

resetConnectionPoolStatistics

void resetConnectionPoolStatistics(User user)
                            throws java.rmi.RemoteException

Resets the statistics that have been collected so far

Parameters:

user - the pool user

Throws:

java.rmi.RemoteException - in case of an exception

isCollectFineGrainedPoolStatistics

boolean isCollectFineGrainedPoolStatistics(User user)
                                    throws java.rmi.RemoteException

Parameters:

user - the pool user

Returns:

true if fine grained statistics should be collected for the given connection pool

Throws:

java.rmi.RemoteException - in case of an exception

setCollectFineGrainedPoolStatistics

void setCollectFineGrainedPoolStatistics(User user,
                                         boolean value)
                                  throws java.rmi.RemoteException

Parameters:

user - the pool user

value - true if fine grained statistics should be collected for the given connection pool

Throws:

java.rmi.RemoteException - in case of an exception

getSystemProperties

java.lang.String getSystemProperties()
                              throws java.rmi.RemoteException

Returns:

the server system properties

Throws:

java.rmi.RemoteException - in case of an exception

getGcEvents

java.util.List<EntityConnectionServerAdmin.GcEvent> getGcEvents(long since)
                                                         throws java.rmi.RemoteException

Parameters:

since - the time since from which to get gc events

Returns:

a list containing garbage collection notifications

Throws:

java.rmi.RemoteException - in case of an exception

getThreadStatistics

EntityConnectionServerAdmin.ThreadStatistics getThreadStatistics()
                                                          throws java.rmi.RemoteException

Returns:

current thread statistics

Throws:

java.rmi.RemoteException - in case of an exception

getEntityDefinitions

java.util.Map<java.lang.String,java.lang.String> getEntityDefinitions()
                                                               throws java.rmi.RemoteException

Returns:

a map containing all entityIds, with their respective table names as an associated value

Throws:

java.rmi.RemoteException - in case of an exception

getConnectionPoolCleanupInterval

int getConnectionPoolCleanupInterval(User user)
                              throws java.rmi.RemoteException

Parameters:

user - the pool user

Returns:

the pool cleanup interval in ms

Throws:

java.rmi.RemoteException - in case of an exception

setConnectionPoolCleanupInterval

void setConnectionPoolCleanupInterval(User user,
                                      int poolCleanupInterval)
                               throws java.rmi.RemoteException

Parameters:

user - the pool user

poolCleanupInterval - the pool cleanup interval in ms

Throws:

java.rmi.RemoteException - in case of an exception

getPooledConnectionTimeout

int getPooledConnectionTimeout(User user)
                        throws java.rmi.RemoteException

Parameters:

user - the pool user

Returns:

the pooled connection timeout in ms

Throws:

java.rmi.RemoteException - in case of an exception

setPooledConnectionTimeout

void setPooledConnectionTimeout(User user,
                                int timeout)
                         throws java.rmi.RemoteException

Parameters:

user - the pool user

timeout - the pooled connection timeout in ms

Throws:

java.rmi.RemoteException - in case of an exception

getMaximumPoolRetryWaitPeriod

int getMaximumPoolRetryWaitPeriod(User user)
                           throws java.rmi.RemoteException

Parameters:

user - the pool user

Returns:

the maximum time to wait between check out retries in ms

Throws:

java.rmi.RemoteException - in case of an exception

setMaximumPoolRetryWaitPeriod

void setMaximumPoolRetryWaitPeriod(User user,
                                   int value)
                            throws java.rmi.RemoteException

Parameters:

user - the pool user

value - the maximum time to wait between check out retries in ms

Throws:

java.rmi.RemoteException - in case of an exception

getMaximumPoolCheckOutTime

int getMaximumPoolCheckOutTime(User user)
                        throws java.rmi.RemoteException

Parameters:

user - the pool user

Returns:

the maximum time in ms to retry checking out a connection before throwing an exception

Throws:

java.rmi.RemoteException - in case of an exception

setMaximumPoolCheckOutTime

void setMaximumPoolCheckOutTime(User user,
                                int value)
                         throws java.rmi.RemoteException

Parameters:

user - the pool user

value - the maximum time in ms to retry checking out a connection before throwing an exception

Throws:

java.rmi.RemoteException - in case of an exception

getMaximumConnectionPoolSize

int getMaximumConnectionPoolSize(User user)
                          throws java.rmi.RemoteException

Parameters:

user - the pool user

Returns:

the maximum connection pool size

Throws:

java.rmi.RemoteException - in case of an exception

setMaximumConnectionPoolSize

void setMaximumConnectionPoolSize(User user,
                                  int value)
                           throws java.rmi.RemoteException

Parameters:

user - the pool user

value - the maximum connection pool size

Throws:

java.rmi.RemoteException - in case of an exception

getMinimumConnectionPoolSize

int getMinimumConnectionPoolSize(User user)
                          throws java.rmi.RemoteException

Parameters:

user - the pool user

Returns:

the minimum connection pool size

Throws:

java.rmi.RemoteException - in case of an exception

setMinimumConnectionPoolSize

void setMinimumConnectionPoolSize(User user,
                                  int value)
                           throws java.rmi.RemoteException

Parameters:

user - the pool user

value - the minimum connection pool size

Throws:

java.rmi.RemoteException - in case of an exception

getPoolConnectionThreshold

int getPoolConnectionThreshold(User user)
                        throws java.rmi.RemoteException

Parameters:

user - the pool user

Returns:

the number of milliseconds to wait before trying to create a new connection

Throws:

java.rmi.RemoteException - in case of an exception

setPoolConnectionThreshold

void setPoolConnectionThreshold(User user,
                                int value)
                         throws java.rmi.RemoteException

Parameters:

user - the pool user

value - the number of milliseconds to wait before trying to create a new connection

Throws:

java.rmi.RemoteException - in case of an exception