Top Description Fields Constructors Methods
org.eclipse.persistence.platform.server.jboss

public Class JBossPlatform

extends JMXServerPlatformBase
implements JMXEnabledPlatform
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.platform.server.JMXEnabledPlatform
Imports
jakarta.persistence.spi.PersistenceUnitInfo, org.eclipse.persistence.internal.helper.JPAClassLoaderHolder, org.eclipse.persistence.logging.AbstractSessionLog, org.eclipse.persistence.platform.server.JMXEnabledPlatform, .JMXServerPlatformBase, org.eclipse.persistence.services.jboss.MBeanJBossRuntimeServices, org.eclipse.persistence.sessions.DatabaseSession, .ExternalTransactionController, org.eclipse.persistence.transaction.jboss.JBossTransactionController, .JBossTransactionController11

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

Inherited from org.eclipse.persistence.platform.server.JMXServerPlatformBase:
APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_POSTFIXAPP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_PREFIXAPP_SERVER_CLASSLOADER_MODULE_EJB_SEARCH_STRING_PREFIXAPP_SERVER_CLASSLOADER_MODULE_EJB_WAR_SEARCH_STRING_POSTFIXAPP_SERVER_CLASSLOADER_MODULE_WAR_SEARCH_STRING_PREFIXJMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERSJMX_REGISTRATION_PREFIXmBeanServerOVERRIDE_JMX_APPLICATIONNAME_PROPERTYOVERRIDE_JMX_MODULENAME_PROPERTY

Constructor Summary

AccessConstructor and Description
public
JBossPlatform(DatabaseSession newDatabaseSession)

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

Method Summary

Modifier and TypeMethod and Description
public Class<? extends ExternalTransactionController>

Returns:

Class externalTransactionControllerClass
getExternalTransactionControllerClass
()

Implements abstract org.eclipse.persistence.platform.server.ServerPlatformBase.getExternalTransactionControllerClass.

Implements org.eclipse.persistence.platform.server.ServerPlatform.getExternalTransactionControllerClass.

INTERNAL: getExternalTransactionControllerClass(): Answer the class of external transaction controller to use for JBoss.
public JPAClassLoaderHolder

Returns:

ClassLoaderHolder - a composite object containing the classLoader and the flag that is true if the classLoader returned is temporary
getNewTempClassLoader
(PersistenceUnitInfo
- the persistence unit info
puInfo
)

Overrides org.eclipse.persistence.platform.server.ServerPlatformBase.getNewTempClassLoader.

Implements org.eclipse.persistence.platform.server.ServerPlatform.getNewTempClassLoader.

INTERNAL: JIRA EJBTHREE-572 requires that we use the real classLoader in place of the getNewTempClassLoader().
public boolean
isRuntimeServicesEnabledDefault()

Overrides org.eclipse.persistence.platform.server.ServerPlatformBase.isRuntimeServicesEnabledDefault.

Implements org.eclipse.persistence.platform.server.ServerPlatform.isRuntimeServicesEnabledDefault.

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

Implements org.eclipse.persistence.platform.server.JMXEnabledPlatform.prepareServerSpecificServicesMBean.

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

Overrides org.eclipse.persistence.platform.server.JMXServerPlatformBase.serverSpecificRegisterMBean.

INTERNAL: serverSpecificRegisterMBean(): Server specific implementation of the creation and deployment of the JMX MBean to provide runtime services for my databaseSession.
Inherited from org.eclipse.persistence.platform.server.JMXServerPlatformBase:
getAbstractSessiongetApplicationNamegetApplicationNamegetMBeanServergetMBeanSessionNamegetModuleNamegetModuleNamegetRuntimeServicesMBeaninitializeApplicationNameAndModuleNameserverSpecificUnregisterMBeansetApplicationNamesetModuleNamesetRuntimeServicesMBean

Constructor Detail

JBossPlatformback to summary
public JBossPlatform(DatabaseSession newDatabaseSession)

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

Method Detail

getExternalTransactionControllerClassback to summary
public Class<? extends ExternalTransactionController> getExternalTransactionControllerClass()

Implements abstract org.eclipse.persistence.platform.server.ServerPlatformBase.getExternalTransactionControllerClass.

Implements org.eclipse.persistence.platform.server.ServerPlatform.getExternalTransactionControllerClass.

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

Returns:Class<? extends ExternalTransactionController>

Class externalTransactionControllerClass

Annotations
@Override
See Also
org.eclipse.persistence.transaction.JTATransactionController, org.eclipse.persistence.platform.server.ServerPlatformBase#isJTAEnabled(), org.eclipse.persistence.platform.server.ServerPlatformBase#disableJTA(), org.eclipse.persistence.platform.server.ServerPlatformBase#initializeExternalTransactionController()
getNewTempClassLoaderback to summary
public JPAClassLoaderHolder getNewTempClassLoader(PersistenceUnitInfo puInfo)

Overrides org.eclipse.persistence.platform.server.ServerPlatformBase.getNewTempClassLoader.

Implements org.eclipse.persistence.platform.server.ServerPlatform.getNewTempClassLoader.

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

Parameters
puInfo:PersistenceUnitInfo

- the persistence unit info

Returns:JPAClassLoaderHolder

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

Annotations
@Override
See Also
org.eclipse.persistence.internal.helper.JPAClassLoaderHolder
isRuntimeServicesEnabledDefaultback to summary
public boolean isRuntimeServicesEnabledDefault()

Overrides org.eclipse.persistence.platform.server.ServerPlatformBase.isRuntimeServicesEnabledDefault.

Implements org.eclipse.persistence.platform.server.ServerPlatform.isRuntimeServicesEnabledDefault.

Doc from org.eclipse.persistence.platform.server.ServerPlatformBase.isRuntimeServicesEnabledDefault.

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 isRuntimeServicesEnabled() for a ServerPlatform. By default this is false but some platforms can choose to have MBeans deployed by default.

Annotations
@Override
prepareServerSpecificServicesMBeanback to summary
public void prepareServerSpecificServicesMBean()

Implements org.eclipse.persistence.platform.server.JMXEnabledPlatform.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.

Annotations
@Override
See Also
isRuntimeServicesEnabled(), disableRuntimeServices(), registerMBean()
serverSpecificRegisterMBeanback to summary
public void serverSpecificRegisterMBean()

Overrides org.eclipse.persistence.platform.server.JMXServerPlatformBase.serverSpecificRegisterMBean.

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

Annotations
@Override
See Also
isRuntimeServicesEnabled(), disableRuntimeServices(), registerMBean()