Package org.eclipse.persistence.services.mbean

Interface MBeanRuntimeServicesMBean

    • 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​(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

        List getAvailableConnectionPools()
        This method will return the available Connection pools within this Server Session

      • getSizeForPool

        List getSizeForPool​(String poolName)
        This method will retrieve the size of a particular connection pool

      • addNewConnectionPool

        void addNewConnectionPool​(String poolName,
                          int maxSize,
                          int minSize,
                          String platform,
                          String driverClassName,
                          String url,
                          String userName,
                          String password)
                   throws 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:
        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

        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 from this list as they do not have separate identity maps.

      • getNumberOfObjectsInIdentityMap

        Integer getNumberOfObjectsInIdentityMap​(String className)
                                 throws 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:
        ClassNotFoundException - if thrown then the IdentityMap for that class name could not be found

      • getObjectsInIdentityMapSubCacheAsMap

        List getObjectsInIdentityMapSubCacheAsMap​(String className)
                                   throws 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:
        ClassNotFoundException

      • getNumberOfObjectsInIdentityMapSubCache

        Integer getNumberOfObjectsInIdentityMapSubCache​(String className)
                                         throws 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:
        ClassNotFoundException

      • getProfileWeight

        int getProfileWeight()
        Return the DMS sensor weight
        Returns:

      • setProfileWeight

        void setProfileWeight​(int size)
        Set the DMS sensor weight

      • getDeployedEclipseLinkLogLevel

        String getDeployedEclipseLinkLogLevel()
        Answer the EclipseLink log level at deployment time. This is read-only.

      • getCurrentEclipseLinkLogLevel

        String getCurrentEclipseLinkLogLevel()
        Answer the EclipseLink log level that is changeable. This does not affect the log level in the project (i.e. The next time the application is deployed, changes are forgotten)

      • setCurrentEclipseLinkLogLevel

        void setCurrentEclipseLinkLogLevel​(String newLevel)
        Set the EclipseLink log level to be used at runtime. This does not affect the log level in the project (i.e. The next time the application is deployed, changes are forgotten)
        Parameters:
        newLevel - new log level

      • getSessionName

        String getSessionName()
        Answer the name of the EclipseLink session this MBean represents.

      • isJPASession

        boolean isJPASession()
        Return whether this session is an EclipseLink JPA session. The absence of this function or a value of false will signify that the session belongs to a provider other than EclipseLink.
        Returns:

      • getSessionType

        String getSessionType()
        Answer the type of the EclipseLink session this MBean represents. Types include: "ServerSession", "DatabaseSession", "SessionBroker"

      • getClassSummaryDetailsUsingFilter

        Object[][] getClassSummaryDetailsUsingFilter​(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. The 2 Dimensional array contains each item with values being row object array. Each row object array represents EclipseLink class details info with respect to below attributes: ["Class Name", "Parent Class Name", "Cache Type", "Configured Size", "Current Size"]

      • getClassSummaryDetails

        Object[][] getClassSummaryDetails()
        Provide an instance of 2 Dimensional Array simulating tabular format information about all classes in the session. The 2 Dimensional array contains each item with values being row object array. Each row object array represents EclipseLink class details info with respect to below attributes: ["Class Name", "Parent Class Name", "Cache Type", "Configured Size", "Current Size"]

      • getClassSummaryDetailsUsingFilterArray

        List<ClassSummaryDetailBase> getClassSummaryDetailsUsingFilterArray​(String filter)
        Provide a list of instance of ClassSummaryDetail containing information about the classes in the session whose class names match the provided filter. ClassSummaryDetail is a model specific class that can be used internally by the Portable JMX Framework to convert class attribute to JMX required open type, it has:- 1. model specific type that needs to be converted : ["Class Name", "Parent Class Name", "Cache Type", "Configured Size", "Current Size"] 2. convert methods.
        Parameters:
        filter - A comma separated list of strings to match against.
        Returns:
        A ArrayList of instance of ClassSummaryDetail containing class information for the class names that match the filter.

      • getClassSummaryDetailsArray

        List<ClassSummaryDetailBase> getClassSummaryDetailsArray()
        Provide a list of instance of ClassSummaryDetail containing information about all classes in the session. ClassSummaryDetail is a model specific class that can be used internally by the Portable JMX Framework to convert class attribute to JMX required open type, it has:- 1. model specific type that needs to be converted : ["Class Name", "Parent Class Name", "Cache Type", "Configured Size", "Current Size"] 2. convert methods.
        Returns:
        A ArrayList of instance of ClassSummaryDetail containing class information for the class names that match the filter.

      • getMappedClassNamesUsingFilter

        Vector getMappedClassNamesUsingFilter​(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. The filter is a comma separated list of strings to match against.
        Parameters:
        filter - A comma separated list of strings to match against.
        Returns:
        A Vector of class names that match the filter.

      • getModuleName

        String getModuleName()
        getModuleName(): Answer the name of the context-root of the application that this session is associated with. Answer "unknown" if there is no module name available. Default behavior is to return "unknown" - we override this behavior here for WebLogic.

      • getApplicationName

        String getApplicationName()
        getApplicationName(): Answer the name of the module (EAR name) that this session is associated with. Answer "unknown" if there is no application name available. Default behavior is to return "unknown" - we override this behavior here for WebLogic.

      • getProfilingType

        String getProfilingType()
        This method is used to get the type of profiling. Possible values are: "EclipseLink" or "None".

      • setProfilingType

        void setProfilingType​(String profileType)
        This method is used to select the type of profiling. Valid values are: "EclipseLink" or "None". These values are not case sensitive. null is considered to be "None".

      • setUseEclipseLinkProfiling

        void setUseEclipseLinkProfiling()
        This method is used to turn on EclipseLink Performance Profiling

      • getUsesEclipseLinkProfiling

        Boolean getUsesEclipseLinkProfiling()
        This method answers true if EclipseLink Performance Profiling is on.

      • setUseNoProfiling

        void setUseNoProfiling()
        This method is used to turn off all Performance Profiling, DMS or EclipseLink.

      • getStringBindingSize

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

      • getTimeConnectionEstablished

        Long getTimeConnectionEstablished()
        This method will return a long indicating the exact time in Milliseconds that the session connected to the database.

      • getUsesJDBCBatchWriting

        Boolean getUsesJDBCBatchWriting()
        This method will return if batchWriting is in use or not.

      • getUsesByteArrayBinding

        Boolean getUsesByteArrayBinding()
        Shows if Byte Array Binding is turned on or not

      • getUsesNativeSQL

        Boolean getUsesNativeSQL()
        Shows if native SQL is being used

      • getUsesStreamsForBinding

        Boolean getUsesStreamsForBinding()
        This method indicates if streams are being used for binding

      • getUsesStringBinding

        Boolean getUsesStringBinding()
        This method indicates if Strings are being bound

      • clearStatementCache

        void clearStatementCache()
        Used to clear the statement cache. Only valid if statements are being cached

      • printAvailableConnectionPools

        void printAvailableConnectionPools()
        This method will print the available Connection pools to the SessionLog.

      • getMaxSizeForPool

        Integer getMaxSizeForPool​(String poolName)
        This method will retrieve the max size of a particular connection pool
        Parameters:
        poolName - the name of the pool to get the max size for
        Returns:
        Integer for the max size of the pool. Return -1 if pool doesn't exist.

      • getMinSizeForPool

        Integer getMinSizeForPool​(String poolName)
        This method will retrieve the min size of a particular connection pool
        Parameters:
        poolName - the name of the pool to get the min size for
        Returns:
        Integer for the min size of the pool. Return -1 if pool doesn't exist.

      • printClassesInSession

        void printClassesInSession()
        This method is used to output 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.

      • printObjectsInIdentityMap

        void printObjectsInIdentityMap​(String className)
                        throws ClassNotFoundException
        This method will log the objects in the Identity Map. There is no particular order to these objects.
        Parameters:
        className - the fully qualified classname identifying the identity map
        Throws:
        ClassNotFoundException - if thrown then the IdentityMap for that class name could not be found

      • printAllIdentityMapTypes

        void printAllIdentityMapTypes()
        This method will log the types of Identity Maps in the session.

      • printObjectsInIdentityMaps

        void printObjectsInIdentityMaps()
        This method will log all objects in all Identity Maps in the session.

      • getNumberOfObjectsInAllIdentityMaps

        Integer getNumberOfObjectsInAllIdentityMaps()
        This method will SUM and return the number of objects in all Identity Maps in the session.

      • getNumberOfPersistentClasses

        Integer getNumberOfPersistentClasses()
        This method will answer the number of persistent classes contained in the session. This does not include aggregates.

      • printIdentityMapLocks

        void printIdentityMapLocks()
        This method will log the instance level locks in all Identity Maps in the session.

      • printIdentityMapLocks

        void printIdentityMapLocks​(String registeredClassName)
        This method will log the instance level locks in the Identity Map for the given class in the session.

      • printProfileSummary

        void printProfileSummary()
        This method assumes EclipseLink Profiling (as opposed to Java profiling). This will log at the INFO level a summary of all elements in the profile.

      • printProfileSummaryByClass

        void printProfileSummaryByClass()
        This method assumes EclipseLink Profiling (as opposed to Java profiling). This will log at the INFO level a summary of all elements in the profile, categorized by Class.

      • printProfileSummaryByQuery

        void printProfileSummaryByQuery()
        This method assumes EclipseLink Profiling (as opposed to Java profiling). This will log at the INFO level a summary of all elements in the profile, categorized by Query.

      • getLogType

        String getLogType()
        Return the log type, either "EclipseLink", "Java" or the simple name of the logging class used.
        Returns:
        the log type

      • getDatabasePlatform

        String getDatabasePlatform()
        Return the database platform used by the DatabaseSession.
        Returns:
        String databasePlatform

      • getJdbcConnectionDetails

        String getJdbcConnectionDetails()
        Return JDBCConnection detail information. This includes URL and datasource information.

      • getConnectionPoolType

        String getConnectionPoolType()
        Return connection pool type. Values include: "Internal", "External" and "N/A".

      • getDriver

        String getDriver()
        Return db driver class name. This only applies to DefaultConnector. Return "N/A" otherwise.

      • getLogFilename

        String getLogFilename()
        Return the log filename. This returns the fully qualified path of the log file when EclipseLink logging is enabled. Null is returned otherwise.
        Returns:
        String logFilename

      • initializeIdentityMaps

        void initializeIdentityMaps​(String[] classNames)
                     throws ClassNotFoundException
        This method is used to initialize the identity maps specified by the Vector of classNames.
        Parameters:
        classNames - String[] of fully qualified classnames identifying the identity maps to initialize
        Throws:
        ClassNotFoundException

      • invalidateAllIdentityMaps

        void invalidateAllIdentityMaps()
        This method is used to invalidate the identity maps in the session.

      • invalidateIdentityMaps

        void invalidateIdentityMaps​(String[] classNamesParam,
                            Boolean recurse)
                     throws ClassNotFoundException
        This method is used to invalidate the identity maps specified by the String[] of classNames.
        Parameters:
        classNamesParam - String[] of fully qualified classnames identifying the identity maps to invalidate
        recurse - Boolean indicating if we want to invalidate the children identity maps too
        Throws:
        ClassNotFoundException

      • invalidateIdentityMap

        void invalidateIdentityMap​(String className)
                    throws ClassNotFoundException
        This method is used to invalidate the identity maps specified by className. This does not invalidate the children identity maps
        Parameters:
        className - the fully qualified classname identifying the identity map to invalidate
        Throws:
        ClassNotFoundException

      • invalidateIdentityMap

        void invalidateIdentityMap​(String className,
                           Boolean recurse)
                    throws ClassNotFoundException
        This method is used to invalidate the identity maps specified by className.
        Parameters:
        className - the fully qualified classname identifying the identity map to invalidate
        recurse - Boolean indicating if we want to invalidate the children identity maps too
        Throws:
        ClassNotFoundException