Class JMXServerPlatformBase
- java.lang.Object
-
- org.eclipse.persistence.platform.server.ServerPlatformBase
-
- org.eclipse.persistence.platform.server.JMXServerPlatformBase
-
- All Implemented Interfaces:
ServerPlatform
- Direct Known Subclasses:
GlassfishPlatform
,JBossPlatform
,WebLogicPlatform
,WebSpherePlatform
public abstract class JMXServerPlatformBase extends ServerPlatformBase
PUBLIC: Subclass of org.eclipse.persistence.platform.server.ServerPlatformBase in support of the JMXEnabledPlatform interfaceThis is the abstract superclass of all platforms for all servers that contain a subclass that implements the JMXEnabledPlatform interface. Each DatabaseSession contains an instance of the receiver, to help the DatabaseSession determine:
- 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
Subclasses already exist to provide configurations for Oc4J, WebLogic, JBoss, NetWeaver, GlassFish and WebSphere.
If the versioned platform subclass is JMX enabled by EclipseLink (registers MBeans) then that server platform must implement the JMXEnabledPlatform interface To provide some different behavior than the provided ServerPlatform(s), we recommend subclassing org.eclipse.persistence.platform.server.JMXServerPlatformBase (or a subclass), and overriding:
- JMXEnabledPlatform.prepareServerSpecificServicesMBean()
- Since:
- EclipseLink 2.1.1
- See Also:
ServerPlatformBase
-
-
Field Summary
Fields Modifier and Type Field Description static int
JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS
The default indexed MBeanServer instance to use when multiple MBeanServer instances exist on the platform - usually only in JBossstatic String
JMX_REGISTRATION_PREFIX
This is the prefix for all MBeans that are registered with their specific session name appended-
Fields inherited from class org.eclipse.persistence.platform.server.ServerPlatformBase
DEFAULT_SERVER_NAME_AND_VERSION, JMX_REGISTER_DEV_MBEAN_PROPERTY, JMX_REGISTER_RUN_MBEAN_PROPERTY
-
-
Constructor Summary
Constructors Constructor Description JMXServerPlatformBase(DatabaseSession newDatabaseSession)
INTERNAL: Default Constructor: Initialize so that runtime services and JTA are enabled.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getApplicationName()
INTERNAL: getApplicationName(): Answer the name of the module (EAR name) that this session is associated with.MBeanServer
getMBeanServer()
INTERNAL: Return the MBeanServer to be used for MBean registration and deregistration.
This MBeanServer reference is lazy loaded and cached on the platform.
There are multiple ways of getting the MBeanServerString
getModuleName()
INTERNAL: getModuleName(): Answer the name of the context-root of the application that this session is associated with.void
serverSpecificRegisterMBean()
INTERNAL: serverSpecificRegisterMBean(): Server specific implementation of the creation and deployment of the JMX MBean to provide runtime services for my databaseSession.void
serverSpecificUnregisterMBean()
INTERNAL: serverSpecificUnregisterMBean(): Server specific implementation of the de-registration of the JMX MBean from its server during session logout.void
setApplicationName(String aName)
INTERNAL:-
Methods inherited from class org.eclipse.persistence.platform.server.ServerPlatformBase
clearStatementCache, configureProfiler, disableJTA, disableRuntimeServices, enableRuntimeServices, getDatabaseSession, getExternalTransactionControllerClass, getJNDIConnectorLookupType, getNewTempClassLoader, getPartitionID, getServerLog, getServerNameAndVersion, getThreadPool, getThreadPoolSize, initializeExternalTransactionController, isCMP, isJTAEnabled, isRuntimeServicesEnabled, isRuntimeServicesEnabledDefault, launchContainerRunnable, registerMBean, setExternalTransactionControllerClass, setIsCMP, setThreadPool, setThreadPoolSize, shouldUseDriverManager, shutdown, unregisterMBean, unwrapConnection, usesPartitions, wasFailureCommunicationBased
-
-
-
-
Field Detail
-
JMX_REGISTRATION_PREFIX
public static final String JMX_REGISTRATION_PREFIX
This is the prefix for all MBeans that are registered with their specific session name appended- See Also:
- Constant Field Values
-
JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS
public static final int JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS
The default indexed MBeanServer instance to use when multiple MBeanServer instances exist on the platform - usually only in JBoss- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JMXServerPlatformBase
public JMXServerPlatformBase(DatabaseSession newDatabaseSession)
INTERNAL: Default Constructor: Initialize so that runtime services and JTA are enabled.- Parameters:
newDatabaseSession
- The instance of DatabaseSession that I am helping.
-
-
Method Detail
-
getMBeanServer
public MBeanServer getMBeanServer()
INTERNAL: Return the MBeanServer to be used for MBean registration and deregistration.
This MBeanServer reference is lazy loaded and cached on the platform.
There are multiple ways of getting the MBeanServer
1) MBeanServerFactory static function - working for 3 of 4 servers WebSphere, JBoss and Glassfish in a generic way
We are using method (1)
- JBoss returns 2 MBeanServers in the List - but one of them has a null domain - we don't use that one
- WebLogic may return 2 MBeanServers - in that case we want to register with the one containing the "com.bea" tree 2) ManagementFactory static function - what is the difference in using this one over the one returning a List of servers
3) JNDI lookup
4) Direct server specific native API- Returns:
- the JMX specification MBeanServer
-
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. Default is to do nothing. This should be subclassed if required. For platform classes that override the JMXEnabledPlatform - the services MBean is created at platform construction for use during MBean registration here.
-
serverSpecificUnregisterMBean
public void serverSpecificUnregisterMBean()
INTERNAL: serverSpecificUnregisterMBean(): Server specific implementation of the de-registration of the JMX MBean from its server during session logout.- Overrides:
serverSpecificUnregisterMBean
in classServerPlatformBase
- See Also:
ServerPlatformBase.isRuntimeServicesEnabled()
,ServerPlatformBase.disableRuntimeServices()
-
getModuleName
public String getModuleName()
INTERNAL: getModuleName(): Answer the name of the context-root of the application that this session is associated with. Answer "unknown" if there is no module name available. Default behavior is to return "unknown" - we override this behavior here for JBoss. There are 4 levels of implementation. 1) use the property override jboss.moduleName, or 2) perform a reflective jboss.work.executeThreadRuntime.getModuleName() call, or 3) extract the moduleName:persistence_unit from the server specific classloader string representation, or 3) defer to superclass - usually return "unknown"- Specified by:
getModuleName
in interfaceServerPlatform
- Overrides:
getModuleName
in classServerPlatformBase
- Returns:
- String moduleName
-
getApplicationName
public String getApplicationName()
INTERNAL: getApplicationName(): Answer the name of the module (EAR name) that this session is associated with. Answer "unknown" if there is no application name available. Default behavior is to return "unknown" There are 4 levels of implementation. 1) use the property override weblogic.applicationName, or 2) perform a reflective weblogic.work.executeThreadRuntime.getApplicationName() call, or 3) extract the moduleName:persistence_unit from the application classloader string representation, or 3) defer to this superclass - usually return "unknown"- Returns:
- String applicationName
- See Also:
JMXEnabledPlatform
-
setApplicationName
public void setApplicationName(String aName)
INTERNAL:- Parameters:
aName
-
-
-