oracle.toplink.services
Class RuntimeServices

java.lang.Object
oracle.toplink.services.RuntimeServices

Direct Known Subclasses:

MBeanRuntimeServices

public class RuntimeServices

extends java.lang.Object

Purpose: Provide a dynamic interface into the TopLink Session.

Description: This class is ment to provide a framework for gaining access to configuration of the TopLink Session during runtime. It will provide the basis for developement of a JMX service and possibly other frameworks.

Constructor Summary

RuntimeServices()
PUBLIC: Default Constructor

RuntimeServices(oracle.toplink.publicinterface.Session session)
PUBLIC: Constructor

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) PUBLIC: This method provides client with access to add a new connection pool to a TopLink ServerSession.
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, java.lang.String licencePath) Deprecated. use addNewConnectionPool(String poolName, int maxSize, int minSize, String platform, String driverClassName, String url, String userName, String password) throws ClassNotFoundException instead.
java.util.List	getAvailableConnectionPools() PUBLIC: This method will return the available Connection pools within this Server Session
java.util.List	getClassesInSession() PUBLIC: This method is used to return those Class Names that have identity Maps in the Session.
java.lang.Integer	getNumberOfObjectsInIdentityMap(java.lang.String className) PUBLIC: This method is used to return the number of objects in a particular Identity Map
java.lang.Integer	getNumberOfObjectsInIdentityMapSubCache(java.lang.String className) PUBLIC: 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) PUBLIC: This method will return a collection of the objects in the Identity Map.
java.util.List	getObjectsInIdentityMapSubCache(java.lang.String className) Deprecated.
java.util.Map	getObjectsInIdentityMapSubCacheAsMap(java.lang.String className) PUBLIC: This method is used to return a Map of the objects in a particular Identity Map's subcache.
int	getSequencePreallocationSize() PUBLIC: Method returns the value of the Sequence Preallocation size
boolean	getShouldCacheAllStatements() PUBLIC: Returns if statements should be cached or not
boolean	getShouldLogDebug() PUBLIC: This method is used to determine if debug messages should be logged
boolean	getShouldLogExceptions() PUBLIC: This method is used to determine if exception messages should be logged
boolean	getShouldLogExceptionStackTrace() PUBLIC: This method is used to determine if exception Stack Trace should be logged
boolean	getShouldLogMessages() PUBLIC: This method is used to determine if messages should be logged by the session
boolean	getShouldLogPerformanceProfiler() PUBLIC: Method indicates if Performace profile should be loged
boolean	getShouldPrintConnection() PUBLIC: return whether connection information should be printed with logged messages
boolean	getShouldPrintDate() PUBLIC: This method is used to determine if the date should be printed with logged messages
boolean	getShouldPrintSession() PUBLIC: return whether session information should be printed with logged messages
boolean	getShouldPrintThread() PUBLIC: return whether thread information should be printed with logged messages
boolean	getShouldProfilePerformance() PUBLIC: This method will return if profgiling is turned on or not
java.util.List	getSizeForPool(java.lang.String poolName) PUBLIC: This method will retrieve the size of a particular connection pool
int	getStatementCacheSize() PUBLIC: Returns the statement cache size.
void	resetAllConnections() PUBLIC: This method is used to reset connections from the session to the database.
void	setSequencePreallocationSize(int size) PUBLIC: This method provide access for setting the sequence pre-allocation size
void	setShouldCacheAllStatements(boolean shouldCacheAllStatements) PUBLIC: Method used to set if statements should be cached.
void	setShouldLogDebug(boolean shouldLogDebug) PUBLIC: This method is used to set if debug messages should be logged
void	setShouldLogExceptions(boolean shouldLogExceptions) PUBLIC: This method is used to set if Exception messages should be logged
void	setShouldLogExceptionStackTrace(boolean shouldLogExceptionStackTrace) PUBLIC: This method is used to set if Exception Stack Trace should be logged
void	setShouldLogMessages(boolean shouldLogMessages) PUBLIC: This method is used to set if messages should be logged by the session
void	setShouldLogPerformanceProfiler(boolean shouldLogPerformanceProfiler) PUBLIC: This method is used to turn on Profile logging when using th Performance Profiler
void	setShouldPrintConnection(boolean shouldPrintConnection) PUBLIC: Set this to true if connection information should be printed with logged messages
void	setShouldPrintDate(boolean shouldPrintDate) PUBLIC: This method is used to set if date should be printed with logging messages
void	setShouldPrintSession(boolean shouldPrintSession) PUBLIC: Set to true if session information should be printed with logged messages
void	setShouldPrintThread(boolean shouldPrintThread) PUBLIC: Set this to true if thread information should be printed with logged messages
void	setShouldProfilePerformance(boolean shouldProfile) PUBLIC: This method is used to turn on Performance Profiling
void	setStatementCacheSize(int size) PUBLIC: Used to set the statement cache size.
void	updatePoolSize(java.lang.String poolName, int maxSize, int minSize) PUBLIC: This method allows the client to set the pool size for a particular pool, based on the pool name

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeServices

public RuntimeServices()

PUBLIC: Default Constructor

RuntimeServices

public RuntimeServices(oracle.toplink.publicinterface.Session session)

PUBLIC: Constructor

Parameters:

session - the session to be used with these RuntimeServices

Method Detail

setShouldLogMessages

public void setShouldLogMessages(boolean shouldLogMessages)

PUBLIC: This method is used to set if messages should be logged by the session

getShouldLogMessages

public boolean getShouldLogMessages()

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

setShouldLogDebug

public void setShouldLogDebug(boolean shouldLogDebug)

PUBLIC: This method is used to set if debug messages should be logged

getShouldLogDebug

public boolean getShouldLogDebug()

PUBLIC: This method is used to determine if debug messages should be logged

setShouldLogExceptions

public void setShouldLogExceptions(boolean shouldLogExceptions)

PUBLIC: This method is used to set if Exception messages should be logged

getShouldLogExceptions

public boolean getShouldLogExceptions()

PUBLIC: This method is used to determine if exception messages should be logged

setShouldLogExceptionStackTrace

public void setShouldLogExceptionStackTrace(boolean shouldLogExceptionStackTrace)

PUBLIC: This method is used to set if Exception Stack Trace should be logged

getShouldLogExceptionStackTrace

public boolean getShouldLogExceptionStackTrace()

PUBLIC: This method is used to determine if exception Stack Trace should be logged

setShouldPrintDate

public void setShouldPrintDate(boolean shouldPrintDate)

PUBLIC: This method is used to set if date should be printed with logging messages

getShouldPrintDate

public boolean getShouldPrintDate()

PUBLIC: This method is used to determine if the date should be printed with logged messages

setShouldPrintSession

public void setShouldPrintSession(boolean shouldPrintSession)

PUBLIC: Set to true if session information should be printed with logged messages

getShouldPrintSession

public boolean getShouldPrintSession()

PUBLIC: return whether session information should be printed with logged messages

setShouldPrintThread

public void setShouldPrintThread(boolean shouldPrintThread)

PUBLIC: Set this to true if thread information should be printed with logged messages

getShouldPrintThread

public boolean getShouldPrintThread()

PUBLIC: return whether thread information should be printed with logged messages

setShouldPrintConnection

public void setShouldPrintConnection(boolean shouldPrintConnection)

PUBLIC: Set this to true if connection information should be printed with logged messages

getShouldPrintConnection

public boolean getShouldPrintConnection()

PUBLIC: return whether connection information should be printed with logged messages

setShouldProfilePerformance

public void setShouldProfilePerformance(boolean shouldProfile)

PUBLIC: This method is used to turn on Performance Profiling

getShouldProfilePerformance

public boolean getShouldProfilePerformance()

PUBLIC: This method will return if profgiling is turned on or not

setShouldLogPerformanceProfiler

public void setShouldLogPerformanceProfiler(boolean shouldLogPerformanceProfiler)

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

getShouldLogPerformanceProfiler

public boolean getShouldLogPerformanceProfiler()

PUBLIC: Method indicates if Performace profile should be loged

setShouldCacheAllStatements

public void setShouldCacheAllStatements(boolean shouldCacheAllStatements)

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

getShouldCacheAllStatements

public boolean getShouldCacheAllStatements()

PUBLIC: Returns if statements should be cached or not

setStatementCacheSize

public void setStatementCacheSize(int size)

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

getStatementCacheSize

public int getStatementCacheSize()

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

setSequencePreallocationSize

public void setSequencePreallocationSize(int size)

PUBLIC: This method provide access for setting the sequence pre-allocation size

getSequencePreallocationSize

public int getSequencePreallocationSize()

PUBLIC: Method returns the value of the Sequence Preallocation size

updatePoolSize

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

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

Parameters:

poolName - the name of the pool to be updated.

maxSize - the new maximum number of connections

minSize - the new minimum number of connections

getAvailableConnectionPools

public java.util.List getAvailableConnectionPools()

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

Returns:

java.util.List the available pools.

getSizeForPool

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

PUBLIC: This method will retrieve the size of a particular connection pool

Parameters:

poolName - the name of the pool to get the size for

Returns:

java.util.List a list containing two values. The first value is the Maximun size of the pool. The second value is the Minimum size of the pool.

addNewConnectionPool

public 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,
                                 java.lang.String licencePath)
                          throws java.lang.ClassNotFoundException

Deprecated. use addNewConnectionPool(String poolName, int maxSize, int minSize, String platform, String driverClassName, String url, String userName, String password) throws ClassNotFoundException instead.

OBSOLETE: This method provides client with access to add a new connection pool to a TopLink ServerSession.

Parameters:

poolName - the name of the new pool

maxSize - the maximum number of connections in the pool

minSize - the minimum number of connections in the pool

platform - the fully qualified name of the TopLink platform to use with this pool.

driverClassName - the fully qualified name of the JDBC driver class

url - the URL of the database to connect to

userName - the user name to connect to the database with

password - the password to connect to the database with

licencePath - the path to the TopLink license file.

Throws:

java.lang.ClassNotFoundException - if any of the class names are mispelled.

addNewConnectionPool

public 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

PUBLIC: This method provides client with access to add a new connection pool to a TopLink ServerSession.

Parameters:

poolName - the name of the new pool

maxSize - the maximum number of connections in the pool

minSize - the minimum number of connections in the pool

platform - the fully qualified name of the TopLink platform to use with this pool.

driverClassName - the fully qualified name of the JDBC driver class

url - the URL of the database to connect to

userName - the user name to connect to the database with

password - the password to connect to the database with

Throws:

java.lang.ClassNotFoundException - if any of the class names are mispelled.

resetAllConnections

public void resetAllConnections()

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

public java.util.List getClassesInSession()

PUBLIC: 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.

Returns:

java.util.List contains all of the classes which have identity maps in the current session.

getObjectsInIdentityMap

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

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

Parameters:

className - the fully qualified classname of the class to the instances of

Throws:

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

java.lang.ClassNotFoundException

getNumberOfObjectsInIdentityMap

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

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

getObjectsInIdentityMapSubCache

public java.util.List getObjectsInIdentityMapSubCache(java.lang.String className)
                                               throws java.lang.ClassNotFoundException

Deprecated.

PUBLIC: This method is used to return a collection of the objects in a particular Identity Map's subcache. Only works for those identity Maps with a sub cache (ie Hard Cache Weak 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

See Also:

getObjectsInIdentityMapSubCacheAsMap(String className)

getObjectsInIdentityMapSubCacheAsMap

public java.util.Map getObjectsInIdentityMapSubCacheAsMap(java.lang.String className)
                                                   throws java.lang.ClassNotFoundException

PUBLIC: This method is used to return a Map of the objects in a particular Identity Map's subcache. Only works for those identity Maps with a sub cache (ie Hard Cache Weak Identity Map) This method replaces getObjectsInIdentityMapSubCache(className) which returns a list instead of a 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

getNumberOfObjectsInIdentityMapSubCache

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

PUBLIC: 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)

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