| <!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>JMXEnabledPlatform (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="JMXEnabledPlatform (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/CustomServerPlatform.html" title="class in org.eclipse.persistence.platform.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/platform/server/JMXEnabledPlatform.html" target="_top">Frames</a></li> |
| <li><a href="JMXEnabledPlatform.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface JMXEnabledPlatform" class="title">Interface JMXEnabledPlatform</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</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/WebLogic_10_Platform.html" title="class in org.eclipse.persistence.platform.server.wls">WebLogic_10_Platform</a>, <a href="../../../../../org/eclipse/persistence/platform/server/wls/WebLogic_12_Platform.html" title="class in org.eclipse.persistence.platform.server.wls">WebLogic_12_Platform</a>, <a href="../../../../../org/eclipse/persistence/platform/server/was/WebSphere_7_Platform.html" title="class in org.eclipse.persistence.platform.server.was">WebSphere_7_Platform</a>, <a href="../../../../../org/eclipse/persistence/platform/server/was/WebSphere_EJBEmbeddable_Platform.html" title="class in org.eclipse.persistence.platform.server.was">WebSphere_EJBEmbeddable_Platform</a>, <a href="../../../../../org/eclipse/persistence/platform/server/was/WebSphere_Liberty_Platform.html" title="class in org.eclipse.persistence.platform.server.was">WebSphere_Liberty_Platform</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">JMXEnabledPlatform</span></pre> |
| <div class="block">PUBLIC: |
| This interface must be implemented by server platform classes that have |
| JMX/MBean functionality enabled in EclipseLink.<br> |
| As of EclipseLink</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server"><code>JMXServerPlatformBase</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"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><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/JMXEnabledPlatform.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="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/platform/server/JMXEnabledPlatform.html#prepareServerSpecificServicesMBean--">prepareServerSpecificServicesMBean</a></span>()</code> |
| <div class="block">INTERNAL: |
| prepareServerSpecificServicesMBean(): Server specific implementation of the |
| creation and deployment of the JMX MBean to provide runtime services for the |
| databaseSession.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="prepareServerSpecificServicesMBean--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareServerSpecificServicesMBean</h4> |
| <pre>void prepareServerSpecificServicesMBean()</pre> |
| <div class="block">INTERNAL: |
| prepareServerSpecificServicesMBean(): Server specific implementation of the |
| creation and deployment of the JMX MBean to provide runtime services for the |
| databaseSession. |
| |
| JMX Implementing platform classes must override this function and supply |
| the server specific MBean instance for later registration by calling it in the constructor.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html#isRuntimeServicesEnabledDefault--"><code>ServerPlatform.isRuntimeServicesEnabledDefault()</code></a>, |
| <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html#isRuntimeServicesEnabled--"><code>ServerPlatform.isRuntimeServicesEnabled()</code></a>, |
| <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html#disableRuntimeServices--"><code>ServerPlatform.disableRuntimeServices()</code></a>, |
| <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html#registerMBean--"><code>ServerPlatform.registerMBean()</code></a></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EclipseLink 2.1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getApplicationName--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getApplicationName</h4> |
| <pre><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> 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|jboss|glassfish|websphere.applicationName, or |
| 2) perform a reflective weblogic.work.executeThreadRuntime.getApplicationName() call on WebLogic for example |
| 3) extract the moduleName:persistence_unit from the weblogic classloader string representation, or |
| 3) defer to superclass - usually return "unknown"</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String applicationName</dd> |
| </dl> |
| </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/CustomServerPlatform.html" title="class in org.eclipse.persistence.platform.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/platform/server/JMXServerPlatformBase.html" title="class in org.eclipse.persistence.platform.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/platform/server/JMXEnabledPlatform.html" target="_top">Frames</a></li> |
| <li><a href="JMXEnabledPlatform.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
