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
Modifier and Type | Method and Description |
---|---|
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.
|
void |
clearStatementCache()
Used to clear the statement cache.
|
java.lang.String |
getApplicationName()
getApplicationName(): Answer the name of the module (EAR name) that this session is associated with.
|
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.Object[][] |
getClassSummaryDetails()
Provide an instance of 2 Dimensional Array simulating tabular format information about all
classes in the session.
|
java.util.List<ClassSummaryDetailBase> |
getClassSummaryDetailsArray()
Provide a list of instance of ClassSummaryDetail containing information about all
classes in the session.
|
java.lang.Object[][] |
getClassSummaryDetailsUsingFilter(java.lang.String filter)
Provide an instance of 2 Dimensional Array simulating tabular format information about all
classes in the session whose class names match the provided filter.
|
java.util.List<ClassSummaryDetailBase> |
getClassSummaryDetailsUsingFilterArray(java.lang.String filter)
Provide a list of instance of ClassSummaryDetail containing information about the
classes in the session whose class names match the provided filter.
|
java.lang.String |
getConnectionPoolType()
Return connection pool type.
|
java.lang.String |
getCurrentEclipseLinkLogLevel()
Answer the EclipseLink log level that is changeable.
|
java.lang.String |
getDatabasePlatform()
Return the database platform used by the DatabaseSession.
|
java.lang.String |
getDeployedEclipseLinkLogLevel()
Answer the EclipseLink log level at deployment time.
|
java.lang.String |
getDriver()
Return db driver class name.
|
java.lang.String |
getJdbcConnectionDetails()
Return JDBCConnection detail information.
|
java.lang.String |
getLogFilename()
Return the log filename.
|
java.lang.String |
getLogType()
Return the log type, either "EclipseLink", "Java" or the simple name of the logging class used.
|
java.util.Vector |
getMappedClassNamesUsingFilter(java.lang.String filter)
INTERNAL:
This method traverses the EclipseLink descriptors and returns a Vector of the descriptor's
reference class names that match the provided filter.
|
java.lang.Integer |
getMaxSizeForPool(java.lang.String poolName)
This method will retrieve the max size of a particular connection pool
|
java.lang.Integer |
getMinSizeForPool(java.lang.String poolName)
This method will retrieve the min size of a particular connection pool
|
java.lang.String |
getModuleName()
getModuleName(): Answer the name of the context-root of the application that this session is associated with.
|
java.lang.Integer |
getNumberOfObjectsInAllIdentityMaps()
This method will SUM and return the number of objects in all 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.lang.Integer |
getNumberOfPersistentClasses()
This method will answer the number of persistent classes contained in the session.
|
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
|
java.lang.String |
getProfilingType()
This method is used to get the type of profiling.
|
int |
getSequencePreallocationSize()
Method returns the value of the Sequence Preallocation size
|
java.lang.String |
getSessionName()
Answer the name of the EclipseLink session this MBean represents.
|
java.lang.String |
getSessionType()
Answer the type of the EclipseLink session this MBean represents.
|
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.
|
java.lang.Integer |
getStringBindingSize()
Return the size of strings after which will be bound into the statement
If we are not using a DatabaseLogin, or we're not using string binding,
answer 0 (zero).
|
java.lang.Long |
getTimeConnectionEstablished()
This method will return a long indicating the exact time in Milliseconds that the
session connected to the database.
|
java.lang.Boolean |
getUsesByteArrayBinding()
Shows if Byte Array Binding is turned on or not
|
java.lang.Boolean |
getUsesEclipseLinkProfiling()
This method answers true if EclipseLink Performance Profiling is on.
|
java.lang.Boolean |
getUsesJDBCBatchWriting()
This method will return if batchWriting is in use or not.
|
java.lang.Boolean |
getUsesNativeSQL()
Shows if native SQL is being used
|
java.lang.Boolean |
getUsesStreamsForBinding()
This method indicates if streams are being used for binding
|
java.lang.Boolean |
getUsesStringBinding()
This method indicates if Strings are being bound
|
void |
initializeIdentityMaps(java.lang.String[] classNames)
This method is used to initialize the identity maps specified by the Vector of classNames.
|
void |
invalidateAllIdentityMaps()
This method is used to invalidate the identity maps in the session.
|
void |
invalidateIdentityMap(java.lang.String className)
This method is used to invalidate the identity maps specified by className.
|
void |
invalidateIdentityMap(java.lang.String className,
java.lang.Boolean recurse)
This method is used to invalidate the identity maps specified by className.
|
void |
invalidateIdentityMaps(java.lang.String[] classNamesParam,
java.lang.Boolean recurse)
This method is used to invalidate the identity maps specified by the String[] of classNames.
|
boolean |
isJPASession()
Return whether this session is an EclipseLink JPA session.
|
void |
printAllIdentityMapTypes()
This method will log the types of Identity Maps in the session.
|
void |
printAvailableConnectionPools()
This method will print the available Connection pools to the SessionLog.
|
void |
printClassesInSession()
This method is used to output those Class Names that have identity Maps in the Session.
|
void |
printIdentityMapLocks()
This method will log the instance level locks in all Identity Maps in the session.
|
void |
printIdentityMapLocks(java.lang.String registeredClassName)
This method will log the instance level locks in the Identity Map for the given class in the session.
|
void |
printObjectsInIdentityMap(java.lang.String className)
This method will log the objects in the Identity Map.
|
void |
printObjectsInIdentityMaps()
This method will log all objects in all Identity Maps in the session.
|
void |
printProfileSummary()
This method assumes EclipseLink Profiling (as opposed to Java profiling).
|
void |
printProfileSummaryByClass()
This method assumes EclipseLink Profiling (as opposed to Java profiling).
|
void |
printProfileSummaryByQuery()
This method assumes EclipseLink Profiling (as opposed to Java profiling).
|
void |
resetAllConnections()
This method is used to reset connections from the session to the database.
|
void |
setCurrentEclipseLinkLogLevel(java.lang.String newLevel)
Set the EclipseLink log level to be used at runtime.
|
void |
setProfileWeight(int size)
Set the DMS sensor weight
|
void |
setProfilingType(java.lang.String profileType)
This method is used to select the type of profiling.
|
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 |
setUseEclipseLinkProfiling()
This method is used to turn on EclipseLink Performance Profiling
|
void |
setUseNoProfiling()
This method is used to turn off all Performance Profiling, DMS or EclipseLink.
|
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
|
boolean getShouldLogMessages()
void setShouldProfilePerformance(boolean shouldProfile)
boolean getShouldProfilePerformance()
void setShouldLogPerformanceProfiler(boolean shouldLogPerformanceProfiler)
boolean getShouldLogPerformanceProfiler()
void setShouldCacheAllStatements(boolean shouldCacheAllStatements)
boolean getShouldCacheAllStatements()
void setStatementCacheSize(int size)
int getStatementCacheSize()
void setSequencePreallocationSize(int size)
int getSequencePreallocationSize()
void updatePoolSize(java.lang.String poolName, int maxSize, int minSize)
java.util.List getAvailableConnectionPools()
java.util.List getSizeForPool(java.lang.String poolName)
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
java.lang.ClassNotFoundException
void resetAllConnections()
java.util.List getClassesInSession()
java.util.List getObjectsInIdentityMap(java.lang.String className) throws java.lang.ClassNotFoundException
java.lang.ClassNotFoundException
java.lang.Integer getNumberOfObjectsInIdentityMap(java.lang.String className) throws java.lang.ClassNotFoundException
className
- the fully qualified name of the class to get number of instances of.If
- ClassNotFoundException is thrown then the IdentityMap for that class name could not be foundjava.lang.ClassNotFoundException
java.util.List getObjectsInIdentityMapSubCacheAsMap(java.lang.String className) throws java.lang.ClassNotFoundException
java.lang.ClassNotFoundException
java.lang.Integer getNumberOfObjectsInIdentityMapSubCache(java.lang.String className) throws java.lang.ClassNotFoundException
java.lang.ClassNotFoundException
int getProfileWeight()
void setProfileWeight(int size)
java.lang.String getDeployedEclipseLinkLogLevel()
java.lang.String getCurrentEclipseLinkLogLevel()
void setCurrentEclipseLinkLogLevel(java.lang.String newLevel)
String
- newLevel: new log leveljava.lang.String getSessionName()
boolean isJPASession()
java.lang.String getSessionType()
java.lang.Object[][] getClassSummaryDetailsUsingFilter(java.lang.String filter)
java.lang.Object[][] getClassSummaryDetails()
java.util.List<ClassSummaryDetailBase> getClassSummaryDetailsUsingFilterArray(java.lang.String filter)
filter
- A comma separated list of strings to match against.java.util.List<ClassSummaryDetailBase> getClassSummaryDetailsArray()
java.util.Vector getMappedClassNamesUsingFilter(java.lang.String filter)
filter
- A comma separated list of strings to match against.java.lang.String getModuleName()
java.lang.String getApplicationName()
java.lang.String getProfilingType()
void setProfilingType(java.lang.String profileType)
void setUseEclipseLinkProfiling()
java.lang.Boolean getUsesEclipseLinkProfiling()
void setUseNoProfiling()
java.lang.Integer getStringBindingSize()
java.lang.Long getTimeConnectionEstablished()
java.lang.Boolean getUsesJDBCBatchWriting()
java.lang.Boolean getUsesByteArrayBinding()
java.lang.Boolean getUsesNativeSQL()
java.lang.Boolean getUsesStreamsForBinding()
java.lang.Boolean getUsesStringBinding()
void clearStatementCache()
void printAvailableConnectionPools()
java.lang.Integer getMaxSizeForPool(java.lang.String poolName)
poolName
- the name of the pool to get the max size forjava.lang.Integer getMinSizeForPool(java.lang.String poolName)
poolName
- the name of the pool to get the min size forvoid printClassesInSession()
void printObjectsInIdentityMap(java.lang.String className) throws java.lang.ClassNotFoundException
className
- the fully qualified classname identifying the identity mapthrown
- then the IdentityMap for that class name could not be foundjava.lang.ClassNotFoundException
void printAllIdentityMapTypes()
void printObjectsInIdentityMaps()
java.lang.Integer getNumberOfObjectsInAllIdentityMaps()
java.lang.Integer getNumberOfPersistentClasses()
void printIdentityMapLocks()
void printIdentityMapLocks(java.lang.String registeredClassName)
void printProfileSummary()
void printProfileSummaryByClass()
void printProfileSummaryByQuery()
java.lang.String getLogType()
java.lang.String getDatabasePlatform()
java.lang.String getJdbcConnectionDetails()
java.lang.String getConnectionPoolType()
java.lang.String getDriver()
java.lang.String getLogFilename()
void initializeIdentityMaps(java.lang.String[] classNames) throws java.lang.ClassNotFoundException
classNames
- String[] of fully qualified classnames identifying the identity maps to initializejava.lang.ClassNotFoundException
void invalidateAllIdentityMaps()
void invalidateIdentityMaps(java.lang.String[] classNamesParam, java.lang.Boolean recurse) throws java.lang.ClassNotFoundException
classNames
- String[] of fully qualified classnames identifying the identity maps to invalidaterecurse
- Boolean indicating if we want to invalidate the children identity maps toojava.lang.ClassNotFoundException
void invalidateIdentityMap(java.lang.String className) throws java.lang.ClassNotFoundException
className
- the fully qualified classname identifying the identity map to invalidatejava.lang.ClassNotFoundException
void invalidateIdentityMap(java.lang.String className, java.lang.Boolean recurse) throws java.lang.ClassNotFoundException
className
- the fully qualified classname identifying the identity map to invalidaterecurse
- Boolean indicating if we want to invalidate the children identity maps toojava.lang.ClassNotFoundException