org.jminor.framework.server

Class DefaultEntityConnectionServerAdmin

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.jminor.framework.server.DefaultEntityConnectionServerAdmin

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, EntityConnectionServerAdmin

public final class DefaultEntityConnectionServerAdmin
extends java.rmi.server.UnicastRemoteObject
implements EntityConnectionServerAdmin

Implements the EntityConnectionServerAdmin interface, providing admin access to a EntityConnectionServer instance.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.jminor.framework.server.EntityConnectionServerAdmin

EntityConnectionServerAdmin.GcEvent, EntityConnectionServerAdmin.ThreadStatistics

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor and Description
DefaultEntityConnectionServerAdmin(DefaultEntityConnectionServer server, java.lang.Integer serverAdminPort) Instantiates a new DefaultEntityConnectionServerAdmin

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

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultEntityConnectionServerAdmin

public DefaultEntityConnectionServerAdmin(DefaultEntityConnectionServer server,
                                          java.lang.Integer serverAdminPort)
                                   throws java.rmi.RemoteException

Instantiates a new DefaultEntityConnectionServerAdmin

Parameters:

server - the server to administer

serverAdminPort - the port on which to make the server admin available

Throws:

java.rmi.RemoteException - in case of an exception

java.lang.NullPointerException - in case serverAdminPort or server are not specified

Method Detail

getServerInfo

public Server.ServerInfo getServerInfo()

Specified by:

getServerInfo in interface EntityConnectionServerAdmin

Returns:

static information about the server

getSystemProperties

public java.lang.String getSystemProperties()

Specified by:

getSystemProperties in interface EntityConnectionServerAdmin

Returns:

the server system properties

getGcEvents

public java.util.List<EntityConnectionServerAdmin.GcEvent> getGcEvents(long since)

Specified by:

getGcEvents in interface EntityConnectionServerAdmin

Parameters:

since - the time since from which to get gc events

Returns:

a list containing garbage collection notifications

getThreadStatistics

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

Specified by:

getThreadStatistics in interface EntityConnectionServerAdmin

Returns:

current thread statistics

Throws:

java.rmi.RemoteException - in case of an exception

getDatabaseURL

public java.lang.String getDatabaseURL()

Specified by:

getDatabaseURL in interface EntityConnectionServerAdmin

Returns:

the database URL

getLoggingLevel

public java.lang.Object getLoggingLevel()

Specified by:

getLoggingLevel in interface EntityConnectionServerAdmin

Returns:

the server logging level

setLoggingLevel

public void setLoggingLevel(java.lang.Object level)

Specified by:

setLoggingLevel in interface EntityConnectionServerAdmin

Parameters:

level - the logging level

getUsers

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

Specified by:

getUsers in interface EntityConnectionServerAdmin

Returns:

the users currently connected to the server

Throws:

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

getClients

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

Specified by:

getClients in interface EntityConnectionServerAdmin

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

public java.util.Collection<RemoteClient> getClients(java.lang.String clientTypeId)

Specified by:

getClients in interface EntityConnectionServerAdmin

Parameters:

clientTypeId - the client type for which to retrieve the clients

Returns:

the clients associated with the given user

getClients

public java.util.Collection<RemoteClient> getClients()

Specified by:

getClients in interface EntityConnectionServerAdmin

Returns:

all clients connected to the server

getClientTypes

public java.util.Collection<java.lang.String> getClientTypes()

Specified by:

getClientTypes in interface EntityConnectionServerAdmin

Returns:

the identifiers of the client types connected to the server

disconnect

public 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.

Specified by:

disconnect in interface EntityConnectionServerAdmin

Parameters:

clientId - the ID of the client

Throws:

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

shutdown

public void shutdown()
              throws java.rmi.RemoteException

Shuts down the server

Specified by:

shutdown in interface EntityConnectionServerAdmin

Throws:

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

getActiveConnectionCount

public int getActiveConnectionCount()

Specified by:

getActiveConnectionCount in interface EntityConnectionServerAdmin

Returns:

the number of active connections

getMaintenanceInterval

public int getMaintenanceInterval()

Specified by:

getMaintenanceInterval in interface EntityConnectionServerAdmin

Returns:

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

setMaintenanceInterval

public void setMaintenanceInterval(int interval)

Specified by:

setMaintenanceInterval in interface EntityConnectionServerAdmin

Parameters:

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

removeConnections

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

Removes connections.

Specified by:

removeConnections in interface EntityConnectionServerAdmin

Parameters:

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

Throws:

java.rmi.RemoteException - in case of an exception

resetConnectionPoolStatistics

public void resetConnectionPoolStatistics(User user)

Resets the statistics that have been collected so far

Specified by:

resetConnectionPoolStatistics in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

isCollectFineGrainedPoolStatistics

public boolean isCollectFineGrainedPoolStatistics(User user)

Specified by:

isCollectFineGrainedPoolStatistics in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

Returns:

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

setCollectFineGrainedPoolStatistics

public void setCollectFineGrainedPoolStatistics(User user,
                                                boolean value)

Specified by:

setCollectFineGrainedPoolStatistics in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

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

getRequestsPerSecond

public int getRequestsPerSecond()

Specified by:

getRequestsPerSecond in interface EntityConnectionServerAdmin

Returns:

the number of service requests per second

getConnectionPoolStatistics

public ConnectionPoolStatistics getConnectionPoolStatistics(User user,
                                                            long since)

Specified by:

getConnectionPoolStatistics in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

since - the time since from which to retrieve pool statistics

Returns:

the pool statistics

getDatabaseStatistics

public Database.Statistics getDatabaseStatistics()

Specified by:

getDatabaseStatistics in interface EntityConnectionServerAdmin

Returns:

usage statistics for the underlying database

getConnectionPools

public java.util.List<User> getConnectionPools()

Specified by:

getConnectionPools in interface EntityConnectionServerAdmin

Returns:

a list containing users backed by a connection pool

getConnectionPoolCleanupInterval

public int getConnectionPoolCleanupInterval(User user)

Specified by:

getConnectionPoolCleanupInterval in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

Returns:

the pool cleanup interval in ms

setConnectionPoolCleanupInterval

public void setConnectionPoolCleanupInterval(User user,
                                             int poolCleanupInterval)

Specified by:

setConnectionPoolCleanupInterval in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

poolCleanupInterval - the pool cleanup interval in ms

getMaximumConnectionPoolSize

public int getMaximumConnectionPoolSize(User user)

Specified by:

getMaximumConnectionPoolSize in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

Returns:

the maximum connection pool size

setMaximumConnectionPoolSize

public void setMaximumConnectionPoolSize(User user,
                                         int value)

Specified by:

setMaximumConnectionPoolSize in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

value - the maximum connection pool size

getMinimumConnectionPoolSize

public int getMinimumConnectionPoolSize(User user)

Specified by:

getMinimumConnectionPoolSize in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

Returns:

the minimum connection pool size

setMinimumConnectionPoolSize

public void setMinimumConnectionPoolSize(User user,
                                         int value)

Specified by:

setMinimumConnectionPoolSize in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

value - the minimum connection pool size

getPoolConnectionThreshold

public int getPoolConnectionThreshold(User user)

Specified by:

getPoolConnectionThreshold in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

Returns:

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

setPoolConnectionThreshold

public void setPoolConnectionThreshold(User user,
                                       int value)

Specified by:

setPoolConnectionThreshold in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

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

getPooledConnectionTimeout

public int getPooledConnectionTimeout(User user)

Specified by:

getPooledConnectionTimeout in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

Returns:

the pooled connection timeout in ms

setPooledConnectionTimeout

public void setPooledConnectionTimeout(User user,
                                       int timeout)

Specified by:

setPooledConnectionTimeout in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

timeout - the pooled connection timeout in ms

getMaximumPoolRetryWaitPeriod

public int getMaximumPoolRetryWaitPeriod(User user)

Specified by:

getMaximumPoolRetryWaitPeriod in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

Returns:

the maximum time to wait between check out retries in ms

setMaximumPoolRetryWaitPeriod

public void setMaximumPoolRetryWaitPeriod(User user,
                                          int value)

Specified by:

setMaximumPoolRetryWaitPeriod in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

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

getMaximumPoolCheckOutTime

public int getMaximumPoolCheckOutTime(User user)

Specified by:

getMaximumPoolCheckOutTime in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

Returns:

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

setMaximumPoolCheckOutTime

public void setMaximumPoolCheckOutTime(User user,
                                       int value)

Specified by:

setMaximumPoolCheckOutTime in interface EntityConnectionServerAdmin

Parameters:

user - the pool user

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

getAllocatedMemory

public long getAllocatedMemory()

Specified by:

getAllocatedMemory in interface EntityConnectionServerAdmin

Returns:

the total amount of memory allocated by the server process

getUsedMemory

public long getUsedMemory()

Specified by:

getUsedMemory in interface EntityConnectionServerAdmin

Returns:

the amount of memory being used by the server process

getMaxMemory

public long getMaxMemory()

Specified by:

getMaxMemory in interface EntityConnectionServerAdmin

Returns:

the maximum amount of memory available to the server process

getSystemCpuLoad

public double getSystemCpuLoad()
                        throws java.rmi.RemoteException

Specified by:

getSystemCpuLoad in interface EntityConnectionServerAdmin

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

public double getProcessCpuLoad()
                         throws java.rmi.RemoteException

Specified by:

getProcessCpuLoad in interface EntityConnectionServerAdmin

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

getConnectionCount

public int getConnectionCount()

Specified by:

getConnectionCount in interface EntityConnectionServerAdmin

Returns:

the number of active connections

getConnectionLimit

public int getConnectionLimit()

Specified by:

getConnectionLimit in interface EntityConnectionServerAdmin

Returns:

the maximum number of concurrent connections this servers accepts

setConnectionLimit

public void setConnectionLimit(int value)

Specified by:

setConnectionLimit in interface EntityConnectionServerAdmin

Parameters:

value - the maximum number of concurrent connections this servers accepts

getClientLog

public ClientLog getClientLog(java.util.UUID clientId)

Specified by:

getClientLog in interface EntityConnectionServerAdmin

Parameters:

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

Returns:

the log for the given connection

isLoggingEnabled

public boolean isLoggingEnabled(java.util.UUID clientId)

Returns true if logging is enabled for the given connection

Specified by:

isLoggingEnabled in interface EntityConnectionServerAdmin

Parameters:

clientId - the ID of the client

Returns:

true if logging is on for the given connection

setLoggingEnabled

public void setLoggingEnabled(java.util.UUID clientId,
                              boolean status)

Sets the logging status for the given connection

Specified by:

setLoggingEnabled in interface EntityConnectionServerAdmin

Parameters:

clientId - the ID of the client

status - the new logging status

getConnectionTimeout

public int getConnectionTimeout()

Returns the connection timeout in ms

Specified by:

getConnectionTimeout in interface EntityConnectionServerAdmin

Returns:

the connection timeout in ms

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Sets the connection timeout in ms

Specified by:

setConnectionTimeout in interface EntityConnectionServerAdmin

Parameters:

timeout - the timeout in ms

getEntityDefinitions

public java.util.Map<java.lang.String,java.lang.String> getEntityDefinitions()

Specified by:

getEntityDefinitions in interface EntityConnectionServerAdmin

Returns:

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