| <!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>LocatorLauncher (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="LocatorLauncher (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":9,"i9":10,"i10":10,"i11":9,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":9,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":41,"i32":10,"i33":10,"i34":10,"i35":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/Locator.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/LocatorLauncher.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/LocatorLauncher.html" target="_top">Frames</a></li> |
| <li><a href="LocatorLauncher.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 LocatorLauncher" class="title">Class LocatorLauncher</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.LocatorLauncher</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">LocatorLauncher</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 LocatorLauncher class is a launcher for a Geode Locator.</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/ServerLauncher.html" title="class in org.apache.geode.distributed"><code>ServerLauncher</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/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></span></code> |
| <div class="block">Following the Builder design pattern, the LocatorLauncher Builder is used to configure and |
| create a properly initialized instance of the LocatorLauncher class for running the Locator and |
| performing other Locator operations.</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/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed">LocatorLauncher.Command</a></span></code> |
| <div class="block">An enumerated type representing valid commands to the Locator 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/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a></span></code> |
| <div class="block">The LocatorState is an immutable type representing the state of the specified Locator 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#logger">logger</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/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/LocatorLauncher.html#getBindAddress--">getBindAddress</a></span>()</code> |
| <div class="block">Gets the IP address of the NIC to which the Locator has bound itself listening for client |
| requests.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getBindAddressAsString--">getBindAddressAsString</a></span>()</code> |
| <div class="block">Gets the host, as either hostname or IP address, on which the Locator was bound and running.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/LocatorLauncher.html#getBindAddressString--">getBindAddressString</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <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/LocatorLauncher.html#getCache--">getCache</a></span>()</code> |
| <div class="block">Gets a reference to the <code>Cache</code> that was created by this <code>LocatorLauncher</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed">LocatorLauncher.Command</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getCommand--">getCommand</a></span>()</code> |
| <div class="block">Get the Locator launcher command used to invoke the Locator.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected <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/LocatorLauncher.html#getDistributedSystemProperties--">getDistributedSystemProperties</a></span>()</code> |
| <div class="block">Creates a Properties object with configuration settings that the launcher has that should take |
| precedence over anything the user has defined in their gemfire properties file.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/LocatorLauncher.html#getHostnameForClients--">getHostnameForClients</a></span>()</code> |
| <div class="block">Gets the hostname that clients will use to lookup the running Locator.</div> |
| </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/LocatorLauncher.html#getId--">getId</a></span>()</code> |
| <div class="block">Gets an identifier that uniquely identifies and represents the Locator associated with this |
| launcher.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed">LocatorLauncher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getInstance--">getInstance</a></span>()</code> |
| <div class="block">Gets the instance of the LocatorLauncher used to launch the Geode Locator, or null if this VM |
| does not have an instance of LocatorLauncher indicating no Geode Locator is running.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getLocator--">getLocator</a></span>()</code> |
| <div class="block">Gets a reference to the <code>Locator</code> that was created by this <code>LocatorLauncher</code>.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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/LocatorLauncher.html#getLocatorPidFile--">getLocatorPidFile</a></span>()</code> |
| <div class="block">Gets a File reference with the path to the PID file for the Locator.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getLocatorState--">getLocatorState</a></span>()</code> |
| <div class="block">Gets the LocatorState for this process or null if this process was not launched using this VM's |
| LocatorLauncher reference.</div> |
| </td> |
| </tr> |
| <tr id="i12" 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/LocatorLauncher.html#getLogFileName--">getLogFileName</a></span>()</code> |
| <div class="block">Gets the name of the log file used to log information about this Locator.</div> |
| </td> |
| </tr> |
| <tr id="i13" 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/LocatorLauncher.html#getMemberName--">getMemberName</a></span>()</code> |
| <div class="block">Gets the name of this member (this Locator) in the Geode distributed system and determined by |
| the 'name' Geode property.</div> |
| </td> |
| </tr> |
| <tr id="i14" 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/LocatorLauncher.html#getPid--">getPid</a></span>()</code> |
| <div class="block">Gets the user-specified process ID (PID) of the running Locator that LocatorLauncher uses to |
| issue status and stop commands to the Locator.</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/LocatorLauncher.html#getPort--">getPort</a></span>()</code> |
| <div class="block">Gets the port number on which the Locator listens for client requests.</div> |
| </td> |
| </tr> |
| <tr id="i16" 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/LocatorLauncher.html#getPortAsString--">getPortAsString</a></span>()</code> |
| <div class="block">Gets the port number represented as a String value.</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/LocatorLauncher.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/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/LocatorLauncher.html#getServiceName--">getServiceName</a></span>()</code> |
| <div class="block">Gets the name for a Geode Locator.</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/LocatorLauncher.html#getWorkingDirectory--">getWorkingDirectory</a></span>()</code> |
| <div class="block">Gets the working directory pathname in which the Locator will be run.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#help-org.apache.geode.distributed.LocatorLauncher.Command-">help</a></span>(<a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed">LocatorLauncher.Command</a> command)</code> |
| <div class="block">Displays help for the specified Locator launcher command to standard err.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#isForcing--">isForcing</a></span>()</code> |
| <div class="block">Determines whether the PID file is allowed to be overwritten when the Locator is started and a |
| PID file already exists in the Locator's specified working directory.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.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="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#isRedirectingOutput--">isRedirectingOutput</a></span>()</code> |
| <div class="block">Determines whether this launcher will redirect output to system logs when starting a new |
| Locator process.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#isStoppable--">isStoppable</a></span>()</code> |
| <div class="block">Determines whether the Locator can be stopped in-process, such as when a Locator is embedded in |
| an application and the LocatorLauncher API is being used.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.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 Locator from the command-line configured with the given arguments.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#run--">run</a></span>()</code> |
| <div class="block">The Runnable method used to launch the Locator with the specified command.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#start--">start</a></span>()</code> |
| <div class="block">Starts a Locator running on the specified port and bind address, as determined by getPort and |
| getSocketAddress respectively, defaulting to 10334 and 'localhost' if not specified, with both |
| peer and server location enabled.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#status--">status</a></span>()</code> |
| <div class="block">Attempts to determine the state of the Locator.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>org.apache.geode.cache.client.internal.locator.LocatorStatusResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#statusForLocator-int-java.net.InetAddress-">statusForLocator</a></span>(int port, |
| <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> bindAddressArg)</code> |
| <div class="block">Returns the status of the locator on the given host and port.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>org.apache.geode.cache.client.internal.locator.LocatorStatusResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#statusForLocator-int-java.lang.String-">statusForLocator</a></span>(int port, |
| <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> hostname)</code> |
| <div class="block">Returns the status of the locator on the given host and port</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>static org.apache.geode.cache.client.internal.locator.LocatorStatusResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#statusLocator-int-java.net.InetAddress-">statusLocator</a></span>(int port, |
| <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> bindAddress)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">in Geode 1.12. Use statusForLocator() instance method instead. |
| This static method does not use the properties set via the Builder.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#stop--">stop</a></span>()</code> |
| <div class="block">Stop shuts the running Locator down.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#usage--">usage</a></span>()</code> |
| <div class="block">Displays usage information on the proper invocation of the LocatorLauncher from the |
| command-line to standard err.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#waitOnLocator--">waitOnLocator</a></span>()</code> |
| <div class="block">Waits on the Locator to stop causing the calling Thread to join with the Locator's |
| location-based services Thread.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#waitOnStatusResponse-long-long-java.util.concurrent.TimeUnit-">waitOnStatusResponse</a></span>(long timeout, |
| long interval, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code> |
| <div class="block">Waits for a Locator status request response to be returned up to the specified timeout in the |
| given unit of time.</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-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 Locator 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 Locator 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/LocatorLauncher.html" title="class in org.apache.geode.distributed">LocatorLauncher</a> getInstance()</pre> |
| <div class="block">Gets the instance of the LocatorLauncher used to launch the Geode Locator, or null if this VM |
| does not have an instance of LocatorLauncher indicating no Geode Locator is running.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the instance of LocatorLauncher used to launcher a Geode Locator in this VM.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocatorState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocatorState</h4> |
| <pre>public static <a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a> getLocatorState()</pre> |
| <div class="block">Gets the LocatorState for this process or null if this process was not launched using this VM's |
| LocatorLauncher reference.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the LocatorState for this process or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="statusLocator-int-java.net.InetAddress-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>statusLocator</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public static org.apache.geode.cache.client.internal.locator.LocatorStatusResponse statusLocator(int port, |
| <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> bindAddress) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">in Geode 1.12. Use statusForLocator() instance method instead. |
| This static method does not use the properties set via the Builder.</span></div> |
| <div class="block">Returns the status of the locator on the given host and port</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - the port that the locator is listening on</dd> |
| <dd><code>bindAddress</code> - the IP address to which the locator's socket binds</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>LocatorStatusResponse</code> representing the status of the locator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is a problem interacting with the locator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="statusForLocator-int-java.net.InetAddress-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>statusForLocator</h4> |
| <pre>public org.apache.geode.cache.client.internal.locator.LocatorStatusResponse statusForLocator(int port, |
| <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> bindAddressArg) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Returns the status of the locator on the given host and port. If you have endpoint |
| identification enabled the preferred method is statusForLocator(int, String), which |
| lets you specify the locator's name that the locator has stored in its TLS certificate</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - the port that the locator is listening on</dd> |
| <dd><code>bindAddressArg</code> - the IP address to which the locator's socket binds</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>LocatorStatusResponse</code> representing the status of the locator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is a problem interacting with the locator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="statusForLocator-int-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>statusForLocator</h4> |
| <pre>public org.apache.geode.cache.client.internal.locator.LocatorStatusResponse statusForLocator(int port, |
| <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> hostname) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Returns the status of the locator on the given host and port</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - the port that the locator is listening on</dd> |
| <dd><code>hostname</code> - the host name or ip address that the locator is listening on.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>LocatorStatusResponse</code> representing the status of the locator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is a problem interacting with the locator</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>LocatorLauncher</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="getLocator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocator</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a> getLocator()</pre> |
| <div class="block">Gets a reference to the <code>Locator</code> that was created by this <code>LocatorLauncher</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to the Locator.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed"><code>Locator</code></a></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 Locator associated with this |
| launcher.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String value identifier to uniquely identify the Locator and it's launcher.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getBindAddressAsString--"><code>getBindAddressAsString()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getPortAsString--"><code>getPortAsString()</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/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed">LocatorLauncher.Command</a> getCommand()</pre> |
| <div class="block">Get the Locator launcher command used to invoke the Locator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Locator launcher command used to invoke the Locator.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed"><code>LocatorLauncher.Command</code></a></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 Locator is started and a |
| PID file already exists in the Locator'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 Locator launcher commands will be used to affect the state of the Locator. 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/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed"><code>LocatorLauncher.Command</code></a></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 |
| Locator 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 Locator process</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBindAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBindAddress</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> getBindAddress()</pre> |
| <div class="block">Gets the IP address of the NIC to which the Locator has bound itself listening for client |
| requests.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an InetAddress object representing the configured bind address for the Locator.</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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBindAddressAsString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBindAddressAsString</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBindAddressAsString()</pre> |
| <div class="block">Gets the host, as either hostname or IP address, on which the Locator was bound and running. An |
| attempt is made to get the canonical hostname for IP address to which the Locator was bound for |
| accepting client requests. If the 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 Locator, 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/LocatorLauncher.html#getBindAddress--"><code>getBindAddress()</code></a></dd> |
| </dl> |
| </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> |
| <div class="block">Gets the hostname that clients will use to lookup the running Locator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String indicating the hostname used by clients to lookup the Locator.</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 Locator.</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 Locator'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 Locator) in the Geode distributed system and 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 Locator) 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 Locator that LocatorLauncher uses to |
| issue status and stop commands to the Locator.</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 Locator.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</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> getPort()</pre> |
| <div class="block">Gets the port number on which the Locator listens for client requests.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Integer value indicating the port number on which the Locator is listening for |
| client requests.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPortAsString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPortAsString</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> getPortAsString()</pre> |
| <div class="block">Gets the port number represented as a String value. If the port number is null, the the default |
| Locator port (10334) is returned;</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the port number as a String value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getPort--"><code>getPort()</code></a></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="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 Locator.</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 Locator.</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 Locator 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 Locator's working directory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="help-org.apache.geode.distributed.LocatorLauncher.Command-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>help</h4> |
| <pre>public void help(<a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed">LocatorLauncher.Command</a> command)</pre> |
| <div class="block">Displays help for the specified Locator launcher command to standard err. If the Locator |
| launcher command is unspecified, then usage information is displayed instead.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the Locator launcher command in which to display help information.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.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 LocatorLauncher from the |
| command-line to standard err.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#help-org.apache.geode.distributed.LocatorLauncher.Command-"><code>help(org.apache.geode.distributed.LocatorLauncher.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">The Runnable method used to launch the Locator with the specified command. If 'start' has been |
| issued, then run will block as expected for the Locator to stop. The 'start' command is |
| implemented with a call to start() followed by a call to waitOnLocator().</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>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed"><code>LocatorLauncher.Command</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#start--"><code>start()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#waitOnLocator--"><code>waitOnLocator()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#status--"><code>status()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#stop--"><code>stop()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#version--"><code>AbstractLauncher.version()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#help-org.apache.geode.distributed.LocatorLauncher.Command-"><code>help(org.apache.geode.distributed.LocatorLauncher.Command)</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#usage--"><code>usage()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocatorPidFile--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocatorPidFile</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> getLocatorPidFile()</pre> |
| <div class="block">Gets a File reference with the path to the PID file for the Locator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a File reference to the path of the Locator'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/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a> start()</pre> |
| <div class="block">Starts a Locator running on the specified port and bind address, as determined by getPort and |
| getSocketAddress respectively, defaulting to 10334 and 'localhost' if not specified, with both |
| peer and server location enabled. |
| |
| 'start' is an asynchronous invocation of the Locator. As such, this method makes no guarantees |
| whether the Locator's location services (peer and server) are actually running before it |
| returns. The Locator's location-based services are initiated in separate, daemon Threads and |
| depends on the relative timing and scheduling of those Threads by the JVM. If the application |
| using this API wishes for the Locator to continue running after normal application processing |
| completes, then one must call <code>waitOnLocator</code>. |
| |
| Given the nature of start, the Locator's status will be in either 1 of 2 possible states. If |
| the 'request' to start the Locator proceeds without exception, the status will be 'STARTED'. |
| However, if any exception is encountered during the normal startup sequence, then a |
| RuntimeException is thrown and the status is set to 'STOPPED'.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a LocatorState to reflect the state of the Locator after start.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if the Locator failed to start for any reason.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the Locator is already running.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#failOnStart-java.lang.Throwable-"><code>failOnStart(Throwable)</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getBindAddress--"><code>getBindAddress()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getDistributedSystemProperties--"><code>getDistributedSystemProperties()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#isForcing--"><code>isForcing()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getLogFile--"><code>AbstractLauncher.getLogFile()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getLocatorPidFile--"><code>getLocatorPidFile()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#getPort--"><code>getPort()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#status--"><code>status()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#stop--"><code>stop()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#waitOnLocator--"><code>waitOnLocator()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#waitOnStatusResponse-long-long-java.util.concurrent.TimeUnit-"><code>waitOnStatusResponse(long, long, java.util.concurrent.TimeUnit)</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed"><code>LocatorLauncher.LocatorState</code></a>, |
| <a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html#NOT_RESPONDING"><code>AbstractLauncher.Status.NOT_RESPONDING</code></a>, |
| <a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html#ONLINE"><code>AbstractLauncher.Status.ONLINE</code></a>, |
| <a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html#STARTING"><code>AbstractLauncher.Status.STARTING</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDistributedSystemProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDistributedSystemProperties</h4> |
| <pre>protected <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> getDistributedSystemProperties()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getDistributedSystemProperties--">AbstractLauncher</a></code></span></div> |
| <div class="block">Creates a Properties object with configuration settings that the launcher has that should take |
| precedence over anything the user has defined in their gemfire properties file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getDistributedSystemProperties--">getDistributedSystemProperties</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 Properties object with GemFire properties that the launcher has defined.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getDistributedSystemProperties-java.util.Properties-"><code>AbstractLauncher.getDistributedSystemProperties(java.util.Properties)</code></a>, |
| <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="waitOnLocator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitOnLocator</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a> waitOnLocator()</pre> |
| <div class="block">Waits on the Locator to stop causing the calling Thread to join with the Locator's |
| location-based services Thread.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Locator's status once it stops.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AssertionError.html?is-external=true" title="class or interface in java.lang">AssertionError</a></code> - if the Locator has not been started and the reference is null |
| (assertions must be enabled for the error to be thrown).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#failOnStart-java.lang.Throwable-"><code>failOnStart(Throwable)</code></a>, |
| <a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html" title="enum in org.apache.geode.distributed"><code>AbstractLauncher.Status</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed"><code>LocatorLauncher.LocatorState</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitOnStatusResponse-long-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitOnStatusResponse</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a> waitOnStatusResponse(long timeout, |
| long interval, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre> |
| <div class="block">Waits for a Locator status request response to be returned up to the specified timeout in the |
| given unit of time. This call will send status requests at fixed intervals in the given unit of |
| time until the timeout expires. If the request to determine the Locator's status is successful, |
| then the Locator is considered to be 'ONLINE'. Otherwise, the Locator is considered to be |
| unresponsive to the status request. |
| |
| However, this does not necessarily imply the Locator start was unsuccessful, only that a |
| response was not received in the given time period. |
| |
| Note, this method does not block or cause the Locator's location-based services (daemon |
| Threads) to continue running in anyway if the main application Thread terminates when running |
| the Locator in-process. If the caller wishes to start a Locator in an asynchronous manner |
| within the application process, then a call should be made to <code>waitOnLocator</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - a long value in time unit indicating when the period of time should expire in |
| attempting to determine the Locator's status.</dd> |
| <dd><code>interval</code> - a long value in time unit for how frequent the requests should be sent to the |
| Locator.</dd> |
| <dd><code>timeUnit</code> - the unit of time in which the timeout and interval are measured.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the state of the Locator, which will either be 'ONLINE' or "NOT RESPONDING'. If the |
| status returned is 'NOT RESPONDING', it just means the Locator did not respond to the |
| status request within the given time period. It should not be taken as the Locator |
| failed to start.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#waitOnLocator--"><code>waitOnLocator()</code></a></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/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a> status()</pre> |
| <div class="block">Attempts to determine the state of the Locator. The Locator's status will be in only 1 of 2 |
| possible states, either ONLINE or OFFLINE. This method behaves differently depending on which |
| parameters were specified when the LocatorLauncher was constructed with an instance of Builder. |
| If either the 'dir' or the 'pid' command-line option were specified, then an attempt is made to |
| determine the Locator's status by using the dir or pid to correctly identify the Locator's |
| MemberMXBean registered in the MBeanServer of the Locator's JVM, and invoking the 'status' |
| operation. The same behavior occurs if the caller specified the Locator's Geode member name |
| or ID. |
| |
| However, if 'dir' or 'pid' were not specified, then determining the Locator's status defaults |
| to using the configured bind address and port. If the bind address or port was not specified |
| when using the Builder to construct a LocatorLauncher instance, then the defaults for both bind |
| address and port are used. In either case, an actual TCP/IP request is made to the Locator's |
| ServerSocket to ensure it is listening for client requests. This is true even when the |
| LocatorLauncher is used in-process by calling the API. |
| |
| If the conditions above hold, then the Locator is deemed to be 'ONLINE', otherwise, the Locator |
| is considered 'OFFLINE'.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Locator's state.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#start--"><code>start()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#stop--"><code>stop()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html" title="enum in org.apache.geode.distributed"><code>AbstractLauncher.Status</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed"><code>LocatorLauncher.LocatorState</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isStoppable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStoppable</h4> |
| <pre>protected boolean isStoppable()</pre> |
| <div class="block">Determines whether the Locator can be stopped in-process, such as when a Locator is embedded in |
| an application and the LocatorLauncher API is being used.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean indicating whether the Locator can be stopped in-process (the application's |
| process with an embedded Locator).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed">LocatorLauncher.LocatorState</a> stop()</pre> |
| <div class="block">Stop shuts the running Locator down. Using the API, the Locator is requested to stop by calling |
| the Locator object's 'stop' method. Internally, this method is no different than using the |
| LocatorLauncher class from the command-line or from within Geode shell (Gfsh). In every |
| single case, stop sends a TCP/IP 'shutdown' request on the configured address/port to which the |
| Locator is bound and listening. |
| |
| If the "shutdown" request is successful, then the Locator will be 'STOPPED'. Otherwise, the |
| Locator is considered 'OFFLINE' since the actual state cannot be fully assessed (as in the |
| application process in which the Locator was hosted may still be running and the Locator object |
| may still exist even though it is no longer responding to location-based requests). The later |
| is particularly important in cases where the system resources (such as Sockets) may not have |
| been cleaned up yet. Therefore, by returning a status of 'OFFLINE', the value is meant to |
| reflect this in-deterministic state.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a LocatorState indicating the state of the Locator after stop has been requested.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#start--"><code>start()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html#status--"><code>status()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.LocatorState.html" title="class in org.apache.geode.distributed"><code>LocatorLauncher.LocatorState</code></a>, |
| <a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html#NOT_RESPONDING"><code>AbstractLauncher.Status.NOT_RESPONDING</code></a>, |
| <a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html#STOPPED"><code>AbstractLauncher.Status.STOPPED</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBindAddressString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getBindAddressString</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> getBindAddressString()</pre> |
| </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/Locator.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/LocatorLauncher.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/LocatorLauncher.html" target="_top">Frames</a></li> |
| <li><a href="LocatorLauncher.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> |
