oracle.toplink.services.oc4j
Class Oc4jRuntimeServices

java.lang.Object
  oracle.oc4j.admin.management.mbeans.J2EEManagedObjectBase
      oracle.toplink.services.oc4j.Oc4jRuntimeServices

Deprecated. since 11.1.1

public class Oc4jRuntimeServices
extends oracle.oc4j.admin.management.mbeans.J2EEManagedObjectBase

Purpose: Provide a dynamic interface into the TopLink Session.

Description: This class is meant to provide facilities for managing a TopLink session external to TopLink over JMX.

Field Summary

java.lang.String

objectName Deprecated.

Constructor Summary

Oc4jRuntimeServices()
Deprecated. Default Constructor

Oc4jRuntimeServices(oracle.toplink.internal.sessions.AbstractSession session, java.lang.String myBaseObjectName)
Deprecated. Create an instance of Oc4jRuntimeServices to be associated with the provided session

Oc4jRuntimeServices(java.util.Locale locale)
Deprecated. Create an instance of Oc4jRuntimeServices to be associated with the provided locale The user must call setSession(Session) afterwards to define the session.

Method Summary

void	clearStatementCache() Deprecated. Used to clear the statement cache.
java.lang.Boolean	getcacheSynchAsynchronous() Deprecated. This method is used to answer whether cache synchronization is asynchronous or not.
java.lang.Boolean	getcacheSynchEnabled() Deprecated. This method is used to answer whether cache synchronization is enabled or not.
java.lang.Object[][]	getClassSummaryDetails() Deprecated. Provide an instance of 2 Dimensional Array simulating tabular format information about all classes in the session.
java.lang.Object[][]	getClassSummaryDetailsUsingFilter(java.lang.String filter) Deprecated. 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.lang.String	getconnectionPoolType() Deprecated. Return connection pool type.
java.lang.String	getcurrentProfileWeight() Deprecated. Answer the current sensor weight (NORMAL, HEAVY, ALL, NONE) as a String.
java.lang.String	getcurrentTopLinkLogLevel() Deprecated. Answer the TopLink log level that is changeable.
java.lang.String	getcurrentTopLinkLogLevel(java.lang.String category) Deprecated. Answer the TopLink log level that is changeable, given the passed category.
java.lang.String	getdatabasePlatform() Deprecated. Return the database platform used by the DatabaseSession.
java.lang.String	getdeployedProfileWeight() Deprecated. Answer the deployed sensor weight (NORMAL, HEAVY, ALL) as an String.
java.lang.String	getdeployedTopLinkLogLevel() Deprecated. Answer the TopLink log level at deployment time.
java.lang.String	getDeployedTopLinkLogLevel(java.lang.String category) Deprecated. Answer the TopLink log level at deployment time for the given category.
java.lang.String	getdriver() Deprecated. Return db driver class name.
java.lang.String	getjdbcConnectionDetails() Deprecated. Return JDBCConnection detail information.
java.lang.String	getlogFilename() Deprecated. Return the log filename.
java.lang.String	getlogType() Deprecated. Return the log type, either "TopLink", "Java" or "Server"
java.lang.Integer	getMaxSizeForPool(java.lang.String poolName) Deprecated. This method will retrieve the max size of a particular connection pool
java.lang.Integer	getMinSizeForPool(java.lang.String poolName) Deprecated. This method will retrieve the min size of a particular connection pool
java.lang.String	getmoduleName() Deprecated. getModuleName: Answer the EJB-Module I belong to.
java.lang.Integer	getnumberOfObjectsInAllIdentityMaps() Deprecated. 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) Deprecated. This method is used to return the number of objects in a particular Identity Map
java.lang.Integer	getnumberOfPersistentClasses() Deprecated. This method will answer the number of persistent classes contained in the session.
java.lang.String	getprofilingType() Deprecated. This method is used to get the type of profiling.
java.lang.Integer	getsequencePreallocationSize() Deprecated. Method returns the value of the Sequence Preallocation size
java.lang.String	getsessionName() Deprecated. Answer the name of the TopLink session this MBean represents.
java.lang.String	getsessionType() Deprecated. Answer the type of the TopLink session this MBean represents.
java.lang.Boolean	getshouldBindAllParameters() Deprecated. Method returns if all Parameters should be bound or not
java.lang.Boolean	getshouldCacheAllStatements() Deprecated. Returns if statements should be cached or not
java.lang.Boolean	getshouldLogPerformanceProfiler() Deprecated. Method indicates if Performace profile should be loged
java.lang.Integer	getstatementCacheSize() Deprecated. Returns the statement cache size.
java.lang.Integer	getstringBindingSize() Deprecated. 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() Deprecated. This method will return a long indicating the exact time in Milliseconds that the session connected to the database.
java.lang.Boolean	getusesBatchWriting() Deprecated. This method will return if batchWriting is in use or not.
java.lang.Boolean	getusesByteArrayBinding() Deprecated. Shows if Byte Array Binding is turned on or not
java.lang.Boolean	getusesDMSProfiling() Deprecated. This method answers true if DMS Performance Profiling is on.
java.lang.Boolean	getusesJDBCBatchWriting() Deprecated. This method will return if batchWriting is in use or not.
java.lang.Boolean	getusesNativeSQL() Deprecated. Shows if native SQL is being used
java.lang.Boolean	getusesStreamsForBinding() Deprecated. This method indicates if streams are being used for binding
java.lang.Boolean	getusesStringBinding() Deprecated. This method indicates if Strings are being bound
java.lang.Boolean	getusesTopLinkProfiling() Deprecated. This method answers true if TopLink Performance Profiling is on.
void	initializeAllIdentityMaps() Deprecated. This method is used to initialize the identity maps in the session.
void	initializeIdentityMap(java.lang.String className) Deprecated. This method is used to initialize the identity maps specified by className.
void	initializeIdentityMaps(java.lang.String[] classNames) Deprecated. This method is used to initialize the identity maps specified by the Vector of classNames.
void	invalidateAllIdentityMaps() Deprecated. This method is used to invalidate the identity maps in the session.
void	invalidateIdentityMap(java.lang.String className) Deprecated. This method is used to invalidate the identity maps specified by className.
void	invalidateIdentityMap(java.lang.String className, java.lang.Boolean recurse) Deprecated. This method is used to invalidate the identity maps specified by className.
void	invalidateIdentityMaps(java.lang.String[] classNamesParam, java.lang.Boolean recurse) Deprecated. This method is used to invalidate the identity maps specified by the String[] of classNames.
void	printAllIdentityMapTypes() Deprecated. This method will log the types of Identity Maps in the session.
void	printAvailableConnectionPools() Deprecated. This method will print the available Connection pools to the SessionLog.
void	printClassesInSession() Deprecated. This method is used to output those Class Names that have identity Maps in the Session.
void	printIdentityMapLocks() Deprecated. This method will log the instance level locks in all Identity Maps in the session.
void	printIdentityMapLocks(java.lang.String registeredClassName) Deprecated. 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) Deprecated. This method will log the objects in the Identity Map.
void	printObjectsInIdentityMaps() Deprecated. This method will log all objects in all Identity Maps in the session.
void	printProfileSummary() Deprecated. This method assumes TopLink Profiling (as opposed to Java profiling).
void	printProfileSummaryByClass() Deprecated. This method assumes TopLink Profiling (as opposed to Java profiling).
void	printProfileSummaryByQuery() Deprecated. This method assumes TopLink Profiling (as opposed to Java profiling).
void	resetAllConnections() Deprecated. This method is used to reset connections from the session to the database.
void	setcurrentProfileWeight(java.lang.String weight) Deprecated. This method is used to change the sensor weight (NORMAL, HEAVY, ALL, NONE) as an String.
void	setcurrentTopLinkLogLevel(java.lang.String newLevel) Deprecated. Set the TopLink log level to be used at runtime.
void	setprofilingType(java.lang.String profileType) Deprecated. This method is used to select the type of profiling.
void	setshouldLogPerformanceProfiler(java.lang.Boolean shouldLogPerformanceProfiler) Deprecated. This method is used to turn on Profile logging when using th Performance Profiler
void	setuseDMSProfiling() Deprecated. This method is used to turn on DMS Performance Profiling
void	setuseNoProfiling() Deprecated. This method is used to turn off all Performance Profiling, DMS or TopLink.
void	setuseTopLinkProfiling() Deprecated. This method is used to turn on TopLink Performance Profiling

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objectName

public java.lang.String objectName

Deprecated.

Constructor Detail

Oc4jRuntimeServices

public Oc4jRuntimeServices()

Deprecated.

Default Constructor

Oc4jRuntimeServices

public Oc4jRuntimeServices(oracle.toplink.internal.sessions.AbstractSession session,
                           java.lang.String myBaseObjectName)

Deprecated.

Create an instance of Oc4jRuntimeServices to be associated with the provided session

Parameters:

session - The session to be used with these RuntimeServices

String - myBaseObjectName: "oc4j:....." (The JMX object name before it's wrapped in a ObjectName)

Oc4jRuntimeServices

public Oc4jRuntimeServices(java.util.Locale locale)

Deprecated.

Create an instance of Oc4jRuntimeServices to be associated with the provided locale The user must call setSession(Session) afterwards to define the session.

Method Detail

getsessionName

public java.lang.String getsessionName()

Deprecated.

Answer the name of the TopLink session this MBean represents.

getsessionType

public java.lang.String getsessionType()

Deprecated.

Answer the type of the TopLink session this MBean represents. Types include: "ServerSession", "DatabaseSession", "SessionBroker"

getClassSummaryDetailsUsingFilter

public java.lang.Object[][] getClassSummaryDetailsUsingFilter(java.lang.String filter)

Deprecated.

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 toplink class details info with respect to below attributes: ["Class Name", "Parent Class Name", "Cache Type", "Configured Size", "Current Size"]

getClassSummaryDetails

public java.lang.Object[][] getClassSummaryDetails()

Deprecated.

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 toplink class details info with respect to below attributes: ["Class Name", "Parent Class Name", "Cache Type", "Configured Size", "Current Size"]

getmoduleName

public java.lang.String getmoduleName()

Deprecated.

getModuleName: Answer the EJB-Module I belong to. This is the name of the jar the session is contained in.

getdeployedTopLinkLogLevel

public java.lang.String getdeployedTopLinkLogLevel()

Deprecated.

Answer the TopLink log level at deployment time. This is read-only.

getDeployedTopLinkLogLevel

public java.lang.String getDeployedTopLinkLogLevel(java.lang.String category)

Deprecated.

Answer the TopLink log level at deployment time for the given category. This is read-only.

Parameters:

String - category: category of log level desired

getcurrentTopLinkLogLevel

public java.lang.String getcurrentTopLinkLogLevel()

Deprecated.

Answer the TopLink 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)

getcurrentTopLinkLogLevel

public java.lang.String getcurrentTopLinkLogLevel(java.lang.String category)

Deprecated.

Answer the TopLink log level that is changeable, given the passed category. This does not affect the log level in the project (i.e. The next time the application is deployed, changes are forgotten)

Parameters:

String - category: category for level

setcurrentTopLinkLogLevel

public void setcurrentTopLinkLogLevel(java.lang.String newLevel)

Deprecated.

Set the TopLink 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:

String - newLevel: new log level

getprofilingType

public java.lang.String getprofilingType()

Deprecated.

This method is used to get the type of profiling. Possible values are: "TopLink", "DMS" or "None".

setprofilingType

public void setprofilingType(java.lang.String profileType)

Deprecated.

This method is used to select the type of profiling. Valid values are: "TopLink", "DMS" or "None". These values are not case sensitive. null is considered to be "None".

setuseTopLinkProfiling

public void setuseTopLinkProfiling()

Deprecated.

This method is used to turn on TopLink Performance Profiling

setuseDMSProfiling

public void setuseDMSProfiling()

Deprecated.

This method is used to turn on DMS Performance Profiling

getusesTopLinkProfiling

public java.lang.Boolean getusesTopLinkProfiling()

Deprecated.

This method answers true if TopLink Performance Profiling is on.

getusesDMSProfiling

public java.lang.Boolean getusesDMSProfiling()

Deprecated.

This method answers true if DMS Performance Profiling is on.

setuseNoProfiling

public void setuseNoProfiling()

Deprecated.

This method is used to turn off all Performance Profiling, DMS or TopLink.

setshouldLogPerformanceProfiler

public void setshouldLogPerformanceProfiler(java.lang.Boolean shouldLogPerformanceProfiler)

Deprecated.

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

getshouldLogPerformanceProfiler

public java.lang.Boolean getshouldLogPerformanceProfiler()

Deprecated.

Method indicates if Performace profile should be loged

getshouldBindAllParameters

public java.lang.Boolean getshouldBindAllParameters()

Deprecated.

Method returns if all Parameters should be bound or not

getstringBindingSize

public java.lang.Integer getstringBindingSize()

Deprecated.

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

getusesBatchWriting

public java.lang.Boolean getusesBatchWriting()

Deprecated.

This method will return if batchWriting is in use or not.

gettimeConnectionEstablished

public java.lang.Long gettimeConnectionEstablished()

Deprecated.

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

getusesJDBCBatchWriting

public java.lang.Boolean getusesJDBCBatchWriting()

Deprecated.

This method will return if batchWriting is in use or not.

getusesByteArrayBinding

public java.lang.Boolean getusesByteArrayBinding()

Deprecated.

Shows if Byte Array Binding is turned on or not

getusesNativeSQL

public java.lang.Boolean getusesNativeSQL()

Deprecated.

Shows if native SQL is being used

getusesStreamsForBinding

public java.lang.Boolean getusesStreamsForBinding()

Deprecated.

This method indicates if streams are being used for binding

getusesStringBinding

public java.lang.Boolean getusesStringBinding()

Deprecated.

This method indicates if Strings are being bound

getshouldCacheAllStatements

public java.lang.Boolean getshouldCacheAllStatements()

Deprecated.

Returns if statements should be cached or not

getstatementCacheSize

public java.lang.Integer getstatementCacheSize()

Deprecated.

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

clearStatementCache

public void clearStatementCache()

Deprecated.

Used to clear the statement cache. Only valid if statements are being cached

getsequencePreallocationSize

public java.lang.Integer getsequencePreallocationSize()

Deprecated.

Method returns the value of the Sequence Preallocation size

printAvailableConnectionPools

public void printAvailableConnectionPools()

Deprecated.

This method will print the available Connection pools to the SessionLog.

getMaxSizeForPool

public java.lang.Integer getMaxSizeForPool(java.lang.String poolName)

Deprecated.

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

public java.lang.Integer getMinSizeForPool(java.lang.String poolName)

Deprecated.

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.

resetAllConnections

public void resetAllConnections()

Deprecated.

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

printClassesInSession

public void printClassesInSession()

Deprecated.

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

public void printObjectsInIdentityMap(java.lang.String className)
                               throws java.lang.ClassNotFoundException

Deprecated.

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:

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

java.lang.ClassNotFoundException

printAllIdentityMapTypes

public void printAllIdentityMapTypes()

Deprecated.

This method will log the types of Identity Maps in the session.

printObjectsInIdentityMaps

public void printObjectsInIdentityMaps()

Deprecated.

This method will log all objects in all Identity Maps in the session.

getNumberOfObjectsInIdentityMap

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

Deprecated.

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:

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

java.lang.ClassNotFoundException

getnumberOfObjectsInAllIdentityMaps

public java.lang.Integer getnumberOfObjectsInAllIdentityMaps()

Deprecated.

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

getnumberOfPersistentClasses

public java.lang.Integer getnumberOfPersistentClasses()

Deprecated.

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

printIdentityMapLocks

public void printIdentityMapLocks()

Deprecated.

This method will log the instance level locks in all Identity Maps in the session.

printIdentityMapLocks

public void printIdentityMapLocks(java.lang.String registeredClassName)

Deprecated.

This method will log the instance level locks in the Identity Map for the given class in the session.

printProfileSummary

public void printProfileSummary()

Deprecated.

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

printProfileSummaryByClass

public void printProfileSummaryByClass()

Deprecated.

This method assumes TopLink 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

public void printProfileSummaryByQuery()

Deprecated.

This method assumes TopLink 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

public java.lang.String getlogType()

Deprecated.

Return the log type, either "TopLink", "Java" or "Server"

Returns:

the log type

getdatabasePlatform

public java.lang.String getdatabasePlatform()

Deprecated.

Return the database platform used by the DatabaseSession.

Returns:

String databasePlatform

getjdbcConnectionDetails

public java.lang.String getjdbcConnectionDetails()

Deprecated.

Return JDBCConnection detail information. This includes URL and datasource information.

getconnectionPoolType

public java.lang.String getconnectionPoolType()

Deprecated.

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

getdriver

public java.lang.String getdriver()

Deprecated.

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

getlogFilename

public java.lang.String getlogFilename()

Deprecated.

Return the log filename. This returns the fully qualified path of the log file when TopLink logging is enabled. Null is returned otherwise.

Returns:

String logFilename

getdeployedProfileWeight

public java.lang.String getdeployedProfileWeight()

Deprecated.

Answer the deployed sensor weight (NORMAL, HEAVY, ALL) as an String. This is read-only. Although this API exists for both DMS and TopLink profiling, it only really applies to DMS.

getcurrentProfileWeight

public java.lang.String getcurrentProfileWeight()

Deprecated.

Answer the current sensor weight (NORMAL, HEAVY, ALL, NONE) as a String. Although this API exists for both DMS and TopLink profiling, it only really applies to DMS.

setcurrentProfileWeight

public void setcurrentProfileWeight(java.lang.String weight)

Deprecated.

This method is used to change the sensor weight (NORMAL, HEAVY, ALL, NONE) as an String. Although this API exists for both DMS and TopLink profiling, it only really applies to DMS.

initializeAllIdentityMaps

public void initializeAllIdentityMaps()

Deprecated.

This method is used to initialize the identity maps in the session.

initializeIdentityMaps

public void initializeIdentityMaps(java.lang.String[] classNames)
                            throws java.lang.ClassNotFoundException

Deprecated.

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:

java.lang.ClassNotFoundException

initializeIdentityMap

public void initializeIdentityMap(java.lang.String className)
                           throws java.lang.ClassNotFoundException

Deprecated.

This method is used to initialize the identity maps specified by className.

Parameters:

className - the fully qualified classname identifying the identity map to initialize

Throws:

java.lang.ClassNotFoundException

invalidateAllIdentityMaps

public void invalidateAllIdentityMaps()

Deprecated.

This method is used to invalidate the identity maps in the session.

invalidateIdentityMaps

public void invalidateIdentityMaps(java.lang.String[] classNamesParam,
                                   java.lang.Boolean recurse)
                            throws java.lang.ClassNotFoundException

Deprecated.

This method is used to invalidate the identity maps specified by the String[] of classNames.

Parameters:

classNames - 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:

java.lang.ClassNotFoundException

invalidateIdentityMap

public void invalidateIdentityMap(java.lang.String className)
                           throws java.lang.ClassNotFoundException

Deprecated.

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:

java.lang.ClassNotFoundException

invalidateIdentityMap

public void invalidateIdentityMap(java.lang.String className,
                                  java.lang.Boolean recurse)
                           throws java.lang.ClassNotFoundException

Deprecated.

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:

java.lang.ClassNotFoundException

getcacheSynchEnabled

public java.lang.Boolean getcacheSynchEnabled()

Deprecated.

This method is used to answer whether cache synchronization is enabled or not.

getcacheSynchAsynchronous

public java.lang.Boolean getcacheSynchAsynchronous()

Deprecated.

This method is used to answer whether cache synchronization is asynchronous or not.