| <!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 --> |
| <title>ServerLauncher (Apache Geode 1.15.1)</title> |
| <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="ServerLauncher (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"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":9,"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":9,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/distributed/Role.html" title="interface in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/distributed/ServerLauncher.html" target="_top">Frames</a></li> |
| <li><a href="ServerLauncher.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.geode.distributed.AbstractLauncher">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.geode.distributed</div> |
| <h2 title="Class ServerLauncher" class="title">Class ServerLauncher</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">org.apache.geode.distributed.AbstractLauncher</a><<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>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.geode.distributed.ServerLauncher</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ServerLauncher</span> |
| extends <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a><<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>></pre> |
| <div class="block">The ServerLauncher class is a launcher class with main method to start a Geode Server (implying |
| a Geode Cache Server process).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed"><code>AbstractLauncher</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed"><code>LocatorLauncher</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></span></code> |
| <div class="block">The Builder class, modeled after the Builder creational design pattern, is used to construct a |
| properly configured and initialized instance of the ServerLauncher to control and run Geode |
| servers (in particular, cache servers).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a></span></code> |
| <div class="block">An enumerated type representing valid commands to the Server launcher.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a></span></code> |
| <div class="block">The ServerState is an immutable type representing the state of the specified Server at any |
| given moment in time.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.geode.distributed.AbstractLauncher"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.geode.distributed.<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a></h3> |
| <code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.ServiceState.html" title="class in org.apache.geode.distributed">AbstractLauncher.ServiceState</a><<a href="../../../../org/apache/geode/distributed/AbstractLauncher.ServiceState.html" title="type parameter in AbstractLauncher.ServiceState">T</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/geode/distributed/AbstractLauncher.ServiceState.html" title="type parameter in AbstractLauncher.ServiceState">T</a>>>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html" title="enum in org.apache.geode.distributed">AbstractLauncher.Status</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.geode.distributed.AbstractLauncher"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.geode.distributed.<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a></h3> |
| <code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#DEFAULT_FORCE">DEFAULT_FORCE</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#DEFAULT_WORKING_DIRECTORY">DEFAULT_WORKING_DIRECTORY</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#MEMBER_NAME_ERROR_MESSAGE">MEMBER_NAME_ERROR_MESSAGE</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#OPTION_PREFIX">OPTION_PREFIX</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#READ_PID_FILE_TIMEOUT_MILLIS">READ_PID_FILE_TIMEOUT_MILLIS</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#running">running</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#SIGNAL_HANDLER_REGISTRATION_SYSTEM_PROPERTY">SIGNAL_HANDLER_REGISTRATION_SYSTEM_PROPERTY</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#WORKING_DIRECTORY_NOT_FOUND_ERROR_MESSAGE">WORKING_DIRECTORY_NOT_FOUND_ERROR_MESSAGE</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#WORKING_DIRECTORY_OPTION_NOT_VALID_ERROR_MESSAGE">WORKING_DIRECTORY_OPTION_NOT_VALID_ERROR_MESSAGE</a></code></li> |
| </ul> |
| </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getCache--">getCache</a></span>()</code> |
| <div class="block">Gets a reference to the <code>Cache</code> that was created by this <code>ServerLauncher</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.apache.geode.internal.cache.CacheConfig</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getCacheConfig--">getCacheConfig</a></span>()</code> |
| <div class="block">Gets the CacheConfig object used to configure additional Geode Cache components and features |
| (e.g.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getCommand--">getCommand</a></span>()</code> |
| <div class="block">Get the Server launcher command used to invoke the Server.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getCriticalHeapPercentage--">getCriticalHeapPercentage</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getCriticalOffHeapPercentage--">getCriticalOffHeapPercentage</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getEvictionHeapPercentage--">getEvictionHeapPercentage</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getEvictionOffHeapPercentage--">getEvictionOffHeapPercentage</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" 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/apache/geode/distributed/ServerLauncher.html#getHostNameForClients--">getHostNameForClients</a></span>()</code> </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/apache/geode/distributed/ServerLauncher.html#getId--">getId</a></span>()</code> |
| <div class="block">Gets an identifier that uniquely identifies and represents the Server associated with this |
| launcher.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/geode/distributed/ServerLauncher.html" title="class in org.apache.geode.distributed">ServerLauncher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getInstance--">getInstance</a></span>()</code> |
| <div class="block">Gets the instance of the ServerLauncher used to launch the Geode Cache Server, or null if |
| this VM does not have an instance of ServerLauncher indicating no Geode Cache Server is |
| running.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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/apache/geode/distributed/ServerLauncher.html#getLogFileName--">getLogFileName</a></span>()</code> |
| <div class="block">Gets the name of the log file used to log information about this Server.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getMaxConnections--">getMaxConnections</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getMaxMessageCount--">getMaxMessageCount</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getMaxThreads--">getMaxThreads</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" 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/apache/geode/distributed/ServerLauncher.html#getMemberName--">getMemberName</a></span>()</code> |
| <div class="block">Gets the name of this member (this Server) in the Geode distributed system as determined by |
| the 'name' Geode property.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getMessageTimeToLive--">getMessageTimeToLive</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getPid--">getPid</a></span>()</code> |
| <div class="block">Gets the user-specified process ID (PID) of the running Server that ServerLauncher uses to |
| issue status and stop commands to the Server.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block">Gets the Geode Distributed System (cluster) Properties.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getServerBindAddress--">getServerBindAddress</a></span>()</code> |
| <div class="block">Gets the IP address to which the Server is bound listening for and accepting cache client |
| connections.</div> |
| </td> |
| </tr> |
| <tr id="i19" 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/apache/geode/distributed/ServerLauncher.html#getServerBindAddressAsString--">getServerBindAddressAsString</a></span>()</code> |
| <div class="block">Gets the host, as either hostname or IP address, on which the Server was bound and running.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getServerPidFile--">getServerPidFile</a></span>()</code> |
| <div class="block">Gets a File reference with the path to the PID file for the Server.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getServerPort--">getServerPort</a></span>()</code> |
| <div class="block">Gets the port on which the Server is listening for cache client connections.</div> |
| </td> |
| </tr> |
| <tr id="i22" 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/apache/geode/distributed/ServerLauncher.html#getServerPortAsString--">getServerPortAsString</a></span>()</code> |
| <div class="block">Gets the server port on which the Server is listening for client requests represented as a |
| String value.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getServerState--">getServerState</a></span>()</code> |
| <div class="block">Gets the ServerState for this process or null if this process was not launched using this VM's |
| ServerLauncher reference .</div> |
| </td> |
| </tr> |
| <tr id="i24" 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/apache/geode/distributed/ServerLauncher.html#getServiceName--">getServiceName</a></span>()</code> |
| <div class="block">Gets the name for a Geode Server.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getSocketBufferSize--">getSocketBufferSize</a></span>()</code> </td> |
| </tr> |
| <tr id="i26" 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/apache/geode/distributed/ServerLauncher.html#getSpringXmlLocation--">getSpringXmlLocation</a></span>()</code> |
| <div class="block">Gets the location of the Spring XML configuration meta-data file used to bootstrap, configure |
| and initialize the Geode Server on start.</div> |
| </td> |
| </tr> |
| <tr id="i27" 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/apache/geode/distributed/ServerLauncher.html#getWorkingDirectory--">getWorkingDirectory</a></span>()</code> |
| <div class="block">Gets the working directory pathname in which the Server will be run.</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/apache/geode/distributed/ServerLauncher.html#help-org.apache.geode.distributed.ServerLauncher.Command-">help</a></span>(<a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a> command)</code> |
| <div class="block">Displays help for the specified Server launcher command to standard err.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#isAssignBuckets--">isAssignBuckets</a></span>()</code> |
| <div class="block">Determines whether buckets should be assigned to partitioned regions in the cache upon Server |
| start.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#isDefaultServerEnabled-org.apache.geode.cache.Cache-">isDefaultServerEnabled</a></span>(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache)</code> |
| <div class="block">Determines whether a default server (a cache server) should be created on startup as determined |
| by the absence of specifying the --disable-default-server command-line option (switch).</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#isDisableDefaultServer--">isDisableDefaultServer</a></span>()</code> |
| <div class="block">Determines whether a default cache server will be added when the Geode Server comes online.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#isForcing--">isForcing</a></span>()</code> |
| <div class="block">Determines whether the PID file is allowed to be overwritten when the Server is started and a |
| PID file already exists in the Server's specified working directory.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#isHelping--">isHelping</a></span>()</code> |
| <div class="block">Determines whether this launcher will be used to display help information.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#isRebalancing--">isRebalancing</a></span>()</code> |
| <div class="block">Determines whether a rebalance operation on the cache will occur upon starting the Geode |
| server using this launcher.</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/apache/geode/distributed/ServerLauncher.html#isRedirectingOutput--">isRedirectingOutput</a></span>()</code> |
| <div class="block">Determines whether this launcher will redirect output to system logs when starting a new Server |
| process.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#isServing-org.apache.geode.cache.Cache-">isServing</a></span>(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache)</code> |
| <div class="block">Determines whether the specified Cache has any CacheServers.</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/apache/geode/distributed/ServerLauncher.html#isSpringXmlLocationSpecified--">isSpringXmlLocationSpecified</a></span>()</code> |
| <div class="block">Determines whether this Geode Server was configured and initialized with Spring configuration |
| meta-data.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#isStartingOrRunning--">isStartingOrRunning</a></span>()</code> |
| <div class="block">Determines whether the Server is the process of starting or is already running.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#main-java.lang.String...-">main</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>... args)</code> |
| <div class="block">Launches a Geode Server from the command-line configured with the given arguments.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#run--">run</a></span>()</code> |
| <div class="block">A Runnable method used to invoke the Geode server (cache server) with the specified command.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#start--">start</a></span>()</code> |
| <div class="block">Invokes the 'start' command and operation to startup a Geode server (a cache server).</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#status--">status</a></span>()</code> |
| <div class="block">Invokes the 'status' command and operation to check the status of a Geode server (a cache |
| server).</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#stop--">stop</a></span>()</code> |
| <div class="block">Invokes the 'stop' command and operation to stop a Geode server (a cache server).</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#usage--">usage</a></span>()</code> |
| <div class="block">Displays usage information on the proper invocation of the ServerLauncher from the command-line |
| to standard err.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#waitOnServer--">waitOnServer</a></span>()</code> |
| <div class="block">Causes the calling Thread to block until the Geode Cache Server/Data Member stops.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.distributed.AbstractLauncher"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.geode.distributed.<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a></h3> |
| <code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#assertPortAvailable-java.net.InetAddress-int-">assertPortAvailable</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#assertPortAvailable-int-">assertPortAvailable</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#debug-java.lang.String-java.lang.Object...-">debug</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#debug-java.lang.Throwable-">debug</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getDistributedSystemProperties--">getDistributedSystemProperties</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getDistributedSystemProperties-java.util.Properties-">getDistributedSystemProperties</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getLogFile--">getLogFile</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getLogFileCanonicalPath--">getLogFileCanonicalPath</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getMember--">getMember</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getMemberId--">getMemberId</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#info-java.lang.Object-java.lang.Object...-">info</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#isDebugging--">isDebugging</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#isRunning--">isRunning</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#isSet-java.util.Properties-java.lang.String-">isSet</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#loadGemFireProperties-java.net.URL-">loadGemFireProperties</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#redirectOutput-org.apache.geode.distributed.DistributedSystem-">redirectOutput</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#setDebug-boolean-">setDebug</a>, <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#version--">version</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="main-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>main</h4> |
| <pre>public static void main(<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>... args)</pre> |
| <div class="block">Launches a Geode Server from the command-line configured with the given arguments.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - the command-line arguments used to configure the Geode Server at runtime.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInstance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre>public static <a href="../../../../org/apache/geode/distributed/ServerLauncher.html" title="class in org.apache.geode.distributed">ServerLauncher</a> getInstance()</pre> |
| <div class="block">Gets the instance of the ServerLauncher used to launch the Geode Cache Server, or null if |
| this VM does not have an instance of ServerLauncher indicating no Geode Cache Server is |
| running.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the instance of ServerLauncher used to launcher a Geode Cache Server in this VM.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerState</h4> |
| <pre>public static <a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a> getServerState()</pre> |
| <div class="block">Gets the ServerState for this process or null if this process was not launched using this VM's |
| ServerLauncher reference .</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ServerState for this process or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCache</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> getCache()</pre> |
| <div class="block">Gets a reference to the <code>Cache</code> that was created by this <code>ServerLauncher</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to the Cache</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheConfig</h4> |
| <pre>public org.apache.geode.internal.cache.CacheConfig getCacheConfig()</pre> |
| <div class="block">Gets the CacheConfig object used to configure additional Geode Cache components and features |
| (e.g. PDX).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a CacheConfig object with additional Geode Cache configuration meta-data used on |
| startup to configure the Cache.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</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> getId()</pre> |
| <div class="block">Gets an identifier that uniquely identifies and represents the Server associated with this |
| launcher.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String value identifier to uniquely identify the Server and it's launcher.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getServerBindAddressAsString--"><code>getServerBindAddressAsString()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getServerPortAsString--"><code>getServerPortAsString()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCommand--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCommand</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a> getCommand()</pre> |
| <div class="block">Get the Server launcher command used to invoke the Server.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Server launcher command used to invoke the Server.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed"><code>ServerLauncher.Command</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAssignBuckets--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAssignBuckets</h4> |
| <pre>public boolean isAssignBuckets()</pre> |
| <div class="block">Determines whether buckets should be assigned to partitioned regions in the cache upon Server |
| start.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean indicating if buckets should be assigned upon Server start.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDisableDefaultServer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDisableDefaultServer</h4> |
| <pre>public boolean isDisableDefaultServer()</pre> |
| <div class="block">Determines whether a default cache server will be added when the Geode Server comes online.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating whether to add a default cache server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isForcing--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isForcing</h4> |
| <pre>public boolean isForcing()</pre> |
| <div class="block">Determines whether the PID file is allowed to be overwritten when the Server is started and a |
| PID file already exists in the Server's specified working directory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean indicating if force has been enabled.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isHelping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHelping</h4> |
| <pre>public boolean isHelping()</pre> |
| <div class="block">Determines whether this launcher will be used to display help information. If so, then none of |
| the standard Server launcher commands will be used to affect the state of the Server. A |
| launcher is said to be 'helping' if the user entered the "--help" option (switch) on the |
| command-line.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating if this launcher is used for displaying help information.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed"><code>ServerLauncher.Command</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isRebalancing--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRebalancing</h4> |
| <pre>public boolean isRebalancing()</pre> |
| <div class="block">Determines whether a rebalance operation on the cache will occur upon starting the Geode |
| server using this launcher.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean indicating if the cache will be rebalance when the Geode server starts.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isRedirectingOutput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRedirectingOutput</h4> |
| <pre>public boolean isRedirectingOutput()</pre> |
| <div class="block">Determines whether this launcher will redirect output to system logs when starting a new Server |
| process.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating if this launcher will redirect output to system logs when |
| starting a new Server process</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLogFileName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLogFileName</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> getLogFileName()</pre> |
| <div class="block">Gets the name of the log file used to log information about this Server.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getLogFileName--">getLogFileName</a></code> in class <code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a><<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></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String value indicating the name of this Server's log file.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMemberName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMemberName</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> getMemberName()</pre> |
| <div class="block">Gets the name of this member (this Server) in the Geode distributed system as determined by |
| the 'name' Geode property.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getMemberName--">getMemberName</a></code> in class <code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a><<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></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String indicating the name of the member (this Server) in the Geode distributed |
| system.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPid--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPid</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getPid()</pre> |
| <div class="block">Gets the user-specified process ID (PID) of the running Server that ServerLauncher uses to |
| issue status and stop commands to the Server.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getPid--">getPid</a></code> in class <code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a><<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></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Integer value indicating the process ID (PID) of the running Server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> getProperties()</pre> |
| <div class="block">Gets the Geode Distributed System (cluster) Properties.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Properties object containing the configuration settings for the Geode Distributed |
| System (cluster).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerBindAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerBindAddress</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> getServerBindAddress()</pre> |
| <div class="block">Gets the IP address to which the Server is bound listening for and accepting cache client |
| connections. This property should not be confused with 'bindAddress' ServerLauncher property, |
| which is the port for binding the Server's ServerSocket used in distribution and messaging |
| between the peers of the Geode distributed system.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an InetAddress indicating the IP address that the Server is bound to listening for and |
| accepting cache client connections in a client/server topology.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerBindAddressAsString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerBindAddressAsString</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> getServerBindAddressAsString()</pre> |
| <div class="block">Gets the host, as either hostname or IP address, on which the Server was bound and running. An |
| attempt is made to get the canonical hostname for IP address to which the Server was bound for |
| accepting client requests. If the server bind address is null or localhost is unknown, then a |
| default String value of "localhost/127.0.0.1" is returned. |
| |
| Note, this information is purely information and should not be used to re-construct state or |
| for other purposes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the hostname or IP address of the host running the Server, based on the bind-address, |
| or 'localhost/127.0.0.1' if the bind address is null and localhost is unknown.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net"><code>InetAddress</code></a>, |
| <a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getServerBindAddress--"><code>getServerBindAddress()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerPort</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getServerPort()</pre> |
| <div class="block">Gets the port on which the Server is listening for cache client connections. This property |
| should not be confused with the 'port' ServerLauncher property, which is used by the Server to |
| set the 'tcp-port' distribution config property and is used by the ServerSocket for peer |
| distribution and messaging.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Integer value indicating the port the Server is listening on for cache client |
| connections in the client/server topology.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerPortAsString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerPortAsString</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> getServerPortAsString()</pre> |
| <div class="block">Gets the server port on which the Server is listening for client requests represented as a |
| String value.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String representing the server port on which the Server is listening for client |
| requests.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#getServerPort--"><code>getServerPort()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServiceName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceName</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> getServiceName()</pre> |
| <div class="block">Gets the name for a Geode Server.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getServiceName--">getServiceName</a></code> in class <code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a><<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></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String indicating the name for a Geode Server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSpringXmlLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpringXmlLocation</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> getSpringXmlLocation()</pre> |
| <div class="block">Gets the location of the Spring XML configuration meta-data file used to bootstrap, configure |
| and initialize the Geode Server on start. |
| <p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String indicating the location of the Spring XML configuration file.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getSpringXmlLocation--"><code>ServerLauncher.Builder.getSpringXmlLocation()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSpringXmlLocationSpecified--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSpringXmlLocationSpecified</h4> |
| <pre>public boolean isSpringXmlLocationSpecified()</pre> |
| <div class="block">Determines whether this Geode Server was configured and initialized with Spring configuration |
| meta-data. |
| <p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating whether this Geode Server was configured with Spring |
| configuration meta-data.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWorkingDirectory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWorkingDirectory</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> getWorkingDirectory()</pre> |
| <div class="block">Gets the working directory pathname in which the Server will be run.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getWorkingDirectory--">getWorkingDirectory</a></code> in class <code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html" title="class in org.apache.geode.distributed">AbstractLauncher</a><<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></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String value indicating the pathname of the Server's working directory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCriticalHeapPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCriticalHeapPercentage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> getCriticalHeapPercentage()</pre> |
| </li> |
| </ul> |
| <a name="getEvictionHeapPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictionHeapPercentage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> getEvictionHeapPercentage()</pre> |
| </li> |
| </ul> |
| <a name="getCriticalOffHeapPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCriticalOffHeapPercentage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> getCriticalOffHeapPercentage()</pre> |
| </li> |
| </ul> |
| <a name="getEvictionOffHeapPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictionOffHeapPercentage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> getEvictionOffHeapPercentage()</pre> |
| </li> |
| </ul> |
| <a name="getHostNameForClients--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostNameForClients</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> getHostNameForClients()</pre> |
| </li> |
| </ul> |
| <a name="getMaxConnections--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxConnections</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getMaxConnections()</pre> |
| </li> |
| </ul> |
| <a name="getMaxMessageCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxMessageCount</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getMaxMessageCount()</pre> |
| </li> |
| </ul> |
| <a name="getMessageTimeToLive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageTimeToLive</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getMessageTimeToLive()</pre> |
| </li> |
| </ul> |
| <a name="getMaxThreads--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxThreads</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getMaxThreads()</pre> |
| </li> |
| </ul> |
| <a name="getSocketBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSocketBufferSize</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getSocketBufferSize()</pre> |
| </li> |
| </ul> |
| <a name="help-org.apache.geode.distributed.ServerLauncher.Command-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>help</h4> |
| <pre>public void help(<a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a> command)</pre> |
| <div class="block">Displays help for the specified Server launcher command to standard err. If the Server launcher |
| command is unspecified, then usage information is displayed instead.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the Server launcher command in which to display help information.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#usage--"><code>usage()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="usage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>usage</h4> |
| <pre>public void usage()</pre> |
| <div class="block">Displays usage information on the proper invocation of the ServerLauncher from the command-line |
| to standard err.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#help-org.apache.geode.distributed.ServerLauncher.Command-"><code>help(ServerLauncher.Command)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="run--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>run</h4> |
| <pre>public void run()</pre> |
| <div class="block">A Runnable method used to invoke the Geode server (cache server) with the specified command. |
| From run, a user can invoke 'start', 'status', 'stop' and 'version'. Note, that 'version' is |
| also a command-line option, but can be treated as a "command" as well.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang"><code>Runnable</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerPidFile--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerPidFile</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getServerPidFile()</pre> |
| <div class="block">Gets a File reference with the path to the PID file for the Server.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a File reference to the path of the Server's PID file.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a> start()</pre> |
| <div class="block">Invokes the 'start' command and operation to startup a Geode server (a cache server). Note, |
| this method will cause the JVM to block upon server start, providing the calling Thread is a |
| non-daemon Thread.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed"><code>ServerLauncher.ServerState</code></a> representing the state of the server following the attempt to |
| start</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#run--"><code>run()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isServing-org.apache.geode.cache.Cache-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isServing</h4> |
| <pre>protected boolean isServing(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache)</pre> |
| <div class="block">Determines whether the specified Cache has any CacheServers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - the Cache to check for existing CacheServers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating if any CacheServers were added to the Cache.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitOnServer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitOnServer</h4> |
| <pre>public void waitOnServer()</pre> |
| <div class="block">Causes the calling Thread to block until the Geode Cache Server/Data Member stops.</div> |
| </li> |
| </ul> |
| <a name="isDefaultServerEnabled-org.apache.geode.cache.Cache-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDefaultServerEnabled</h4> |
| <pre>protected boolean isDefaultServerEnabled(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache)</pre> |
| <div class="block">Determines whether a default server (a cache server) should be created on startup as determined |
| by the absence of specifying the --disable-default-server command-line option (switch). In |
| addition, a default cache server is started only if no cache servers have been added to the |
| Cache by way of cache.xml.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - the reference to the Cache to check for any existing cache servers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean indicating whether a default server should be added to the Cache.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.html#isDisableDefaultServer--"><code>isDisableDefaultServer()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isStartingOrRunning--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStartingOrRunning</h4> |
| <pre>protected boolean isStartingOrRunning()</pre> |
| <div class="block">Determines whether the Server is the process of starting or is already running.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean indicating if the Server is starting or is already running.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="status--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>status</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a> status()</pre> |
| <div class="block">Invokes the 'status' command and operation to check the status of a Geode server (a cache |
| server).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed"><code>ServerLauncher.ServerState</code></a> representing the status of the server</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stop--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed">ServerLauncher.ServerState</a> stop()</pre> |
| <div class="block">Invokes the 'stop' command and operation to stop a Geode server (a cache server).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/geode/distributed/ServerLauncher.ServerState.html" title="class in org.apache.geode.distributed"><code>ServerLauncher.ServerState</code></a> representing the state of the server following the attempt to |
| stop</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/distributed/Role.html" title="interface in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/distributed/ServerLauncher.html" target="_top">Frames</a></li> |
| <li><a href="ServerLauncher.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.geode.distributed.AbstractLauncher">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |