oracle.toplink.essentials.platform.server

Interface ServerPlatform

All Known Implementing Classes:

CustomServerPlatform, NoServerPlatform, Oc4jPlatform, ServerPlatformBase, SunAS9ServerPlatform

public interface ServerPlatform

PUBLIC: This is the interface describing the behaviour for ServerPlatformBase, and any other class that wants to provide behaviour for a server. This interface provides the behaviour for - Which external transaction controller to use - Whether or not to enable JTA (external transaction control) - How to register/unregister for runtime services (JMX/MBean) - Whether or not to enable runtime services - How to launch container Threads Any subclasses of ServerPlatformBase created by the user must implement this interface. public API: String getServerNameAndVersion()

See Also:

ServerPlatformBase

Method Summary

Modifier and Type	Method and Description
void	disableJTA() INTERNAL: disableJTA(): Configure the receiver such that my external transaction controller class will be ignored, and will NOT be used to populate DatabaseSession's external transaction controller class at runtime.
void	disableRuntimeServices() INTERNAL: disableRuntimeServices(): Configure the receiver such that no JMX/MBean will be registered to provide runtime services for my DatabaseSession at runtime.
DatabaseSessionImpl	getDatabaseSession() INTERNAL: getDatabaseSession(): Answer the instance of DatabaseSession the receiver is helping.
Class	getExternalTransactionControllerClass() INTERNAL: getExternalTransactionControllerClass(): Answer the class of external transaction controller to use For this server platform.
String	getModuleName() INTERNAL: getModuleName(): Answer the name of the module (jar name) that my session is associated with.
SessionLog	getServerLog() INTERNAL: getServerLog(): Return the ServerLog for this platform Return the default ServerLog in the base
String	getServerNameAndVersion() PUBLIC: getServerNameAndVersion(): Talk to the relevant server class library, and get the server name and version
void	initializeExternalTransactionController() INTERNAL: initializeExternalTransactionController(): Populate the DatabaseSession's external transaction controller with an instance of my transaction controller class.
boolean	isJTAEnabled() INTERNAL: isJTAEnabled(): Answer true if the DatabaseSession's external transaction controller class will be populated with my transaction controller class at runtime.
boolean	isRuntimeServicesEnabled() INTERNAL: isRuntimeServicesEnabled(): Answer true if the JMX/MBean providing runtime services for the receiver's DatabaseSession will be deployed at runtime.
void	launchContainerRunnable(Runnable runnable) INTERNAL: launchContainerRunnable(Runnable runnable): Use the container library to start the provided Runnable.
void	registerMBean() INTERNAL: registerMBean(): Create and deploy the JMX MBean to provide runtime services for my databaseSession.
void	setExternalTransactionControllerClass(Class newClass) INTERNAL: setExternalTransactionControllerClass(Class newClass): Set the class of external transaction controller to use in the DatabaseSession.
void	unregisterMBean() INTERNAL: unregisterMBean(): Unregister the JMX MBean that was providing runtime services for my databaseSession.
Connection	unwrapOracleConnection(Platform platform, Connection connection) INTERNAL: This method is used to unwrap the oracle connection wrapped by the application server.

Method Detail

getDatabaseSession

DatabaseSessionImpl getDatabaseSession()

INTERNAL: getDatabaseSession(): Answer the instance of DatabaseSession the receiver is helping.

Returns:

DatabaseSession

getServerNameAndVersion

String getServerNameAndVersion()

PUBLIC: getServerNameAndVersion(): Talk to the relevant server class library, and get the server name and version

Returns:

String serverNameAndVersion

getModuleName

String getModuleName()

INTERNAL: getModuleName(): Answer the name of the module (jar name) that my session is associated with. Answer "unknown" if there is no module name available.

Returns:

String moduleName

getExternalTransactionControllerClass

Class getExternalTransactionControllerClass()

INTERNAL: getExternalTransactionControllerClass(): Answer the class of external transaction controller to use For this server platform. This is read-only. If the subclasses of the ServerPlatformBase do not provide the Class desired, then a new subclass should be created to return the desired class.

Returns:

Class externalTransactionControllerClass

See Also:

JTATransactionController, isJTAEnabled(), disableJTA(), initializeExternalTransactionController()

setExternalTransactionControllerClass

void setExternalTransactionControllerClass(Class newClass)

INTERNAL: setExternalTransactionControllerClass(Class newClass): Set the class of external transaction controller to use in the DatabaseSession. This is defined by the user via the sessions.xml.

See Also:

JTATransactionController, isJTAEnabled(), disableJTA(), initializeExternalTransactionController()

initializeExternalTransactionController

void initializeExternalTransactionController()

INTERNAL: initializeExternalTransactionController(): Populate the DatabaseSession's external transaction controller with an instance of my transaction controller class. To change the external transaction controller class, we recommend creating a subclass of ServerPlatformBase, and overriding getExternalTransactionControllerClass()

See Also:

ServerPlatformBase

isJTAEnabled

boolean isJTAEnabled()

INTERNAL: isJTAEnabled(): Answer true if the DatabaseSession's external transaction controller class will be populated with my transaction controller class at runtime. If the transaction controller class is overridden in the DatabaseSession, my transaction controller class will be ignored.

Returns:

boolean isJTAEnabled

See Also:

getExternalTransactionControllerClass(), disableJTA()

disableJTA

void disableJTA()

INTERNAL: disableJTA(): Configure the receiver such that my external transaction controller class will be ignored, and will NOT be used to populate DatabaseSession's external transaction controller class at runtime.

See Also:

getExternalTransactionControllerClass(), isJTAEnabled()

isRuntimeServicesEnabled

boolean isRuntimeServicesEnabled()

INTERNAL: isRuntimeServicesEnabled(): Answer true if the JMX/MBean providing runtime services for the receiver's DatabaseSession will be deployed at runtime.

Returns:

boolean isRuntimeServicesEnabled

See Also:

disableRuntimeServices()

disableRuntimeServices

void disableRuntimeServices()

INTERNAL: disableRuntimeServices(): Configure the receiver such that no JMX/MBean will be registered to provide runtime services for my DatabaseSession at runtime.

See Also:

isRuntimeServicesEnabled()

registerMBean

void registerMBean()

INTERNAL: registerMBean(): Create and deploy the JMX MBean to provide runtime services for my databaseSession.

See Also:

isRuntimeServicesEnabled(), disableRuntimeServices(), unregisterMBean()

unregisterMBean

void unregisterMBean()

INTERNAL: unregisterMBean(): Unregister the JMX MBean that was providing runtime services for my databaseSession.

See Also:

isRuntimeServicesEnabled(), disableRuntimeServices(), registerMBean()

unwrapOracleConnection

Connection unwrapOracleConnection(Platform platform,
                                  Connection connection)

INTERNAL: This method is used to unwrap the oracle connection wrapped by the application server. TopLink needs this unwrapped connection for certain Oracle Specific support. (ie TIMESTAMPTZ) This is added as a workaround for bug 4460996

launchContainerRunnable

void launchContainerRunnable(Runnable runnable)

INTERNAL: launchContainerRunnable(Runnable runnable): Use the container library to start the provided Runnable. Default behaviour is to use Thread(runnable).start()

Parameters:

Runnable - runnable: the instance of runnable to be "started"

getServerLog

SessionLog getServerLog()

INTERNAL: getServerLog(): Return the ServerLog for this platform Return the default ServerLog in the base

Returns:

oracle.toplink.essentials.logging.SessionLog