| <!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>Locator (Apache Geode 1.15.0)</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="Locator (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":9,"i5":41,"i6":10,"i7":6,"i8":9,"i9":41,"i10":6,"i11":6,"i12":41,"i13":41,"i14":41,"i15":9,"i16":41,"i17":9,"i18":6,"i19":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/LeaseExpiredException.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/LocatorLauncher.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/Locator.html" target="_top">Frames</a></li> |
| <li><a href="Locator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.geode.distributed</div> |
| <h2 title="Class Locator" class="title">Class Locator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.geode.distributed.Locator</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">Locator</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Represents a distribution locator server that provides discovery information to members and |
| clients of a GemFire distributed system. In most GemFire distributed cache architectures, |
| distribution locators are run in their own process. A stand-alone locator process is managed |
| using gfsh command line utility. |
| |
| The stand-alone locator configuration provides high-availability of membership information. |
| |
| <P> |
| |
| This class allows a GemFire application VM to host a distribution locator. Such a configuration |
| minimizes the number of processes that are required to run GemFire. However, hosting distribution |
| locators is not generally recommended because if the application VM exits it would not be |
| possible for new applications to connect to the distributed system until it is restarted. |
| |
| <P> |
| Locators persist membership information in a locatorXXXview.dat file. This file is used to |
| recover information about the cluster when a locator starts if there are no other currently |
| running locators. It allows the restarted locator to rejoin the cluster. |
| |
| <P> |
| <b>NOTE:</b> In this release of the product locators log membership views and cache server status |
| in a locatorXXXviews.log file, where XXX is the locator's port. This is a rolling log capped in |
| size at 5mb. In order to log cache server status the locator will enable server-location, so the |
| locator must be started with a DistributedSystem or be started so that it creates a |
| DistributedSystem. This means that it is not possible in this release to use APIs to start a |
| locator and <i>then</i> start a DistributedSystem. |
| <P></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="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/Locator.html#bindAddress">bindAddress</a></span></code> |
| <div class="block">no longer used but kept for binary compatibility</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.geode.distributed.internal.tcpserver.HostAddress</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/Locator.html#hostAddress">hostAddress</a></span></code> |
| <div class="block">The bind address for this locator</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/Locator.html#hostnameForClients">hostnameForClients</a></span></code> |
| <div class="block">the hostname to give to clients so they can connect to this locator.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/Locator.html#logFile">logFile</a></span></code> |
| <div class="block">The file to which this locator logs</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/Locator.html#Locator--">Locator</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/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/Locator.html#asString--">asString</a></span>()</code> |
| <div class="block">Get the string representation of this <code>Locator</code> in host[port] format.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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/Locator.html#getBindAddress--">getBindAddress</a></span>()</code> |
| <div class="block">Returns the IP address to which this locator's listening socket is bound.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/Locator.html#getDistributedSystem--">getDistributedSystem</a></span>()</code> |
| <div class="block">Returns the distributed system started by this locator, if any</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/Locator.html#getHostnameForClients--">getHostnameForClients</a></span>()</code> |
| <div class="block">Returns the hostname that will be given to clients so that they can connect to this locator.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <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/Locator.html#getLocator--">getLocator</a></span>()</code> |
| <div class="block">Returns the locator if it exists in this JVM.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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/Locator.html#getLocators--">getLocators</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 7.0 use <a href="../../../../org/apache/geode/distributed/Locator.html#getLocator--"><code>getLocator()</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><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/Locator.html#getLogFile--">getLogFile</a></span>()</code> |
| <div class="block">Returns the log file to which this locator's output is written</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract <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/Locator.html#getPort--">getPort</a></span>()</code> |
| <div class="block">Returns the port on which this locator runs</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/Locator.html#hasLocator--">hasLocator</a></span>()</code> |
| <div class="block">Returns true if a locator exists in this JVM.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/Locator.html#hasLocators--">hasLocators</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 7.0 use <a href="../../../../org/apache/geode/distributed/Locator.html#hasLocator--"><code>hasLocator()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/Locator.html#isPeerLocator--">isPeerLocator</a></span>()</code> |
| <div class="block">Indicates whether the locator provides peer location services to members</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/Locator.html#isServerLocator--">isServerLocator</a></span>()</code> |
| <div class="block">Indicates whether the locator provides server location services to clients</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/Locator.html#main-java.lang.String:A-">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"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of Geode 1.4 use <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed"><code>"LocatorLauncher" to start a locator</code></a></span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <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/Locator.html#startLocator-int-java.io.File-">startLocator</a></span>(int port, |
| <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> logFile)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 7.0 use startLocatorAndDS instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <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/Locator.html#startLocator-int-java.io.File-java.net.InetAddress-">startLocator</a></span>(int port, |
| <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> logFile, |
| <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">as of 7.0 use startLocatorAndDS instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <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/Locator.html#startLocatorAndDS-int-java.io.File-java.net.InetAddress-java.util.Properties-">startLocatorAndDS</a></span>(int port, |
| <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> logFile, |
| <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, |
| <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> dsProperties)</code> |
| <div class="block">Starts a new distribution locator host by this VM that binds to the given network address.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static <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/Locator.html#startLocatorAndDS-int-java.io.File-java.net.InetAddress-java.util.Properties-boolean-boolean-java.lang.String-">startLocatorAndDS</a></span>(int port, |
| <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> logFile, |
| <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, |
| <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> dsProperties, |
| boolean peerLocator, |
| boolean serverLocator, |
| <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> hostnameForClients)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use a different startup method peerLocator and serverLocator parameters are ignored</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static <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/Locator.html#startLocatorAndDS-int-java.io.File-java.util.Properties-">startLocatorAndDS</a></span>(int port, |
| <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> logFile, |
| <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> distributedSystemProperties)</code> |
| <div class="block">Starts a new distribution locator host by this VM, and an admin distributed system controlled |
| by the locator.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/Locator.html#stop--">stop</a></span>()</code> |
| <div class="block">Stops this distribution 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/Locator.html#toString--">toString</a></span>()</code> |
| <div class="block">Returns a brief description of this <code>Locator</code></div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="logFile"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logFile</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> logFile</pre> |
| <div class="block">The file to which this locator logs</div> |
| </li> |
| </ul> |
| <a name="bindAddress"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bindAddress</h4> |
| <pre>protected <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</pre> |
| <div class="block">no longer used but kept for binary compatibility</div> |
| </li> |
| </ul> |
| <a name="hostAddress"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hostAddress</h4> |
| <pre>protected org.apache.geode.distributed.internal.tcpserver.HostAddress hostAddress</pre> |
| <div class="block">The bind address for this locator</div> |
| </li> |
| </ul> |
| <a name="hostnameForClients"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hostnameForClients</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> hostnameForClients</pre> |
| <div class="block">the hostname to give to clients so they can connect to this locator.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Locator--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Locator</h4> |
| <pre>public Locator()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="startLocator-int-java.io.File-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startLocator</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 <a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a> startLocator(int port, |
| <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> logFile) |
| 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">as of 7.0 use startLocatorAndDS instead.</span></div> |
| <div class="block">Starts a new distribution locator host by this VM. The locator's listening sockets will bind to |
| all network addresses. The locator will look for a gemfire.properties file, or equivalent |
| system properties to fill in the gaps in its configuration. If you are using multicast |
| communications, the locator should be configured with the same settings that your applications |
| will use. |
| <p> |
| The locator will not start a distributed system. The locator will provide peer location |
| services only.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - The port on which the locator will listen for membership information requests from |
| new members</dd> |
| <dd><code>logFile</code> - The file to which the locator logs information. The directory that contains the |
| log file is used as the output directory of the locator (see <code>-dir</code> option to |
| the <code>gemfire</code> command).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly started locator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>port</code> is not in the range 0 to 65536</dd> |
| <dd><code><a href="../../../../org/apache/geode/SystemIsRunningException.html" title="class in org.apache.geode">SystemIsRunningException</a></code> - If another locator is already running in |
| <code>outputDir</code></dd> |
| <dd><code><a href="../../../../org/apache/geode/GemFireIOException.html" title="class in org.apache.geode">GemFireIOException</a></code> - If the directory containing the |
| <code>logFile</code> does not exist or cannot be written to</dd> |
| <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 the locator cannot be started</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startLocatorAndDS-int-java.io.File-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startLocatorAndDS</h4> |
| <pre>public static <a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a> startLocatorAndDS(int port, |
| <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> logFile, |
| <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> distributedSystemProperties) |
| 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">Starts a new distribution locator host by this VM, and an admin distributed system controlled |
| by the locator. The locator's listening sockets will bind to all network addresses. The locator |
| will use the given properties to start an AdminDistributedSystem. |
| <p> |
| The locator starts a AdminDistributedSystem configured with the given properties to provide the |
| system with a long-running process that can be relied on for stable membership information. The |
| locator will provide provide peer and cache server location services.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - The port on which the locator will listen for membership information requests from |
| new members</dd> |
| <dd><code>logFile</code> - The file to which the locator logs information. The directory that contains the |
| log file is used as the output directory of the locator (see <code>-dir</code> option to |
| the <code>gemfire</code> command).</dd> |
| <dd><code>distributedSystemProperties</code> - The properties used to configure the locator's distributed |
| system. If there are multiple locators in the system, this should note them in the |
| "locators" setting. If The distributed system is using multicast, the "mcast-port" |
| should also be set.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly started locator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>port</code> is not in the range 0 to 65536</dd> |
| <dd><code><a href="../../../../org/apache/geode/SystemIsRunningException.html" title="class in org.apache.geode">SystemIsRunningException</a></code> - If another locator is already running in |
| <code>outputDir</code></dd> |
| <dd><code><a href="../../../../org/apache/geode/GemFireIOException.html" title="class in org.apache.geode">GemFireIOException</a></code> - If the directory containing the |
| <code>logFile</code> does not exist or cannot be written to</dd> |
| <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 the locator cannot be started</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startLocator-int-java.io.File-java.net.InetAddress-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startLocator</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 <a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a> startLocator(int port, |
| <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> logFile, |
| <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">as of 7.0 use startLocatorAndDS instead.</span></div> |
| <div class="block">Starts a new distribution locator host by this VM. The locator will look for a |
| gemfire.properties file, or equivalent system properties to fill in the gaps in its |
| configuration. |
| <p> |
| The locator will not start a distributed system. The locator will provide peer location |
| services only.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - The port on which the locator will listen for membership information requests from |
| new members</dd> |
| <dd><code>logFile</code> - The file to which the locator logs information. The directory that contains the |
| log file is used as the output directory of the locator (see <code>-dir</code> option to |
| the <code>gemfire</code> command).</dd> |
| <dd><code>bindAddress</code> - The IP address to which the locator's socket binds</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly started locator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>port</code> is not in the range 0 to 65536</dd> |
| <dd><code><a href="../../../../org/apache/geode/SystemIsRunningException.html" title="class in org.apache.geode">SystemIsRunningException</a></code> - If another locator is already running in |
| <code>outputDir</code></dd> |
| <dd><code><a href="../../../../org/apache/geode/GemFireIOException.html" title="class in org.apache.geode">GemFireIOException</a></code> - If the directory containing the |
| <code>logFile</code> does not exist or cannot be written to</dd> |
| <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 the locator cannot be started</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startLocatorAndDS-int-java.io.File-java.net.InetAddress-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startLocatorAndDS</h4> |
| <pre>public static <a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a> startLocatorAndDS(int port, |
| <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> logFile, |
| <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, |
| <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> dsProperties) |
| 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">Starts a new distribution locator host by this VM that binds to the given network address. |
| <p> |
| The locator starts a AdminDistributedSystem configured with the given properties to provide the |
| system with a long-running process that can be relied on for stable membership information. The |
| locator will provide peer and cache server location services.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - The port on which the locator will listen for membership information requests from |
| new members</dd> |
| <dd><code>logFile</code> - The file to which the locator logs information. The directory that contains the |
| log file is used as the output directory of the locator (see <code>-dir</code> option to |
| the <code>gemfire</code> command).</dd> |
| <dd><code>bindAddress</code> - The IP address to which the locator's socket binds</dd> |
| <dd><code>dsProperties</code> - The properties used to configure the locator's DistributedSystem. If there |
| are multiple locators, the "locators" property should be set. If multicast is being |
| used, the "mcast-port" property should be set.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly started locator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>port</code> is not in the range 0 to 65536</dd> |
| <dd><code><a href="../../../../org/apache/geode/SystemIsRunningException.html" title="class in org.apache.geode">SystemIsRunningException</a></code> - If another locator is already running in |
| <code>outputDir</code></dd> |
| <dd><code><a href="../../../../org/apache/geode/GemFireIOException.html" title="class in org.apache.geode">GemFireIOException</a></code> - If the directory containing the |
| <code>logFile</code> does not exist or cannot be written to</dd> |
| <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 the locator cannot be started</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startLocatorAndDS-int-java.io.File-java.net.InetAddress-java.util.Properties-boolean-boolean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startLocatorAndDS</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 <a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a> startLocatorAndDS(int port, |
| <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> logFile, |
| <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, |
| <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> dsProperties, |
| boolean peerLocator, |
| boolean serverLocator, |
| <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> hostnameForClients) |
| 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">use a different startup method peerLocator and serverLocator parameters are ignored</span></div> |
| <div class="block">Starts a new distribution locator host by this VM that binds to the given network address. |
| <p> |
| The locator starts a AdminDistributedSystem configured with the given properties to provide the |
| system with a long-running process that can be relied on for stable membership information. The |
| locator will provide provide peer and cache server location services.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - The port on which the locator will listen for membership information requests from |
| new members</dd> |
| <dd><code>logFile</code> - The file to which the locator logs information. The directory that contains the |
| log file is used as the output directory of the locator (see <code>-dir</code> option to |
| the <code>gemfire</code> command).</dd> |
| <dd><code>bindAddress</code> - The IP address to which the locator's socket binds</dd> |
| <dd><code>dsProperties</code> - The properties used to configure the locator's DistributedSystem. If there |
| are multiple locators, the "locators" property should be set. If multicast is being |
| used, the "mcast-port" property should be set.</dd> |
| <dd><code>peerLocator</code> - True if the locator should provide membership information to peers in the |
| distributed system.</dd> |
| <dd><code>serverLocator</code> - True if the locator should provide information about cache servers to |
| clients connecting to the distributed system.</dd> |
| <dd><code>hostnameForClients</code> - the name to give to clients for connecting to this locator</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly started locator</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>port</code> is not in the range 0 to 65536 or |
| <code>peerLocator</code> and <code> serverLocator</code> are both false.</dd> |
| <dd><code><a href="../../../../org/apache/geode/SystemIsRunningException.html" title="class in org.apache.geode">SystemIsRunningException</a></code> - If another locator is already running in |
| <code>outputDir</code></dd> |
| <dd><code><a href="../../../../org/apache/geode/GemFireIOException.html" title="class in org.apache.geode">GemFireIOException</a></code> - If the directory containing the |
| <code>logFile</code> does not exist or cannot be written to</dd> |
| <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 the locator cannot be started</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7, GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocators--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocators</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 <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a>> getLocators()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 7.0 use <a href="../../../../org/apache/geode/distributed/Locator.html#getLocator--"><code>getLocator()</code></a> instead</span></div> |
| <div class="block">Returns an unmodifiable <code>List</code> of all of the <code>Locator</code>s that are hosted |
| by this VM.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an unmodifiable <code>List</code> of all of the <code>Locator</code>s that are hosted |
| by this VM</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocator</h4> |
| <pre>public static <a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed">Locator</a> getLocator()</pre> |
| <div class="block">Returns the locator if it exists in this JVM. Otherwise returns null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the locator that exists in this JVM; null if no locator.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasLocators--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasLocators</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 boolean hasLocators()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 7.0 use <a href="../../../../org/apache/geode/distributed/Locator.html#hasLocator--"><code>hasLocator()</code></a> instead.</span></div> |
| <div class="block">Examine the size of the collection of locators running in this VM</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of locators running in this VM</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasLocator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasLocator</h4> |
| <pre>public static boolean hasLocator()</pre> |
| <div class="block">Returns true if a locator exists in this JVM.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if a locator exists in this JVM.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre>public abstract <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">Returns the port on which this locator runs</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the port on which this locator runs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDistributedSystem--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDistributedSystem</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a> getDistributedSystem()</pre> |
| <div class="block">Returns the distributed system started by this locator, if any</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the distributed system started by this locator, if any</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLogFile--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLogFile</h4> |
| <pre>public <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> getLogFile()</pre> |
| <div class="block">Returns the log file to which this locator's output is written</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the log file to which this locator's output is written</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">Returns the IP address to which this locator's listening socket is bound.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the IP address to which this locator's listening socket is bound</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">Returns the hostname that will be given to clients so that they can connect to this locator. |
| Returns <code>null</code> if clients should use the bind address.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the hostname that will be given to clients so that they can connect to this locator</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPeerLocator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPeerLocator</h4> |
| <pre>public abstract boolean isPeerLocator()</pre> |
| <div class="block">Indicates whether the locator provides peer location services to members</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if peer location is enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isServerLocator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isServerLocator</h4> |
| <pre>public abstract boolean isServerLocator()</pre> |
| <div class="block">Indicates whether the locator provides server location services to clients</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if server location is enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>public abstract void stop()</pre> |
| <div class="block">Stops this distribution locator.</div> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</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> toString()</pre> |
| <div class="block">Returns a brief description of this <code>Locator</code></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a brief description of this <code>Locator</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="asString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asString</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> asString()</pre> |
| <div class="block">Get the string representation of this <code>Locator</code> in host[port] format.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the string representation of this <code>Locator</code> in host[port] format</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="main-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>main</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 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"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of Geode 1.4 use <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed"><code>"LocatorLauncher" to start a locator</code></a></span></div> |
| <div class="block">Starts a distribution locator from the command line. |
| <p> |
| This method of starting the locator is provided as an alternative to the <i>gemfire |
| start-locator</i> command to give you complete control over the java virtual machine's |
| configuration. |
| <p> |
| The <i>gemfire stop-locator</i> command can be used to stop a locator that is started with this |
| class. |
| <p> |
| java org.apache.geode.distributed.Locator port [bind-address] [gemfire-properties-file] [peer] |
| [server] |
| <p> |
| port - the tcp/ip port that the locator should listen on. This is the port number that |
| applications will refer to in their <i>locators</i> property in gemfire.properties |
| <p> |
| bind-address - the tcp/ip address that the locator should bind to. This can be missing or be an |
| empty string, which causes the locator to listen on all host addresses. |
| <p> |
| gemfire-properties-file - the location of a gemfire.properties file to be used in configuring |
| the locator's distributed system. This can be missing or be an empty string, which will cause |
| the locator to use the default search for gemfire.properties. |
| <p> |
| peer - true to start the peer locator service, false to disable it. If unspecified, default to |
| true. |
| <p> |
| server - true to start the cache server locator service, false to disable it. If unspecified, |
| defaults to true. |
| <p> |
| hostname-for-clients - the ip address or host name that clients will be told to use to connect |
| to this locator. If unspecified, defaults to the bind-address.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - the arguments to start the locator with</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/LeaseExpiredException.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/LocatorLauncher.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/Locator.html" target="_top">Frames</a></li> |
| <li><a href="Locator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
