Module eclipselink

Package org.eclipse.persistence.platform.server.jboss

Class JBossPlatform

java.lang.Object

org.eclipse.persistence.platform.server.ServerPlatformBase

org.eclipse.persistence.platform.server.JMXServerPlatformBase

org.eclipse.persistence.platform.server.jboss.JBossPlatform

All Implemented Interfaces:

JMXEnabledPlatform, ServerPlatform

public class JBossPlatform
extends JMXServerPlatformBase
implements JMXEnabledPlatform

PUBLIC:

This is the concrete subclass responsible for representing JBoss-specific server behavior.

This platform overrides:

getExternalTransactionControllerClass(): to use an JBoss-specific controller class

Field Summary

Fields inherited from class org.eclipse.persistence.platform.server.JMXServerPlatformBase

APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_POSTFIX, APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_PREFIX, APP_SERVER_CLASSLOADER_MODULE_EJB_SEARCH_STRING_PREFIX, APP_SERVER_CLASSLOADER_MODULE_EJB_WAR_SEARCH_STRING_POSTFIX, APP_SERVER_CLASSLOADER_MODULE_WAR_SEARCH_STRING_PREFIX, JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS, JMX_REGISTRATION_PREFIX, mBeanServer, OVERRIDE_JMX_APPLICATIONNAME_PROPERTY, OVERRIDE_JMX_MODULENAME_PROPERTY

Fields inherited from class org.eclipse.persistence.platform.server.ServerPlatformBase

DEFAULT_SERVER_NAME_AND_VERSION, externalTransactionControllerClass, JMX_REGISTER_DEV_MBEAN_PROPERTY, JMX_REGISTER_RUN_MBEAN_PROPERTY, serverNameAndVersion, shouldRegisterDevelopmentBean, shouldRegisterRuntimeBean, threadPool, threadPoolSize

Constructor Summary

Constructors

Constructor	Description
JBossPlatform(DatabaseSession newDatabaseSession)	INTERNAL: Default Constructor: All behavior for the default constructor is inherited

Method Summary

Modifier and Type	Method	Description
Class<? extends ExternalTransactionController>	getExternalTransactionControllerClass()	INTERNAL: getExternalTransactionControllerClass(): Answer the class of external transaction controller to use for JBoss.
org.eclipse.persistence.internal.helper.JPAClassLoaderHolder	getNewTempClassLoader(jakarta.persistence.spi.PersistenceUnitInfo puInfo)	INTERNAL: JIRA EJBTHREE-572 requires that we use the real classLoader in place of the getNewTempClassLoader().
boolean	isRuntimeServicesEnabledDefault()	INTERNAL: isRuntimeServicesEnabledDefault(): Answer true if the JMX/MBean providing runtime services for the receiver's DatabaseSession will be deployed at runtime.
void	prepareServerSpecificServicesMBean()	INTERNAL: prepareServerSpecificServicesMBean(): Server specific implementation of the creation and deployment of the JMX MBean to provide runtime services for the databaseSession.
void	serverSpecificRegisterMBean()	INTERNAL: serverSpecificRegisterMBean(): Server specific implementation of the creation and deployment of the JMX MBean to provide runtime services for my databaseSession.

Methods inherited from class org.eclipse.persistence.platform.server.JMXServerPlatformBase

getAbstractSession, getApplicationName, getApplicationName, getMBeanServer, getMBeanSessionName, getModuleName, getModuleName, getRuntimeServicesMBean, initializeApplicationNameAndModuleName, serverSpecificUnregisterMBean, setApplicationName, setModuleName, setRuntimeServicesMBean

Methods inherited from class org.eclipse.persistence.platform.server.ServerPlatformBase

clearStatementCache, configureProfiler, disableJTA, disableRuntimeServices, enableRuntimeServices, ensureNotLoggedIn, externalTransactionControllerNotNullWarning, getDatabaseSession, getJNDIConnectorLookupType, getPartitionID, getServerLog, getServerNameAndVersion, getThreadPool, getThreadPoolSize, initializeExternalTransactionController, initializeServerNameAndVersion, isCMP, isJTA11, isJTAEnabled, isRuntimeServicesEnabled, launchContainerRunnable, registerMBean, setExternalTransactionControllerClass, setIsCMP, setThreadPool, setThreadPoolSize, shouldUseDriverManager, shutdown, unregisterMBean, unwrapConnection, usesPartitions, wasFailureCommunicationBased

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.persistence.platform.server.JMXEnabledPlatform

getApplicationName

Constructor Details

JBossPlatform

public JBossPlatform(DatabaseSession newDatabaseSession)

INTERNAL: Default Constructor: All behavior for the default constructor is inherited

Method Details

isRuntimeServicesEnabledDefault

public boolean isRuntimeServicesEnabledDefault()

Description copied from class: ServerPlatformBase

INTERNAL: isRuntimeServicesEnabledDefault(): Answer true if the JMX/MBean providing runtime services for the receiver's DatabaseSession will be deployed at runtime. Provide the default value for ServerPlatformBase.isRuntimeServicesEnabled() for a ServerPlatform. By default this is false but some platforms can choose to have MBeans deployed by default.

Specified by:

isRuntimeServicesEnabledDefault in interface ServerPlatform

Overrides:

isRuntimeServicesEnabledDefault in class ServerPlatformBase

getExternalTransactionControllerClass

public Class<? extends ExternalTransactionController> getExternalTransactionControllerClass()

INTERNAL: getExternalTransactionControllerClass(): Answer the class of external transaction controller to use for JBoss. This is read-only.

Specified by:

getExternalTransactionControllerClass in interface ServerPlatform

Specified by:

getExternalTransactionControllerClass in class ServerPlatformBase

Returns:

Class externalTransactionControllerClass

See Also:

• JTATransactionController
• ServerPlatformBase.isJTAEnabled()
• ServerPlatformBase.disableJTA()
• ServerPlatformBase.initializeExternalTransactionController()

getNewTempClassLoader

public org.eclipse.persistence.internal.helper.JPAClassLoaderHolder getNewTempClassLoader(jakarta.persistence.spi.PersistenceUnitInfo puInfo)

INTERNAL: JIRA EJBTHREE-572 requires that we use the real classLoader in place of the getNewTempClassLoader(). The override code should stay in place until the UCL3 loader does not throw a NPE on loadClass()

Specified by:

getNewTempClassLoader in interface ServerPlatform

Overrides:

getNewTempClassLoader in class ServerPlatformBase

Parameters:

puInfo - - the persistence unit info

Returns:

ClassLoaderHolder - a composite object containing the classLoader and the flag that is true if the classLoader returned is temporary

See Also:

• JPAClassLoaderHolder

prepareServerSpecificServicesMBean

public void prepareServerSpecificServicesMBean()

INTERNAL: prepareServerSpecificServicesMBean(): Server specific implementation of the creation and deployment of the JMX MBean to provide runtime services for the databaseSession.

Default is to do nothing. Implementing platform classes must override this function and supply the server specific MBean instance for later registration by calling it in the constructor.

Specified by:

prepareServerSpecificServicesMBean in interface JMXEnabledPlatform

See Also:

• ServerPlatformBase.isRuntimeServicesEnabled()
• ServerPlatformBase.disableRuntimeServices()
• ServerPlatformBase.registerMBean()

serverSpecificRegisterMBean

public void serverSpecificRegisterMBean()

INTERNAL: serverSpecificRegisterMBean(): Server specific implementation of the creation and deployment of the JMX MBean to provide runtime services for my databaseSession.

Overrides:

serverSpecificRegisterMBean in class JMXServerPlatformBase

See Also:

• ServerPlatformBase.isRuntimeServicesEnabled()
• ServerPlatformBase.disableRuntimeServices()
• ServerPlatformBase.registerMBean()