| <!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:07 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RemoteCommandManager (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="RemoteCommandManager (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,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":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/sessions/coordination/MetadataRefreshListener.html" title="interface in org.eclipse.persistence.sessions.coordination"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/coordination/ServiceId.html" title="class in org.eclipse.persistence.sessions.coordination"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html" target="_top">Frames</a></li> |
| <li><a href="RemoteCommandManager.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.sessions.coordination</div> |
| <h2 title="Class RemoteCommandManager" class="title">Class RemoteCommandManager</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>org.eclipse.persistence.sessions.coordination.RemoteCommandManager</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/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RemoteCommandManager</span> |
| extends <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> |
| implements <a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></pre> |
| <div class="block"><p> |
| <b>Purpose</b>: Provide a CommandManager implementation for cache coordination. |
| <p> |
| <b>Description</b>: A RemoteCommandManager (or RCM) instance is the primary component |
| of an RCM service instance. It manages the other components of the service, and |
| directs the overall service operation. Its ServiceId uniquely distinguishes it |
| from other service instances in the cluster. |
| <p> |
| Each RCM has a logical channel to which it subscribes and publishes. This channel |
| determines which other instances in the cluster the service instance sends and |
| receives remote commands to/from. All RCM's on the same channel should have the same |
| discovery manager settings (be communicating on the same multicast) so that |
| the discovery managers may be able to discover one another. RCM's on different |
| channels may operate on the same or on different multicast groups. |
| <p> |
| An RCM instance knows about other instances in the cluster through its DiscoveryManager. |
| Its TransportManager is responsible for setting up the connections to other instances |
| once they are discovered. |
| <p> |
| An RCM is instructed to "propagate", or execute on all remote service instances |
| in the cluster that subscribe to the same channel, a remote command by its |
| CommandProcessor. Likewise, when an RCM receives a remote command to be executed |
| then it passes the command off to the CommandProcessor for the processing of the |
| command to occur. CommandProcessors pass commands to the RCM as an Object (in a |
| format that may be specific to the application) and the RCM uses its CommandConverter |
| to convert it to a EclipseLink Command object before sending the Command off to the |
| cluster. Similarly, when a EclipseLink Command object is received then the RCM invokes |
| its CommandConverter to convert the object into the application format that will be |
| passed to the CommandProcessor to process the command.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination"><code>CommandManager</code></a>, |
| <a href="../../../../../org/eclipse/persistence/sessions/coordination/Command.html" title="class in org.eclipse.persistence.sessions.coordination"><code>Command</code></a>, |
| <a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination"><code>CommandProcessor</code></a>, |
| <a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination"><code>CommandConverter</code></a>, |
| <a href="../../../../../org/eclipse/persistence/sessions/coordination/DiscoveryManager.html" title="class in org.eclipse.persistence.sessions.coordination"><code>DiscoveryManager</code></a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Steven Vo</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>OracleAS TopLink 10<i>g</i> (9.0.4)</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"> </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 <a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandConverter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#commandConverter">commandConverter</a></span></code> |
| <div class="block">Used for converting commands between EclipseLink Command and app command formats</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#commandProcessor">commandProcessor</a></span></code> |
| <div class="block">Invoked to process a command when it is received from the cluster</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#DEFAULT_ASYNCHRONOUS_MODE">DEFAULT_ASYNCHRONOUS_MODE</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/sessions/coordination/RemoteCommandManager.html#DEFAULT_CHANNEL">DEFAULT_CHANNEL</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/sessions/coordination/DiscoveryManager.html" title="class in org.eclipse.persistence.sessions.coordination">DiscoveryManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#discoveryManager">discoveryManager</a></span></code> |
| <div class="block">Manages the detection of new services as they join the cluster</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#isAsynchronous">isAsynchronous</a></span></code> |
| <div class="block">Determines whether propagation should be synchronous or asynchronous</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#isEclipseLinkSession">isEclipseLinkSession</a></span></code> |
| <div class="block">Determines whether profiling command should be send</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#isStopped">isStopped</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/sessions/serializers/Serializer.html" title="interface in org.eclipse.persistence.sessions.serializers">Serializer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#serializer">serializer</a></span></code> |
| <div class="block">Set the Serializer to use for serialization of commands.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html" title="interface in org.eclipse.persistence.platform.server">ServerPlatform</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#serverPlatform">serverPlatform</a></span></code> |
| <div class="block">Uniquely identifies ServerPlatform in the cluster</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/sessions/coordination/ServiceId.html" title="class in org.eclipse.persistence.sessions.coordination">ServiceId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#serviceId">serviceId</a></span></code> |
| <div class="block">Uniquely identifies this service in the cluster</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#transportManager">transportManager</a></span></code> |
| <div class="block">Manages the transport level connections between command managers</div> |
| </td> |
| </tr> |
| </table> |
| </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"> </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/sessions/coordination/RemoteCommandManager.html#RemoteCommandManager-org.eclipse.persistence.sessions.coordination.CommandProcessor-">RemoteCommandManager</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a> commandProcessor)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#RemoteCommandManager-org.eclipse.persistence.sessions.coordination.CommandProcessor-org.eclipse.persistence.sessions.coordination.TransportManager-">RemoteCommandManager</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a> commandProcessor, |
| <a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a> transportManager)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/sessions/coordination/RemoteCommandManager.html#getChannel--">getChannel</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the service channel for this command manager.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandConverter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#getCommandConverter--">getCommandConverter</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the converter instance used to convert between EclipseLink Command |
| objects and an application command format.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#getCommandProcessor--">getCommandProcessor</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the command processor that processes commands received from the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/DiscoveryManager.html" title="class in org.eclipse.persistence.sessions.coordination">DiscoveryManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#getDiscoveryManager--">getDiscoveryManager</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the discovery manager that detects the arrival of new cluster members</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/sessions/serializers/Serializer.html" title="interface in org.eclipse.persistence.sessions.serializers">Serializer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#getSerializer--">getSerializer</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the Serializer to use for serialization of commands.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html" title="interface in org.eclipse.persistence.platform.server">ServerPlatform</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#getServerPlatform--">getServerPlatform</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the serverPlatform that identifies the application server</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/ServiceId.html" title="class in org.eclipse.persistence.sessions.coordination">ServiceId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#getServiceId--">getServiceId</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the service info that identifies this service instance</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#getTransportManager--">getTransportManager</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the transport manager that manages sending and receiving of remote commands.</div> |
| </td> |
| </tr> |
| <tr id="i8" 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/sessions/coordination/RemoteCommandManager.html#getUrl--">getUrl</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the URL for this command manager.</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/sessions/coordination/RemoteCommandManager.html#handleException-java.lang.RuntimeException-">handleException</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a> exception)</code> |
| <div class="block">INTERNAL: |
| Delegate to the command procesor to handle the exception.</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/sessions/coordination/RemoteCommandManager.html#initialize--">initialize</a></span>()</code> |
| <div class="block">PUBLIC: |
| Initialize the remote command manager.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#isCommandProcessorASession--">isCommandProcessorASession</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return whether this command manager should process profile commands</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#isStopped--">isStopped</a></span>()</code> |
| <div class="block">PUBLIC: |
| Indicates whether the RCM has been stopped: |
| either initialize hasn't been called or shutdown has been called.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#logDebug-java.lang.String-java.lang.Object:A-">logDebug</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> message, |
| <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>[] args)</code> |
| <div class="block">INTERNAL: |
| Convenience logging methods.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#logDebugWithoutLevelCheck-java.lang.String-java.lang.Object:A-">logDebugWithoutLevelCheck</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> message, |
| <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>[] args)</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#logError-java.lang.String-java.lang.Object:A-">logError</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> message, |
| <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>[] args)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#logInfo-java.lang.String-java.lang.Object:A-">logInfo</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> message, |
| <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>[] args)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#logMessage-int-java.lang.String-java.lang.Object:A-">logMessage</a></span>(int logLevel, |
| <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> message, |
| <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>[] args)</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#logMessageWithoutLevelCheck-int-java.lang.String-java.lang.Object:A-">logMessageWithoutLevelCheck</a></span>(int logLevel, |
| <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> message, |
| <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>[] args)</code> |
| <div class="block">INTERNAL: |
| Use this method in case the necessary logLevel has been confirmed |
| by calling commandProcessor.shouldLogMessages method</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#logWarning-java.lang.String-java.lang.Object:A-">logWarning</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> message, |
| <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>[] args)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#logWarningWithoutLevelCheck-java.lang.String-java.lang.Object:A-">logWarningWithoutLevelCheck</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> message, |
| <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>[] args)</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#newServiceDiscovered-org.eclipse.persistence.sessions.coordination.ServiceId-">newServiceDiscovered</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/coordination/ServiceId.html" title="class in org.eclipse.persistence.sessions.coordination">ServiceId</a> service)</code> |
| <div class="block">INTERNAL: |
| A new service has been detected by the discovery manager.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#processCommandFromRemoteConnection-byte:A-">processCommandFromRemoteConnection</a></span>(byte[] commandBytes)</code> |
| <div class="block">INTERNAL: |
| Deserialize the command and execute it.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#processCommandFromRemoteConnection-org.eclipse.persistence.sessions.coordination.Command-">processCommandFromRemoteConnection</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/coordination/Command.html" title="class in org.eclipse.persistence.sessions.coordination">Command</a> command)</code> |
| <div class="block">INTERNAL: |
| Delegate to command processor</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#propagateCommand-java.lang.Object-">propagateCommand</a></span>(<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> command)</code> |
| <div class="block">ADVANCED: |
| Propagate a remote command to all remote RCM services participating |
| in the EclipseLink cluster.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#replaceLocalHostIPAddress-java.lang.String-">replaceLocalHostIPAddress</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> ipAddress)</code> |
| <div class="block">ADVANCED: |
| Allow user to replace the $HOST subString of the local host URL with the user user input at runtime.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#replaceTransportPortNumber-java.lang.String-">replaceTransportPortNumber</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> portNumber)</code> |
| <div class="block">ADVANCED: |
| Allow user to replace the $PORT subString of the local host URL with the user user input at runtime.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#setChannel-java.lang.String-">setChannel</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> channel)</code> |
| <div class="block">ADVANCED: |
| Set the service channel for this command manager.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#setCommandConverter-org.eclipse.persistence.sessions.coordination.CommandConverter-">setCommandConverter</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandConverter</a> newCommandConverter)</code> |
| <div class="block">ADVANCED: |
| Set the converter instance that will be invoked by this CommandProcessor |
| to convert commands from their application command format into EclipseLink |
| Command objects before being propagated to remote command manager services.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#setCommandProcessor-org.eclipse.persistence.sessions.coordination.CommandProcessor-">setCommandProcessor</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a> newCommandProcessor)</code> |
| <div class="block">ADVANCED: |
| Set the command processor that will be invoked to process commands.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#setSerializer-org.eclipse.persistence.sessions.serializers.Serializer-">setSerializer</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/serializers/Serializer.html" title="interface in org.eclipse.persistence.sessions.serializers">Serializer</a> serializer)</code> |
| <div class="block">PUBLIC: |
| Set the Serializer to use for serialization of commands.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#setServerPlatform-org.eclipse.persistence.platform.server.ServerPlatform-">setServerPlatform</a></span>(<a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html" title="interface in org.eclipse.persistence.platform.server">ServerPlatform</a> theServerPlatform)</code> |
| <div class="block">PUBLIC: |
| The ServerPlatform must be set manually when the RemoteCommandManager'CommandProcessor is not EclipseLink Session.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#setShouldPropagateAsynchronously-boolean-">setShouldPropagateAsynchronously</a></span>(boolean asyncMode)</code> |
| <div class="block">ADVANCED: |
| Set whether this command manager should propagate commands |
| synchronously or asynchronously.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#setTransportManager-org.eclipse.persistence.sessions.coordination.TransportManager-">setTransportManager</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a> newTransportManager)</code> |
| <div class="block">ADVANCED: |
| Set a specific transport manager to manage sending and receiving of remote commands.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#setUrl-java.lang.String-">setUrl</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> url)</code> |
| <div class="block">ADVANCED: |
| Set the URL for this command manager.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#shouldLogDebugMessage--">shouldLogDebugMessage</a></span>()</code> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#shouldLogMessage-int-">shouldLogMessage</a></span>(int logLevel)</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#shouldLogWarningMessage--">shouldLogWarningMessage</a></span>()</code> </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#shouldPropagateAsynchronously--">shouldPropagateAsynchronously</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return whether this command manager should propagate commands |
| synchronously or asynchronously.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html#shutdown--">shutdown</a></span>()</code> |
| <div class="block">PUBLIC: |
| Shut down the remote command manager.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="DEFAULT_CHANNEL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_CHANNEL</h4> |
| <pre>public static final <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> DEFAULT_CHANNEL</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.persistence.sessions.coordination.RemoteCommandManager.DEFAULT_CHANNEL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_ASYNCHRONOUS_MODE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_ASYNCHRONOUS_MODE</h4> |
| <pre>public static final boolean DEFAULT_ASYNCHRONOUS_MODE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.persistence.sessions.coordination.RemoteCommandManager.DEFAULT_ASYNCHRONOUS_MODE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="serviceId"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serviceId</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/sessions/coordination/ServiceId.html" title="class in org.eclipse.persistence.sessions.coordination">ServiceId</a> serviceId</pre> |
| <div class="block">Uniquely identifies this service in the cluster</div> |
| </li> |
| </ul> |
| <a name="discoveryManager"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>discoveryManager</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/sessions/coordination/DiscoveryManager.html" title="class in org.eclipse.persistence.sessions.coordination">DiscoveryManager</a> discoveryManager</pre> |
| <div class="block">Manages the detection of new services as they join the cluster</div> |
| </li> |
| </ul> |
| <a name="transportManager"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transportManager</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a> transportManager</pre> |
| <div class="block">Manages the transport level connections between command managers</div> |
| </li> |
| </ul> |
| <a name="commandProcessor"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commandProcessor</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a> commandProcessor</pre> |
| <div class="block">Invoked to process a command when it is received from the cluster</div> |
| </li> |
| </ul> |
| <a name="commandConverter"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commandConverter</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandConverter</a> commandConverter</pre> |
| <div class="block">Used for converting commands between EclipseLink Command and app command formats</div> |
| </li> |
| </ul> |
| <a name="isAsynchronous"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAsynchronous</h4> |
| <pre>protected boolean isAsynchronous</pre> |
| <div class="block">Determines whether propagation should be synchronous or asynchronous</div> |
| </li> |
| </ul> |
| <a name="isEclipseLinkSession"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEclipseLinkSession</h4> |
| <pre>protected boolean isEclipseLinkSession</pre> |
| <div class="block">Determines whether profiling command should be send</div> |
| </li> |
| </ul> |
| <a name="serverPlatform"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serverPlatform</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html" title="interface in org.eclipse.persistence.platform.server">ServerPlatform</a> serverPlatform</pre> |
| <div class="block">Uniquely identifies ServerPlatform in the cluster</div> |
| </li> |
| </ul> |
| <a name="serializer"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serializer</h4> |
| <pre>protected <a href="../../../../../org/eclipse/persistence/sessions/serializers/Serializer.html" title="interface in org.eclipse.persistence.sessions.serializers">Serializer</a> serializer</pre> |
| <div class="block">Set the Serializer to use for serialization of commands.</div> |
| </li> |
| </ul> |
| <a name="isStopped"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isStopped</h4> |
| <pre>protected boolean isStopped</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="RemoteCommandManager-org.eclipse.persistence.sessions.coordination.CommandProcessor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RemoteCommandManager</h4> |
| <pre>public RemoteCommandManager(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a> commandProcessor)</pre> |
| </li> |
| </ul> |
| <a name="RemoteCommandManager-org.eclipse.persistence.sessions.coordination.CommandProcessor-org.eclipse.persistence.sessions.coordination.TransportManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RemoteCommandManager</h4> |
| <pre>public RemoteCommandManager(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a> commandProcessor, |
| <a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a> transportManager)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="initialize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize()</pre> |
| <div class="block">PUBLIC: |
| Initialize the remote command manager. This will also trigger the |
| DiscoveryManager to start establishing the EclipseLink cluster.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#initialize--">initialize</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isStopped--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStopped</h4> |
| <pre>public boolean isStopped()</pre> |
| <div class="block">PUBLIC: |
| Indicates whether the RCM has been stopped: |
| either initialize hasn't been called or shutdown has been called.</div> |
| </li> |
| </ul> |
| <a name="shutdown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>public void shutdown()</pre> |
| <div class="block">PUBLIC: |
| Shut down the remote command manager. This will also trigger the |
| DiscoveryManager to stop. |
| NOTE: Although this call initiates the shutdown process, |
| no guarantees are made as to when it will actually complete.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#shutdown--">shutdown</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="propagateCommand-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>propagateCommand</h4> |
| <pre>public void propagateCommand(<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> command)</pre> |
| <div class="block">ADVANCED: |
| Propagate a remote command to all remote RCM services participating |
| in the EclipseLink cluster.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#propagateCommand-java.lang.Object-">propagateCommand</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - An object representing a EclipseLink command</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="processCommandFromRemoteConnection-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processCommandFromRemoteConnection</h4> |
| <pre>public void processCommandFromRemoteConnection(byte[] commandBytes)</pre> |
| <div class="block">INTERNAL: |
| Deserialize the command and execute it.</div> |
| </li> |
| </ul> |
| <a name="processCommandFromRemoteConnection-org.eclipse.persistence.sessions.coordination.Command-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processCommandFromRemoteConnection</h4> |
| <pre>public void processCommandFromRemoteConnection(<a href="../../../../../org/eclipse/persistence/sessions/coordination/Command.html" title="class in org.eclipse.persistence.sessions.coordination">Command</a> command)</pre> |
| <div class="block">INTERNAL: |
| Delegate to command processor</div> |
| </li> |
| </ul> |
| <a name="getCommandProcessor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCommandProcessor</h4> |
| <pre>public <a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a> getCommandProcessor()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#getCommandProcessor--">CommandManager</a></code></span></div> |
| <div class="block">PUBLIC: |
| Return the command processor that processes commands received from the cluster.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#getCommandProcessor--">getCommandProcessor</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An implementation instance of CommandProcessor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCommandProcessor-org.eclipse.persistence.sessions.coordination.CommandProcessor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCommandProcessor</h4> |
| <pre>public void setCommandProcessor(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a> newCommandProcessor)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#setCommandProcessor-org.eclipse.persistence.sessions.coordination.CommandProcessor-">CommandManager</a></code></span></div> |
| <div class="block">ADVANCED: |
| Set the command processor that will be invoked to process commands. EclipseLink |
| applications can implement this interface in order to receive remote commands |
| from a EclipseLink cluster.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#setCommandProcessor-org.eclipse.persistence.sessions.coordination.CommandProcessor-">setCommandProcessor</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newCommandProcessor</code> - The intended processor of remote commands</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransportManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransportManager</h4> |
| <pre>public <a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a> getTransportManager()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#getTransportManager--">CommandManager</a></code></span></div> |
| <div class="block">PUBLIC: |
| Return the transport manager that manages sending and receiving of remote commands.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#getTransportManager--">getTransportManager</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The TransportManager instance being used by this CommandManager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTransportManager-org.eclipse.persistence.sessions.coordination.TransportManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTransportManager</h4> |
| <pre>public void setTransportManager(<a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a> newTransportManager)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#setTransportManager-org.eclipse.persistence.sessions.coordination.TransportManager-">CommandManager</a></code></span></div> |
| <div class="block">ADVANCED: |
| Set a specific transport manager to manage sending and receiving of remote commands.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#setTransportManager-org.eclipse.persistence.sessions.coordination.TransportManager-">setTransportManager</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newTransportManager</code> - An instance of the desired transport manager type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handleException-java.lang.RuntimeException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleException</h4> |
| <pre>public void handleException(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a> exception)</pre> |
| <div class="block">INTERNAL: |
| Delegate to the command procesor to handle the exception.</div> |
| </li> |
| </ul> |
| <a name="newServiceDiscovered-org.eclipse.persistence.sessions.coordination.ServiceId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newServiceDiscovered</h4> |
| <pre>public void newServiceDiscovered(<a href="../../../../../org/eclipse/persistence/sessions/coordination/ServiceId.html" title="class in org.eclipse.persistence.sessions.coordination">ServiceId</a> service)</pre> |
| <div class="block">INTERNAL: |
| A new service has been detected by the discovery manager. Take the appropriate |
| action to connect to the service.</div> |
| </li> |
| </ul> |
| <a name="getDiscoveryManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiscoveryManager</h4> |
| <pre>public <a href="../../../../../org/eclipse/persistence/sessions/coordination/DiscoveryManager.html" title="class in org.eclipse.persistence.sessions.coordination">DiscoveryManager</a> getDiscoveryManager()</pre> |
| <div class="block">PUBLIC: |
| Return the discovery manager that detects the arrival of new cluster members</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#getDiscoveryManager--">getDiscoveryManager</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The DiscoveryManager instance being used by this CommandManager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCommandConverter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCommandConverter</h4> |
| <pre>public <a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandConverter</a> getCommandConverter()</pre> |
| <div class="block">PUBLIC: |
| Return the converter instance used to convert between EclipseLink Command |
| objects and an application command format.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#getCommandConverter--">getCommandConverter</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The converter being used by this CommandManager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCommandConverter-org.eclipse.persistence.sessions.coordination.CommandConverter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCommandConverter</h4> |
| <pre>public void setCommandConverter(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandConverter</a> newCommandConverter)</pre> |
| <div class="block">ADVANCED: |
| Set the converter instance that will be invoked by this CommandProcessor |
| to convert commands from their application command format into EclipseLink |
| Command objects before being propagated to remote command manager services. |
| The converter will also be invoked to convert EclipseLink Command objects into |
| application format before being sent to the CommandProcessor for execution.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#setCommandConverter-org.eclipse.persistence.sessions.coordination.CommandConverter-">setCommandConverter</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newCommandConverter</code> - The converter to be used by this CommandManager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shouldLogMessage-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldLogMessage</h4> |
| <pre>public boolean shouldLogMessage(int logLevel)</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="shouldLogDebugMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldLogDebugMessage</h4> |
| <pre>public boolean shouldLogDebugMessage()</pre> |
| </li> |
| </ul> |
| <a name="shouldLogWarningMessage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldLogWarningMessage</h4> |
| <pre>public boolean shouldLogWarningMessage()</pre> |
| </li> |
| </ul> |
| <a name="logMessage-int-java.lang.String-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logMessage</h4> |
| <pre>public void logMessage(int logLevel, |
| <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> message, |
| <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>[] args)</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="logMessageWithoutLevelCheck-int-java.lang.String-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logMessageWithoutLevelCheck</h4> |
| <pre>public void logMessageWithoutLevelCheck(int logLevel, |
| <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> message, |
| <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>[] args)</pre> |
| <div class="block">INTERNAL: |
| Use this method in case the necessary logLevel has been confirmed |
| by calling commandProcessor.shouldLogMessages method</div> |
| </li> |
| </ul> |
| <a name="logDebug-java.lang.String-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logDebug</h4> |
| <pre>public void logDebug(<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> message, |
| <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>[] args)</pre> |
| <div class="block">INTERNAL: |
| Convenience logging methods.</div> |
| </li> |
| </ul> |
| <a name="logDebugWithoutLevelCheck-java.lang.String-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logDebugWithoutLevelCheck</h4> |
| <pre>public void logDebugWithoutLevelCheck(<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> message, |
| <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>[] args)</pre> |
| </li> |
| </ul> |
| <a name="logInfo-java.lang.String-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logInfo</h4> |
| <pre>public void logInfo(<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> message, |
| <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>[] args)</pre> |
| </li> |
| </ul> |
| <a name="logWarning-java.lang.String-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logWarning</h4> |
| <pre>public void logWarning(<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> message, |
| <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>[] args)</pre> |
| </li> |
| </ul> |
| <a name="logWarningWithoutLevelCheck-java.lang.String-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logWarningWithoutLevelCheck</h4> |
| <pre>public void logWarningWithoutLevelCheck(<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> message, |
| <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>[] args)</pre> |
| </li> |
| </ul> |
| <a name="logError-java.lang.String-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logError</h4> |
| <pre>public void logError(<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> message, |
| <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>[] args)</pre> |
| </li> |
| </ul> |
| <a name="getServiceId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceId</h4> |
| <pre>public <a href="../../../../../org/eclipse/persistence/sessions/coordination/ServiceId.html" title="class in org.eclipse.persistence.sessions.coordination">ServiceId</a> getServiceId()</pre> |
| <div class="block">INTERNAL: |
| Return the service info that identifies this service instance</div> |
| </li> |
| </ul> |
| <a name="getChannel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChannel</h4> |
| <pre>public <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> getChannel()</pre> |
| <div class="block">PUBLIC: |
| Return the service channel for this command manager. All command managers |
| with the same service channel will send and receive commands from each other. |
| Commands sent on other service channels will not be exchanged with this |
| command manager.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#getChannel--">getChannel</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The service channel String subscribed to by this CommandManager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setChannel-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setChannel</h4> |
| <pre>public void setChannel(<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> channel)</pre> |
| <div class="block">ADVANCED: |
| Set the service channel for this command manager. All command managers |
| with the same service channel will send and receive commands from each other. |
| Commands sent on other service channels will not be exchanged with this |
| command manager.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#setChannel-java.lang.String-">setChannel</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>channel</code> - The service channel subscribed to by this CommandManager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCommandProcessorASession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCommandProcessorASession</h4> |
| <pre>public boolean isCommandProcessorASession()</pre> |
| <div class="block">INTERNAL: |
| Return whether this command manager should process profile commands</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#isCommandProcessorASession--">isCommandProcessorASession</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUrl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUrl</h4> |
| <pre>public <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> getUrl()</pre> |
| <div class="block">PUBLIC: |
| Return the URL for this command manager.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#getUrl--">getUrl</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The URL String for this CommandManager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUrl-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUrl</h4> |
| <pre>public void setUrl(<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> url)</pre> |
| <div class="block">ADVANCED: |
| Set the URL for this command manager.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#setUrl-java.lang.String-">setUrl</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>url</code> - The URL String for this CommandManager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shouldPropagateAsynchronously--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldPropagateAsynchronously</h4> |
| <pre>public boolean shouldPropagateAsynchronously()</pre> |
| <div class="block">PUBLIC: |
| Return whether this command manager should propagate commands |
| synchronously or asynchronously. If set to synchronous propagation then |
| propagateCommand() will not return to the caller until the command has |
| been executed on all of the services in the cluster. In asynchronous mode |
| the command manager will create a separate thread for each of the remote |
| service executions, and then promptly return to the caller.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#shouldPropagateAsynchronously--">shouldPropagateAsynchronously</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setShouldPropagateAsynchronously-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldPropagateAsynchronously</h4> |
| <pre>public void setShouldPropagateAsynchronously(boolean asyncMode)</pre> |
| <div class="block">ADVANCED: |
| Set whether this command manager should propagate commands |
| synchronously or asynchronously. If set to synchronous propagation then |
| propagateCommand() will not return to the caller until the command has |
| been executed on all of the services in the cluster. In asynchronous mode |
| the command manager will create a separate thread for each of the remote |
| service executions, and then promptly return to the caller.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#setShouldPropagateAsynchronously-boolean-">setShouldPropagateAsynchronously</a></code> in interface <code><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceLocalHostIPAddress-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceLocalHostIPAddress</h4> |
| <pre>public void replaceLocalHostIPAddress(<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> ipAddress)</pre> |
| <div class="block">ADVANCED: |
| Allow user to replace the $HOST subString of the local host URL with the user user input at runtime. |
| By default, EclipseLink will try to discovery the local host IP and may fail due to security or network restrictions. |
| In this case, user can call this API to specify the IP address or host name during pre-login session event or before session login. |
| Example: |
| If input is 145.23.127.79, the local host URL of ormi://$HOST:2971:/app_name will become ormi://145.23.127.79:2971:/app_name</div> |
| </li> |
| </ul> |
| <a name="replaceTransportPortNumber-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceTransportPortNumber</h4> |
| <pre>public void replaceTransportPortNumber(<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> portNumber)</pre> |
| <div class="block">ADVANCED: |
| Allow user to replace the $PORT subString of the local host URL with the user user input at runtime. |
| In this case, user can call this API to specify the port number for a specific transport during pre-login session event or before session login. |
| Example: |
| If input is 7799, the local host URL of ormi://145.23.127.79:$PORT/app_name will become ormi://145.23.127.79:7799/app_name</div> |
| </li> |
| </ul> |
| <a name="getServerPlatform--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerPlatform</h4> |
| <pre>public <a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html" title="interface in org.eclipse.persistence.platform.server">ServerPlatform</a> getServerPlatform()</pre> |
| <div class="block">INTERNAL: |
| Return the serverPlatform that identifies the application server</div> |
| </li> |
| </ul> |
| <a name="setServerPlatform-org.eclipse.persistence.platform.server.ServerPlatform-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServerPlatform</h4> |
| <pre>public void setServerPlatform(<a href="../../../../../org/eclipse/persistence/platform/server/ServerPlatform.html" title="interface in org.eclipse.persistence.platform.server">ServerPlatform</a> theServerPlatform)</pre> |
| <div class="block">PUBLIC: |
| The ServerPlatform must be set manually when the RemoteCommandManager'CommandProcessor is not EclipseLink Session. |
| When the CommandProcessor is a EclipseLink Session, the ServerPlatform is automatically gotten from the Session.</div> |
| </li> |
| </ul> |
| <a name="getSerializer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSerializer</h4> |
| <pre>public <a href="../../../../../org/eclipse/persistence/sessions/serializers/Serializer.html" title="interface in org.eclipse.persistence.sessions.serializers">Serializer</a> getSerializer()</pre> |
| <div class="block">PUBLIC: |
| Return the Serializer to use for serialization of commands.</div> |
| </li> |
| </ul> |
| <a name="setSerializer-org.eclipse.persistence.sessions.serializers.Serializer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setSerializer</h4> |
| <pre>public void setSerializer(<a href="../../../../../org/eclipse/persistence/sessions/serializers/Serializer.html" title="interface in org.eclipse.persistence.sessions.serializers">Serializer</a> serializer)</pre> |
| <div class="block">PUBLIC: |
| Set the Serializer to use for serialization of commands.</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/sessions/coordination/MetadataRefreshListener.html" title="interface in org.eclipse.persistence.sessions.coordination"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/coordination/ServiceId.html" title="class in org.eclipse.persistence.sessions.coordination"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/sessions/coordination/RemoteCommandManager.html" target="_top">Frames</a></li> |
| <li><a href="RemoteCommandManager.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
