blob: 12a75421b2d0c1b7494c8f000153019ed57bfed6 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:12 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JMXServerPlatformBase (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JMXServerPlatformBase (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/platform/server/JMXEnabledPlatform.html" title="interface in org.eclipse.persistence.platform.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/platform/server/NoServerPlatform.html" title="class in org.eclipse.persistence.platform.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/platform/server/JMXServerPlatformBase.html" target="_top">Frames</a></li>
<li><a href="JMXServerPlatformBase.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.persistence.platform.server</div>
<h2 title="Class JMXServerPlatformBase" class="title">Class JMXServerPlatformBase</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server">org.eclipse.persistence.platform.server.ServerPlatformBase</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.platform.server.JMXServerPlatformBase</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html" title="interface in org.eclipse.persistence.platform.server">ServerPlatform</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/eclipse/persistence/platform/server/glassfish/GlassfishPlatform.html" title="class in org.eclipse.persistence.platform.server.glassfish">GlassfishPlatform</a>, <a href="../../../../../org/eclipse/persistence/platform/server/jboss/JBossPlatform.html" title="class in org.eclipse.persistence.platform.server.jboss">JBossPlatform</a>, <a href="../../../../../org/eclipse/persistence/platform/server/wls/WebLogicPlatform.html" title="class in org.eclipse.persistence.platform.server.wls">WebLogicPlatform</a>, <a href="../../../../../org/eclipse/persistence/platform/server/was/WebSpherePlatform.html" title="class in org.eclipse.persistence.platform.server.was">WebSpherePlatform</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">JMXServerPlatformBase</span>
extends <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server">ServerPlatformBase</a></pre>
<div class="block">PUBLIC:
Subclass of org.eclipse.persistence.platform.server.ServerPlatformBase
in support of the JMXEnabledPlatform interface
<p>
This 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:
<ul>
<li> Whether or not to enable JTA (external transaction control)
<li> How to register/unregister for runtime services (JMX/MBean)
<li> Whether or not to enable runtime services
</ul><p>
Subclasses already exist to provide configurations for Oc4J, WebLogic, JBoss, NetWeaver, GlassFish and WebSphere.
<p>
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:
<ul>
<li>JMXEnabledPlatform.prepareServerSpecificServicesMBean()
</ul>
for the desired behavior.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server"><code>ServerPlatformBase</code></a></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EclipseLink 2.1.1</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_POSTFIX">APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_POSTFIX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_PREFIX">APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_PREFIX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#APP_SERVER_CLASSLOADER_MODULE_EJB_SEARCH_STRING_PREFIX">APP_SERVER_CLASSLOADER_MODULE_EJB_SEARCH_STRING_PREFIX</a></span></code>
<div class="block">Override by subclass: Search String in application server session for ejb modules</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#APP_SERVER_CLASSLOADER_MODULE_EJB_WAR_SEARCH_STRING_POSTFIX">APP_SERVER_CLASSLOADER_MODULE_EJB_WAR_SEARCH_STRING_POSTFIX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#APP_SERVER_CLASSLOADER_MODULE_WAR_SEARCH_STRING_PREFIX">APP_SERVER_CLASSLOADER_MODULE_WAR_SEARCH_STRING_PREFIX</a></span></code>
<div class="block">Override by subclass: Search String in application server session for war modules</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS">JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS</a></span></code>
<div class="block">The default indexed MBeanServer instance to use when multiple MBeanServer instances exist on the platform - usually only in JBoss</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#JMX_REGISTRATION_PREFIX">JMX_REGISTRATION_PREFIX</a></span></code>
<div class="block">This is the prefix for all MBeans that are registered with their specific session name appended</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanServer.html?is-external=true" title="class or interface in javax.management">MBeanServer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#mBeanServer">mBeanServer</a></span></code>
<div class="block">Cache the ServerPlatform MBeanServer for performance</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#OVERRIDE_JMX_APPLICATIONNAME_PROPERTY">OVERRIDE_JMX_APPLICATIONNAME_PROPERTY</a></span></code>
<div class="block">This persistence.xml or sessions.xml property is used to override the applicationName</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#OVERRIDE_JMX_MODULENAME_PROPERTY">OVERRIDE_JMX_MODULENAME_PROPERTY</a></span></code>
<div class="block">This persistence.xml or sessions.xml property is used to override the moduleName</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.platform.server.ServerPlatformBase">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.platform.server.<a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server">ServerPlatformBase</a></h3>
<code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#DEFAULT_SERVER_NAME_AND_VERSION">DEFAULT_SERVER_NAME_AND_VERSION</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#externalTransactionControllerClass">externalTransactionControllerClass</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#JMX_REGISTER_DEV_MBEAN_PROPERTY">JMX_REGISTER_DEV_MBEAN_PROPERTY</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#JMX_REGISTER_RUN_MBEAN_PROPERTY">JMX_REGISTER_RUN_MBEAN_PROPERTY</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#serverNameAndVersion">serverNameAndVersion</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#shouldRegisterDevelopmentBean">shouldRegisterDevelopmentBean</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#shouldRegisterRuntimeBean">shouldRegisterRuntimeBean</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#threadPool">threadPool</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#threadPoolSize">threadPoolSize</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#JMXServerPlatformBase-org.eclipse.persistence.sessions.DatabaseSession-">JMXServerPlatformBase</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/DatabaseSession.html" title="interface in org.eclipse.persistence.sessions">DatabaseSession</a>&nbsp;newDatabaseSession)</code>
<div class="block">INTERNAL:
Default Constructor: Initialize so that runtime services and JTA are enabled.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#getAbstractSession--">getAbstractSession</a></span>()</code>
<div class="block">Return the AbstractSession required to log to the non-platform EclipseLink log.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#getApplicationName--">getApplicationName</a></span>()</code>
<div class="block">INTERNAL:
getApplicationName(): Answer the name of the module (EAR name) that this session is associated with.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#getApplicationName-boolean-">getApplicationName</a></span>(boolean&nbsp;enableDefault)</code>
<div class="block">INTERNAL:
Lazy initialize the application name by
first checking for a persistence.xml property override and then
deferring to a default name in the absence of a platform override of this function</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanServer.html?is-external=true" title="class or interface in javax.management">MBeanServer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#getMBeanServer--">getMBeanServer</a></span>()</code>
<div class="block">INTERNAL:
Return the MBeanServer to be used for MBean registration and deregistration.<br>
This MBeanServer reference is lazy loaded and cached on the platform.<br>
There are multiple ways of getting the MBeanServer<br></div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#getMBeanSessionName--">getMBeanSessionName</a></span>()</code>
<div class="block">Remove JMX reserved characters from the session name</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#getModuleName--">getModuleName</a></span>()</code>
<div class="block">INTERNAL:
getModuleName(): Answer the name of the context-root of the application that this session is associated with.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#getModuleName-boolean-">getModuleName</a></span>(boolean&nbsp;enableDefault)</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/services/mbean/MBeanRuntimeServicesMBean.html" title="interface in org.eclipse.persistence.services.mbean">MBeanRuntimeServicesMBean</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#getRuntimeServicesMBean--">getRuntimeServicesMBean</a></span>()</code>
<div class="block">INTERNAL:
Return the cached server specific services MBean</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#initializeApplicationNameAndModuleName--">initializeApplicationNameAndModuleName</a></span>()</code>
<div class="block">INTERNAL:
Get the applicationName and moduleName from the application server.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#serverSpecificRegisterMBean--">serverSpecificRegisterMBean</a></span>()</code>
<div class="block">INTERNAL: serverSpecificRegisterMBean(): Server specific implementation of the
creation and deployment of the JMX MBean to provide runtime services for my
databaseSession.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#serverSpecificUnregisterMBean--">serverSpecificUnregisterMBean</a></span>()</code>
<div class="block">INTERNAL:
serverSpecificUnregisterMBean(): Server specific implementation of the
de-registration of the JMX MBean from its server during session logout.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#setApplicationName-java.lang.String-">setApplicationName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;aName)</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#setModuleName-java.lang.String-">setModuleName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;aName)</code>
<div class="block">INTERNAL;</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html#setRuntimeServicesMBean-org.eclipse.persistence.services.mbean.MBeanRuntimeServicesMBean-">setRuntimeServicesMBean</a></span>(<a href="../../../../../org/eclipse/persistence/services/mbean/MBeanRuntimeServicesMBean.html" title="interface in org.eclipse.persistence.services.mbean">MBeanRuntimeServicesMBean</a>&nbsp;runtimeServicesMBean)</code>
<div class="block">INTERNAL:
Set the cached server specific services MBean</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.platform.server.ServerPlatformBase">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.platform.server.<a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server">ServerPlatformBase</a></h3>
<code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#clearStatementCache-java.sql.Connection-">clearStatementCache</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#configureProfiler-org.eclipse.persistence.sessions.Session-">configureProfiler</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#disableJTA--">disableJTA</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#disableRuntimeServices--">disableRuntimeServices</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#enableRuntimeServices--">enableRuntimeServices</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#ensureNotLoggedIn--">ensureNotLoggedIn</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#externalTransactionControllerNotNullWarning--">externalTransactionControllerNotNullWarning</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getDatabaseSession--">getDatabaseSession</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getExternalTransactionControllerClass--">getExternalTransactionControllerClass</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getJNDIConnectorLookupType--">getJNDIConnectorLookupType</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getNewTempClassLoader-jakarta.persistence.spi.PersistenceUnitInfo-">getNewTempClassLoader</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getPartitionID--">getPartitionID</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getServerLog--">getServerLog</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getServerNameAndVersion--">getServerNameAndVersion</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getThreadPool--">getThreadPool</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getThreadPoolSize--">getThreadPoolSize</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#initializeExternalTransactionController--">initializeExternalTransactionController</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#initializeServerNameAndVersion--">initializeServerNameAndVersion</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#isCMP--">isCMP</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#isJTA11--">isJTA11</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#isJTAEnabled--">isJTAEnabled</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#isRuntimeServicesEnabled--">isRuntimeServicesEnabled</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#isRuntimeServicesEnabledDefault--">isRuntimeServicesEnabledDefault</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#launchContainerRunnable-java.lang.Runnable-">launchContainerRunnable</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#registerMBean--">registerMBean</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#setExternalTransactionControllerClass-java.lang.Class-">setExternalTransactionControllerClass</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#setIsCMP-boolean-">setIsCMP</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#setThreadPool-java.util.concurrent.ExecutorService-">setThreadPool</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#setThreadPoolSize-int-">setThreadPoolSize</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#shouldUseDriverManager--">shouldUseDriverManager</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#shutdown--">shutdown</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#unregisterMBean--">unregisterMBean</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#unwrapConnection-java.sql.Connection-">unwrapConnection</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#usesPartitions--">usesPartitions</a>, <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#wasFailureCommunicationBased-java.sql.SQLException-org.eclipse.persistence.internal.databaseaccess.Accessor-org.eclipse.persistence.internal.sessions.AbstractSession-">wasFailureCommunicationBased</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="JMX_REGISTRATION_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JMX_REGISTRATION_PREFIX</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> JMX_REGISTRATION_PREFIX</pre>
<div class="block">This is the prefix for all MBeans that are registered with their specific session name appended</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.platform.server.JMXServerPlatformBase.JMX_REGISTRATION_PREFIX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS</h4>
<pre>public static final&nbsp;int JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS</pre>
<div class="block">The default indexed MBeanServer instance to use when multiple MBeanServer instances exist on the platform - usually only in JBoss</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.platform.server.JMXServerPlatformBase.JMX_MBEANSERVER_INDEX_DEFAULT_FOR_MULTIPLE_SERVERS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OVERRIDE_JMX_MODULENAME_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OVERRIDE_JMX_MODULENAME_PROPERTY</h4>
<pre>protected static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OVERRIDE_JMX_MODULENAME_PROPERTY</pre>
<div class="block">This persistence.xml or sessions.xml property is used to override the moduleName</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.platform.server.JMXServerPlatformBase.OVERRIDE_JMX_MODULENAME_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OVERRIDE_JMX_APPLICATIONNAME_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OVERRIDE_JMX_APPLICATIONNAME_PROPERTY</h4>
<pre>protected static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OVERRIDE_JMX_APPLICATIONNAME_PROPERTY</pre>
<div class="block">This persistence.xml or sessions.xml property is used to override the applicationName</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.platform.server.JMXServerPlatformBase.OVERRIDE_JMX_APPLICATIONNAME_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_PREFIX</h4>
<pre>protected static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_PREFIX</pre>
</li>
</ul>
<a name="APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_POSTFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_POSTFIX</h4>
<pre>protected static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> APP_SERVER_CLASSLOADER_APPLICATION_PU_SEARCH_STRING_POSTFIX</pre>
</li>
</ul>
<a name="APP_SERVER_CLASSLOADER_MODULE_EJB_SEARCH_STRING_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APP_SERVER_CLASSLOADER_MODULE_EJB_SEARCH_STRING_PREFIX</h4>
<pre>protected static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> APP_SERVER_CLASSLOADER_MODULE_EJB_SEARCH_STRING_PREFIX</pre>
<div class="block">Override by subclass: Search String in application server session for ejb modules</div>
</li>
</ul>
<a name="APP_SERVER_CLASSLOADER_MODULE_WAR_SEARCH_STRING_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APP_SERVER_CLASSLOADER_MODULE_WAR_SEARCH_STRING_PREFIX</h4>
<pre>protected static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> APP_SERVER_CLASSLOADER_MODULE_WAR_SEARCH_STRING_PREFIX</pre>
<div class="block">Override by subclass: Search String in application server session for war modules</div>
</li>
</ul>
<a name="APP_SERVER_CLASSLOADER_MODULE_EJB_WAR_SEARCH_STRING_POSTFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>APP_SERVER_CLASSLOADER_MODULE_EJB_WAR_SEARCH_STRING_POSTFIX</h4>
<pre>protected static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> APP_SERVER_CLASSLOADER_MODULE_EJB_WAR_SEARCH_STRING_POSTFIX</pre>
</li>
</ul>
<a name="mBeanServer">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mBeanServer</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanServer.html?is-external=true" title="class or interface in javax.management">MBeanServer</a> mBeanServer</pre>
<div class="block">Cache the ServerPlatform MBeanServer for performance</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JMXServerPlatformBase-org.eclipse.persistence.sessions.DatabaseSession-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JMXServerPlatformBase</h4>
<pre>public&nbsp;JMXServerPlatformBase(<a href="../../../../../org/eclipse/persistence/sessions/DatabaseSession.html" title="interface in org.eclipse.persistence.sessions">DatabaseSession</a>&nbsp;newDatabaseSession)</pre>
<div class="block">INTERNAL:
Default Constructor: Initialize so that runtime services and JTA are enabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newDatabaseSession</code> - The instance of DatabaseSession that I am helping.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAbstractSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbstractSession</h4>
<pre>protected&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;getAbstractSession()</pre>
<div class="block">Return the AbstractSession required to log to the non-platform EclipseLink log.
Note: The WeblogicEclipseLinkLog defined for the WebLogic platform currently only supports the following
logging categories in the categoryMap HashMap
{connection=DebugJpaJdbcJdbc,
cache=DebugJpaDataCache,
transaction=DebugJpaJdbcJdbc,
weaver=DebugJpaEnhance,
query=DebugJpaQuery,
dms=DebugJpaProfile,
sequencing=DebugJpaRuntime,
properties=DebugJpaRuntime,
ejb=DebugJpaRuntime,
jpa_metamodel=DebugJpaMetaData,
sql=DebugJpaJdbcSql,
ejb_or_metadata=DebugJpaMetaData,
event=DebugJpaRuntime,
server=DebugJpaRuntime,
propagation=DebugJpaDataCache}</div>
</li>
</ul>
<a name="getMBeanServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMBeanServer</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanServer.html?is-external=true" title="class or interface in javax.management">MBeanServer</a>&nbsp;getMBeanServer()</pre>
<div class="block">INTERNAL:
Return the MBeanServer to be used for MBean registration and deregistration.<br>
This MBeanServer reference is lazy loaded and cached on the platform.<br>
There are multiple ways of getting the MBeanServer<br>
<p>
1) MBeanServerFactory static function - working for 3 of 4 servers WebSphere, JBoss and Glassfish in a generic way<br>
- JBoss returns 2 MBeanServers in the List - but one of them has a null domain - we don't use that one<br>
- 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<br>
3) JNDI lookup<br>
4) Direct server specific native API<br></p>
We are using method (1)<br></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the JMX specification MBeanServer</dd>
</dl>
</li>
</ul>
<a name="serverSpecificRegisterMBean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serverSpecificRegisterMBean</h4>
<pre>public&nbsp;void&nbsp;serverSpecificRegisterMBean()</pre>
<div class="block">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.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#serverSpecificRegisterMBean--">serverSpecificRegisterMBean</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server">ServerPlatformBase</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#isRuntimeServicesEnabled--"><code>ServerPlatformBase.isRuntimeServicesEnabled()</code></a>,
<a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#disableRuntimeServices--"><code>ServerPlatformBase.disableRuntimeServices()</code></a>,
<a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#registerMBean--"><code>ServerPlatformBase.registerMBean()</code></a></dd>
</dl>
</li>
</ul>
<a name="serverSpecificUnregisterMBean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serverSpecificUnregisterMBean</h4>
<pre>public&nbsp;void&nbsp;serverSpecificUnregisterMBean()</pre>
<div class="block">INTERNAL:
serverSpecificUnregisterMBean(): Server specific implementation of the
de-registration of the JMX MBean from its server during session logout.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#serverSpecificUnregisterMBean--">serverSpecificUnregisterMBean</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server">ServerPlatformBase</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#isRuntimeServicesEnabled--"><code>ServerPlatformBase.isRuntimeServicesEnabled()</code></a>,
<a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#disableRuntimeServices--"><code>ServerPlatformBase.disableRuntimeServices()</code></a></dd>
</dl>
</li>
</ul>
<a name="getMBeanSessionName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMBeanSessionName</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getMBeanSessionName()</pre>
<div class="block">Remove JMX reserved characters from the session name</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getRuntimeServicesMBean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRuntimeServicesMBean</h4>
<pre>protected&nbsp;<a href="../../../../../org/eclipse/persistence/services/mbean/MBeanRuntimeServicesMBean.html" title="interface in org.eclipse.persistence.services.mbean">MBeanRuntimeServicesMBean</a>&nbsp;getRuntimeServicesMBean()</pre>
<div class="block">INTERNAL:
Return the cached server specific services MBean</div>
</li>
</ul>
<a name="setRuntimeServicesMBean-org.eclipse.persistence.services.mbean.MBeanRuntimeServicesMBean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRuntimeServicesMBean</h4>
<pre>protected&nbsp;void&nbsp;setRuntimeServicesMBean(<a href="../../../../../org/eclipse/persistence/services/mbean/MBeanRuntimeServicesMBean.html" title="interface in org.eclipse.persistence.services.mbean">MBeanRuntimeServicesMBean</a>&nbsp;runtimeServicesMBean)</pre>
<div class="block">INTERNAL:
Set the cached server specific services MBean</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runtimeServicesMBean</code> - </dd>
</dl>
</li>
</ul>
<a name="getModuleName-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModuleName</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getModuleName(boolean&nbsp;enableDefault)</pre>
<div class="block">INTERNAL:</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enableDefault</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getModuleName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModuleName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getModuleName()</pre>
<div class="block">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"</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html#getModuleName--">getModuleName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html" title="interface in org.eclipse.persistence.platform.server">ServerPlatform</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html#getModuleName--">getModuleName</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server">ServerPlatformBase</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String moduleName</dd>
</dl>
</li>
</ul>
<a name="setModuleName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setModuleName</h4>
<pre>protected&nbsp;void&nbsp;setModuleName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;aName)</pre>
<div class="block">INTERNAL;</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>aName</code> - </dd>
</dl>
</li>
</ul>
<a name="getApplicationName-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationName</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getApplicationName(boolean&nbsp;enableDefault)</pre>
<div class="block">INTERNAL:
Lazy initialize the application name by
first checking for a persistence.xml property override and then
deferring to a default name in the absence of a platform override of this function</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enableDefault</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getApplicationName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getApplicationName()</pre>
<div class="block">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"</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String applicationName</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/platform/server/JMXEnabledPlatform.html" title="interface in org.eclipse.persistence.platform.server"><code>JMXEnabledPlatform</code></a></dd>
</dl>
</li>
</ul>
<a name="setApplicationName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setApplicationName</h4>
<pre>public&nbsp;void&nbsp;setApplicationName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;aName)</pre>
<div class="block">INTERNAL:</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>aName</code> - </dd>
</dl>
</li>
</ul>
<a name="initializeApplicationNameAndModuleName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>initializeApplicationNameAndModuleName</h4>
<pre>protected&nbsp;void&nbsp;initializeApplicationNameAndModuleName()</pre>
<div class="block">INTERNAL:
Get the applicationName and moduleName from the application server.
This function does not use reflective API on the application server, instead it parses
the database session name for the module name, and
the classLoader (from the Platform.conversionManager) toString() for the application name.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/platform/server/JMXEnabledPlatform.html" title="interface in org.eclipse.persistence.platform.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/platform/server/NoServerPlatform.html" title="class in org.eclipse.persistence.platform.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/platform/server/JMXServerPlatformBase.html" target="_top">Frames</a></li>
<li><a href="JMXServerPlatformBase.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>