org.eclipse.persistence.services.mbean
Interface MBeanRuntimeServicesMBean

All Known Subinterfaces:

MBeanWebLogicRuntimeServicesMBean

All Known Implementing Classes:

MBeanRuntimeServices, MBeanWebLogicRuntimeServices

public interface MBeanRuntimeServicesMBean

Purpose: Provide a dynamic interface into the EclipseLink Session.

Description: This class is meant to provide an interface for gaining access to configuration of the EclipseLink Session during runtime. It provides the basis for a JMX MBean

Method Summary

void	addNewConnectionPool(java.lang.String poolName, int maxSize, int minSize, java.lang.String platform, java.lang.String driverClassName, java.lang.String url, java.lang.String userName, java.lang.String password) This method provides client with access to add a new connection pool to a TopLink ServerSession.
java.util.List	getAvailableConnectionPools() This method will return the available Connection pools within this Server Session
java.util.List	getClassesInSession() This method is used to return those Class Names that have identity Maps in the Session.
java.lang.Integer	getNumberOfObjectsInIdentityMap(java.lang.String className) This method is used to return the number of objects in a particular Identity Map
java.lang.Integer	getNumberOfObjectsInIdentityMapSubCache(java.lang.String className) This method is used to return the number of objects in a particular Identity Map's subcache.
java.util.List	getObjectsInIdentityMap(java.lang.String className) This method will return a collection of the objects in the Identity Map.
java.util.List	getObjectsInIdentityMapSubCacheAsMap(java.lang.String className) This method will return a collection of the objects in the Identity Map.
int	getProfileWeight() Return the DMS sensor weight
int	getSequencePreallocationSize() Method returns the value of the Sequence Preallocation size
boolean	getShouldCacheAllStatements() Returns if statements should be cached or not
boolean	getShouldLogMessages() This method is used to determine if messages should be logged by the session
boolean	getShouldLogPerformanceProfiler() This method is used to determine if we should be logging when using the Performance Profiler
boolean	getShouldProfilePerformance() This method will return if profiling is turned on or not
java.util.List	getSizeForPool(java.lang.String poolName) This method will retrieve the size of a particular connection pool
int	getStatementCacheSize() Returns the statement cache size.
void	resetAllConnections() This method is used to reset connections from the session to the database.
void	setProfileWeight(int size) Set the DMS sensor weight
void	setSequencePreallocationSize(int size) This method provides access for setting the sequence pre-allocation size
void	setShouldCacheAllStatements(boolean shouldCacheAllStatements) Method used to set if statements should be cached.
void	setShouldLogPerformanceProfiler(boolean shouldLogPerformanceProfiler) This method is used to turn on Profile logging when using the Performance Profiler
void	setShouldProfilePerformance(boolean shouldProfile) This method is used to turn on Performance Profiling
void	setStatementCacheSize(int size) Used to set the statement cache size.
void	updatePoolSize(java.lang.String poolName, int maxSize, int minSize) This method allows the client to set the pool size for a particular pool, based on the pool name

Method Detail

getShouldLogMessages

boolean getShouldLogMessages()

This method is used to determine if messages should be logged by the session

setShouldProfilePerformance

void setShouldProfilePerformance(boolean shouldProfile)

This method is used to turn on Performance Profiling

getShouldProfilePerformance

boolean getShouldProfilePerformance()

This method will return if profiling is turned on or not

setShouldLogPerformanceProfiler

void setShouldLogPerformanceProfiler(boolean shouldLogPerformanceProfiler)

This method is used to turn on Profile logging when using the Performance Profiler

getShouldLogPerformanceProfiler

boolean getShouldLogPerformanceProfiler()

This method is used to determine if we should be logging when using the Performance Profiler

Returns:

setShouldCacheAllStatements

void setShouldCacheAllStatements(boolean shouldCacheAllStatements)

Method used to set if statements should be cached. Please note that Statements can not be cached when using an external connection pool

getShouldCacheAllStatements

boolean getShouldCacheAllStatements()

Returns if statements should be cached or not

setStatementCacheSize

void setStatementCacheSize(int size)

Used to set the statement cache size. This is only valid if using cached Statements

getStatementCacheSize

int getStatementCacheSize()

Returns the statement cache size. Only valid if statements are being cached

setSequencePreallocationSize

void setSequencePreallocationSize(int size)

This method provides access for setting the sequence pre-allocation size

getSequencePreallocationSize

int getSequencePreallocationSize()

Method returns the value of the Sequence Preallocation size

updatePoolSize

void updatePoolSize(java.lang.String poolName,
                    int maxSize,
                    int minSize)

This method allows the client to set the pool size for a particular pool, based on the pool name

getAvailableConnectionPools

java.util.List getAvailableConnectionPools()

This method will return the available Connection pools within this Server Session

getSizeForPool

java.util.List getSizeForPool(java.lang.String poolName)

This method will retrieve the size of a particular connection pool

addNewConnectionPool

void addNewConnectionPool(java.lang.String poolName,
                          int maxSize,
                          int minSize,
                          java.lang.String platform,
                          java.lang.String driverClassName,
                          java.lang.String url,
                          java.lang.String userName,
                          java.lang.String password)
                          throws java.lang.ClassNotFoundException

This method provides client with access to add a new connection pool to a TopLink ServerSession. This method throws classNotFound Exception if any of the class names are misspelled.

Throws:

java.lang.ClassNotFoundException

resetAllConnections

void resetAllConnections()

This method is used to reset connections from the session to the database. Please Note that this will not work with a SessionBroker at this time

getClassesInSession

java.util.List getClassesInSession()

This method is used to return those Class Names that have identity Maps in the Session. Please note that SubClasses and aggregates will be missing form this list as they do not have separate identity maps.

getObjectsInIdentityMap

java.util.List getObjectsInIdentityMap(java.lang.String className)
                                       throws java.lang.ClassNotFoundException

This method will return a collection of the objects in the Identity Map. There is no particular order to these objects.

Throws:

java.lang.ClassNotFoundException

getNumberOfObjectsInIdentityMap

java.lang.Integer getNumberOfObjectsInIdentityMap(java.lang.String className)
                                                  throws java.lang.ClassNotFoundException

This method is used to return the number of objects in a particular Identity Map

Parameters:

className - the fully qualified name of the class to get number of instances of.

Throws:

If - ClassNotFoundException is thrown then the IdentityMap for that class name could not be found

java.lang.ClassNotFoundException

getObjectsInIdentityMapSubCacheAsMap

java.util.List getObjectsInIdentityMapSubCacheAsMap(java.lang.String className)
                                                    throws java.lang.ClassNotFoundException

This method will return a collection of the objects in the Identity Map. There is no particular order to these objects. These objects are returned as a Map which is how they are stored on the cache. This method replaces getObjectsInIdentityMapSubCache(String className) which returned a List.

Throws:

java.lang.ClassNotFoundException

getNumberOfObjectsInIdentityMapSubCache

java.lang.Integer getNumberOfObjectsInIdentityMapSubCache(java.lang.String className)
                                                          throws java.lang.ClassNotFoundException

This method is used to return the number of objects in a particular Identity Map's subcache. Only works for those identity Maps with a sub cache (IE Hard Cache Weak Identity Map) If ClassNotFoundException is thrown then the IdenityMap for that class name could not be found

Throws:

java.lang.ClassNotFoundException

getProfileWeight

int getProfileWeight()

Return the DMS sensor weight

Returns:

setProfileWeight

void setProfileWeight(int size)

Set the DMS sensor weight