Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / refs/heads/master / . / api / 3.0 / org / eclipse / persistence / sessions / coordination / CommandManager.html
blob: dc03ffa29e2133722c2cd89c765b6373ac2f14ee [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:07 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CommandManager (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="CommandManager (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":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/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sessions/coordination/CommandManager.html" target="_top">Frames</a></li>
<li><a href="CommandManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.persistence.sessions.coordination</div>
<h2 title="Interface CommandManager" class="title">Interface CommandManager</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/sessions/coordination/RemoteCommandManager.html" title="class in org.eclipse.persistence.sessions.coordination">RemoteCommandManager</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CommandManager</span></pre>
<div class="block"><p>
<b>Purpose</b>: Provide an interface that clients can use to invoke remote
commands on other EclipseLink instances, or on other applications that may want
to receive and process EclipseLink commands.
<p>
<b>Description</b>: This is the main interface that is used to send and receive
remote commands in a EclipseLink cluster. The sequence of remote command execution
is as follows:
<ol>
<li> CommandProcessor creates a command and gives it to its local CommandManager
to send to remote services.
<li> CommandManager uses its CommandConverter to convert the command into a
TopLink Command object
<li> CommandManager then uses its TransportManager to send the Command to all
other known cluster members that are subscribing to the same channel
<li> Each remote TransportManager receives the Command and passes it off to the
CommandManager
<li> Each CommandManager uses its local CommandConverter to convert the command
into a format appropriate to its application (CommandProcessor)
<li> Each CommandManager invokes its local CommandProcessor and passes it the
command (formatted the way that the application-specified converter left it in)
to be executed. If the CommandProcessor is a EclipseLink session then the
executeWithSession method will be invoked on the command.
</ol>
<p>
<b>Responsibilities</b>:
<ul>
<li> Invoke the DiscoveryManager to establish the EclipseLink cluster
<li> Propagate remote command to EclipseLink cluster
<li> Delegate processing command to its CommandProssesor
<li> Convert command to appropriate format for sending to EclipseLink cluster
or its command processor
</ul></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><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></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">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><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/CommandManager.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/CommandManager.html#getCommandConverter--">getCommandConverter</a></span>()</code>
<div class="block">PUBLIC:
Return the converter instance used to convert between TopLink 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/CommandManager.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/CommandManager.html#getDiscoveryManager--">getDiscoveryManager</a></span>()</code>
<div class="block">PUBLIC:
Return the discovery manager that manages membership in the EclipseLink cluster.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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/CommandManager.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="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#getUrl--">getUrl</a></span>()</code>
<div class="block">PUBLIC:
Return the URL for this command manager.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#initialize--">initialize</a></span>()</code>
<div class="block">PUBLIC:
Initialize the remote command manager.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#isCommandProcessorASession--">isCommandProcessorASession</a></span>()</code>
<div class="block">ADVANCE:
Return whether this commandProcessor is a EclipseLink session or not.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.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>&nbsp;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="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.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>&nbsp;channel)</code>
<div class="block">ADVANCED:
Set the service channel for this command manager.</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/CommandManager.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>&nbsp;commandConverter)</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="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.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>&nbsp;commandProcessor)</code>
<div class="block">ADVANCED:
Set the command processor that will be invoked to process commands.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#setShouldPropagateAsynchronously-boolean-">setShouldPropagateAsynchronously</a></span>(boolean&nbsp;asyncMode)</code>
<div class="block">ADVANCED:
Set whether this command manager should propagate commands
synchronously or asynchronously.</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/CommandManager.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>&nbsp;newTransportManager)</code>
<div class="block">ADVANCED:
Set a specific transport manager to manage sending and receiving of remote commands.</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/CommandManager.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>&nbsp;url)</code>
<div class="block">ADVANCED:
Set the URL for this command manager.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.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="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandManager.html#shutdown--">shutdown</a></span>()</code>
<div class="block">PUBLIC:
Shut down the remote command manager.</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="initialize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>void&nbsp;initialize()</pre>
<div class="block">PUBLIC:
Initialize the remote command manager. This will also trigger the
DiscoveryManager to start establishing the EclipseLink cluster.</div>
</li>
</ul>
<a name="shutdown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdown</h4>
<pre>void&nbsp;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>
</li>
</ul>
<a name="getUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUrl</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>&nbsp;getUrl()</pre>
<div class="block">PUBLIC:
Return the URL for this command manager.</div>
<dl>
<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>void&nbsp;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>&nbsp;url)</pre>
<div class="block">ADVANCED:
Set the URL for this command manager.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The URL String for this CommandManager</dd>
</dl>
</li>
</ul>
<a name="getChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChannel</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>&nbsp;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="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>void&nbsp;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>&nbsp;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="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - The service channel subscribed to by this CommandManager</dd>
</dl>
</li>
</ul>
<a name="propagateCommand-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>propagateCommand</h4>
<pre>void&nbsp;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>&nbsp;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="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - An object representing a TopLink command</dd>
</dl>
</li>
</ul>
<a name="getCommandProcessor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCommandProcessor</h4>
<pre><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a>&nbsp;getCommandProcessor()</pre>
<div class="block">PUBLIC:
Return the command processor that processes commands received from the cluster.</div>
<dl>
<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>void&nbsp;setCommandProcessor(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandProcessor</a>&nbsp;commandProcessor)</pre>
<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="paramLabel">Parameters:</span></dt>
<dd><code>commandProcessor</code> - The intended processor of remote commands</dd>
</dl>
</li>
</ul>
<a name="setTransportManager-org.eclipse.persistence.sessions.coordination.TransportManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransportManager</h4>
<pre>void&nbsp;setTransportManager(<a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a>&nbsp;newTransportManager)</pre>
<div class="block">ADVANCED:
Set a specific transport manager to manage sending and receiving of remote commands.</div>
<dl>
<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="getTransportManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransportManager</h4>
<pre><a href="../../../../../org/eclipse/persistence/sessions/coordination/TransportManager.html" title="class in org.eclipse.persistence.sessions.coordination">TransportManager</a>&nbsp;getTransportManager()</pre>
<div class="block">PUBLIC:
Return the transport manager that manages sending and receiving of remote commands.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The TransportManager instance being used by this CommandManager</dd>
</dl>
</li>
</ul>
<a name="getDiscoveryManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiscoveryManager</h4>
<pre><a href="../../../../../org/eclipse/persistence/sessions/coordination/DiscoveryManager.html" title="class in org.eclipse.persistence.sessions.coordination">DiscoveryManager</a>&nbsp;getDiscoveryManager()</pre>
<div class="block">PUBLIC:
Return the discovery manager that manages membership in the EclipseLink cluster.</div>
<dl>
<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><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandConverter</a>&nbsp;getCommandConverter()</pre>
<div class="block">PUBLIC:
Return the converter instance used to convert between TopLink Command
objects and an application command format.</div>
<dl>
<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>void&nbsp;setCommandConverter(<a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination">CommandConverter</a>&nbsp;commandConverter)</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="paramLabel">Parameters:</span></dt>
<dd><code>commandConverter</code> - The converter to be used by this CommandManager</dd>
</dl>
</li>
</ul>
<a name="shouldPropagateAsynchronously--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldPropagateAsynchronously</h4>
<pre>boolean&nbsp;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>
</li>
</ul>
<a name="setShouldPropagateAsynchronously-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShouldPropagateAsynchronously</h4>
<pre>void&nbsp;setShouldPropagateAsynchronously(boolean&nbsp;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>
</li>
</ul>
<a name="isCommandProcessorASession--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isCommandProcessorASession</h4>
<pre>boolean&nbsp;isCommandProcessorASession()</pre>
<div class="block">ADVANCE:
Return whether this commandProcessor is a EclipseLink session or not.</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/CommandConverter.html" title="interface in org.eclipse.persistence.sessions.coordination"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/sessions/coordination/CommandProcessor.html" title="interface in org.eclipse.persistence.sessions.coordination"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sessions/coordination/CommandManager.html" target="_top">Frames</a></li>
<li><a href="CommandManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>