| <!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.Builder (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="LocatorLauncher.Builder (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum 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.Builder.html" target="_top">Frames</a></li> |
| <li><a href="LocatorLauncher.Builder.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 LocatorLauncher.Builder" class="title">Class LocatorLauncher.Builder</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.LocatorLauncher.Builder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed">LocatorLauncher</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">LocatorLauncher.Builder</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">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> |
| </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 static <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.Builder.html#DEFAULT_COMMAND">DEFAULT_COMMAND</a></span></code> </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/LocatorLauncher.Builder.html#Builder--">Builder</a></span>()</code> |
| <div class="block">Default constructor used to create an instance of the Builder class for programmatical |
| access.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#Builder-java.lang.String...-">Builder</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">Constructor used to create and configure an instance of the Builder class with the specified |
| arguments, often passed from the command-line when launching an instance of this class from |
| the command-line using the Java launcher.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../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.Builder.html#build--">build</a></span>()</code> |
| <div class="block">Validates the Builder configuration settings and then constructs an instance of the |
| LocatorLauncher class to invoke operations on a Geode Locator.</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/LocatorLauncher.Builder.html#getBindAddress--">getBindAddress</a></span>()</code> |
| <div class="block">Gets the IP address to which the Locator has bound itself listening for client requests.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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.Builder.html#getCommand--">getCommand</a></span>()</code> |
| <div class="block">Gets the Locator launcher command used during the invocation of the LocatorLauncher.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getDebug--">getDebug</a></span>()</code> |
| <div class="block">Determines whether the new instance of the LocatorLauncher will be set to debug mode.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getDeletePidFileOnStop--">getDeletePidFileOnStop</a></span>()</code> |
| <div class="block">Determines whether the Geode Locator should delete the pid file when its service stops or |
| when the JVM exits.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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.Builder.html#getDistributedSystemProperties--">getDistributedSystemProperties</a></span>()</code> |
| <div class="block">Gets the Geode Distributed System (cluster) Properties configuration.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getForce--">getForce</a></span>()</code> |
| <div class="block">Gets the boolean value used by the Locator to determine if it should overwrite the PID file |
| if it already exists.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getHelp--">getHelp</a></span>()</code> |
| <div class="block">Determines whether the new instance of LocatorLauncher will be used to output help |
| information for either a specific command, or for using LocatorLauncher in general.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getHostnameForClients--">getHostnameForClients</a></span>()</code> |
| <div class="block">Gets the hostname used by clients to lookup the Locator.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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.Builder.html#getMemberName--">getMemberName</a></span>()</code> |
| <div class="block">Gets the member name of this Locator in Geode.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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.Builder.html#getPid--">getPid</a></span>()</code> |
| <div class="block">Gets the process ID (PID) of the running Locator indicated by the user as an argument to the |
| LocatorLauncher.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getPort--">getPort</a></span>()</code> |
| <div class="block">Gets the port number used by the Locator to listen for client requests.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getRedirectOutput--">getRedirectOutput</a></span>()</code> |
| <div class="block">Determines whether the new instance of LocatorLauncher will redirect output to system logs |
| when starting a 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.Builder.html#getWorkingDirectory--">getWorkingDirectory</a></span>()</code> |
| <div class="block">Gets the working directory pathname in which the Locator will be ran.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#parseArguments-java.lang.String...-">parseArguments</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">Parses an array of arguments to configure this Builder with the intent of constructing a |
| Locator launcher to invoke a Locator.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#parseCommand-java.lang.String...-">parseCommand</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">Iterates the list of arguments in search of the target Locator launcher command.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#parseMemberName-java.lang.String...-">parseMemberName</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">Iterates the list of arguments in search of the Locator's Geode member name.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#set-java.util.Properties-">set</a></span>(<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> properties)</code> |
| <div class="block">add the properties in the Geode Distributed System Property</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#set-java.lang.String-java.lang.String-">set</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> propertyName, |
| <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> propertyValue)</code> |
| <div class="block">Sets a Geode Distributed System Property.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setBindAddress-java.lang.String-">setBindAddress</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> addressString)</code> |
| <div class="block">Sets the IP address as an java.net.InetAddress to which the Locator has bound itself |
| listening for client requests.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setCommand-org.apache.geode.distributed.LocatorLauncher.Command-">setCommand</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">Sets the Locator launcher command used during the invocation of the LocatorLauncher</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setDebug-java.lang.Boolean-">setDebug</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> debug)</code> |
| <div class="block">Sets whether the new instance of the LocatorLauncher will be set to debug mode.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setDeletePidFileOnStop-java.lang.Boolean-">setDeletePidFileOnStop</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> deletePidFileOnStop)</code> |
| <div class="block">Sets whether the Geode Locator should delete the pid file when its service stops or when the |
| JVM exits.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setForce-java.lang.Boolean-">setForce</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> force)</code> |
| <div class="block">Sets the boolean value used by the Locator to determine if it should overwrite the PID file |
| if it already exists.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setHelp-java.lang.Boolean-">setHelp</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> help)</code> |
| <div class="block">Sets whether the new instance of LocatorLauncher will be used to output help information for |
| either a specific command, or for using LocatorLauncher in general.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setHostnameForClients-java.lang.String-">setHostnameForClients</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> hostnameForClients)</code> |
| <div class="block">Sets the hostname used by clients to lookup the Locator.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setMemberName-java.lang.String-">setMemberName</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> memberName)</code> |
| <div class="block">Sets the member name of the Locator in Geode.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setPid-java.lang.Integer-">setPid</a></span>(<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> pid)</code> |
| <div class="block">Sets the process ID (PID) of the running Locator indicated by the user as an argument to the |
| LocatorLauncher.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setPort-java.lang.Integer-">setPort</a></span>(<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> port)</code> |
| <div class="block">Sets the port number used by the Locator to listen for client requests.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setRedirectOutput-java.lang.Boolean-">setRedirectOutput</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> redirectOutput)</code> |
| <div class="block">Sets whether the new instance of LocatorLauncher will redirect output to system logs when |
| starting a Locator.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setWorkingDirectory-java.lang.String-">setWorkingDirectory</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> workingDirectory)</code> |
| <div class="block">Sets the working directory in which the Locator will be ran.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#validate--">validate</a></span>()</code> |
| <div class="block">Validates the configuration settings and properties of this Builder, ensuring that all |
| invariants have been met.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#validateOnStart--">validateOnStart</a></span>()</code> |
| <div class="block">Validates the arguments passed to the Builder when the 'start' command has been issued.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#validateOnStatus--">validateOnStatus</a></span>()</code> |
| <div class="block">Validates the arguments passed to the Builder when the 'status' command has been issued.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#validateOnStop--">validateOnStop</a></span>()</code> |
| <div class="block">Validates the arguments passed to the Builder when the 'stop' command has been issued.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_COMMAND"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_COMMAND</h4> |
| <pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a> |
| protected static final <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed">LocatorLauncher.Command</a> DEFAULT_COMMAND</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Builder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>public Builder()</pre> |
| <div class="block">Default constructor used to create an instance of the Builder class for programmatical |
| access.</div> |
| </li> |
| </ul> |
| <a name="Builder-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>public Builder(<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">Constructor used to create and configure an instance of the Builder class with the specified |
| arguments, often passed from the command-line when launching an instance of this class from |
| the command-line using the Java launcher.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - the array of arguments used to configure the Builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="parseArguments-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseArguments</h4> |
| <pre>protected void parseArguments(<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">Parses an array of arguments to configure this Builder with the intent of constructing a |
| Locator launcher to invoke a Locator. This method is called to parse the arguments specified |
| by the user on the command-line.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - the array of arguments used to configure this Builder and create an instance of |
| LocatorLauncher.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parseCommand-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseCommand</h4> |
| <pre>protected void parseCommand(<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">Iterates the list of arguments in search of the target Locator launcher command.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - an array of arguments from which to search for the Locator launcher command.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html#valueOfName-java.lang.String-"><code>LocatorLauncher.Command.valueOfName(String)</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#parseArguments-java.lang.String...-"><code>parseArguments(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parseMemberName-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parseMemberName</h4> |
| <pre>protected void parseMemberName(<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">Iterates the list of arguments in search of the Locator's Geode member name. If the |
| argument does not start with '-' or is not the name of a Locator launcher command, then the |
| value is presumed to be the member name for the Locator in Geode.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - the array of arguments from which to search for the Locator's member name in |
| Geode.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html#isCommand-java.lang.String-"><code>LocatorLauncher.Command.isCommand(String)</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#parseArguments-java.lang.String...-"><code>parseArguments(String...)</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">Gets the Locator launcher command used during the invocation of the LocatorLauncher.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Locator launcher command used to invoke (run) the LocatorLauncher class.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setCommand-org.apache.geode.distributed.LocatorLauncher.Command-"><code>setCommand(org.apache.geode.distributed.LocatorLauncher.Command)</code></a>, |
| <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="setCommand-org.apache.geode.distributed.LocatorLauncher.Command-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCommand</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setCommand(<a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum in org.apache.geode.distributed">LocatorLauncher.Command</a> command)</pre> |
| <div class="block">Sets the Locator launcher command used during the invocation of the LocatorLauncher</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the targeted Locator launcher command used during the invocation (run) of |
| LocatorLauncher.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getCommand--"><code>getCommand()</code></a>, |
| <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="getDebug--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDebug</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> getDebug()</pre> |
| <div class="block">Determines whether the new instance of the LocatorLauncher will be set to debug mode.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating whether debug mode is enabled or disabled.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setDebug-java.lang.Boolean-"><code>setDebug(Boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDebug-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDebug</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setDebug(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> debug)</pre> |
| <div class="block">Sets whether the new instance of the LocatorLauncher will be set to debug mode.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>debug</code> - a boolean value indicating whether debug mode is to be enabled or disabled.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getDebug--"><code>getDebug()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeletePidFileOnStop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeletePidFileOnStop</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> getDeletePidFileOnStop()</pre> |
| <div class="block">Determines whether the Geode Locator should delete the pid file when its service stops or |
| when the JVM exits.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating if the pid file should be deleted when this service stops |
| or when the JVM exits.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setDeletePidFileOnStop-java.lang.Boolean-"><code>setDeletePidFileOnStop(Boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDeletePidFileOnStop-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeletePidFileOnStop</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setDeletePidFileOnStop(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> deletePidFileOnStop)</pre> |
| <div class="block">Sets whether the Geode Locator should delete the pid file when its service stops or when the |
| JVM exits.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deletePidFileOnStop</code> - a boolean value indicating if the pid file should be deleted when |
| this service stops or when the JVM exits.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getDeletePidFileOnStop--"><code>getDeletePidFileOnStop()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDistributedSystemProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDistributedSystemProperties</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> getDistributedSystemProperties()</pre> |
| <div class="block">Gets the Geode Distributed System (cluster) Properties configuration.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Properties object containing 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="getForce--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForce</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> getForce()</pre> |
| <div class="block">Gets the boolean value used by the Locator to determine if it should overwrite the PID file |
| if it already exists.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the boolean value specifying whether or not to overwrite the PID file if it already |
| exists.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setForce-java.lang.Boolean-"><code>setForce(Boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setForce-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForce</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setForce(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> force)</pre> |
| <div class="block">Sets the boolean value used by the Locator to determine if it should overwrite the PID file |
| if it already exists.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>force</code> - a boolean value indicating whether to overwrite the PID file when it already |
| exists.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getForce--"><code>getForce()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHelp--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHelp</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> getHelp()</pre> |
| <div class="block">Determines whether the new instance of LocatorLauncher will be used to output help |
| information for either a specific command, or for using LocatorLauncher in general.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating whether help will be output during the invocation of |
| LocatorLauncher.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setHelp-java.lang.Boolean-"><code>setHelp(Boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHelp-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHelp</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setHelp(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> help)</pre> |
| <div class="block">Sets whether the new instance of LocatorLauncher will be used to output help information for |
| either a specific command, or for using LocatorLauncher in general.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>help</code> - a boolean indicating whether help information is to be displayed during |
| invocation of LocatorLauncher.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getHelp--"><code>getHelp()</code></a></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 to which the Locator has bound itself listening for client requests.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an InetAddress with the IP address or hostname on which the Locator is bound and |
| listening.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setBindAddress-java.lang.String-"><code>setBindAddress(String)</code></a>, |
| <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="setBindAddress-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBindAddress</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setBindAddress(<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> addressString)</pre> |
| <div class="block">Sets the IP address as an java.net.InetAddress to which the Locator has bound itself |
| listening for client requests.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>addressString</code> - the InetAddress with the IP address or hostname on which the Locator is |
| bound and listening.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</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> - wrapping the UnknownHostException if the IP address or |
| hostname for the bind address is unknown.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getBindAddress--"><code>getBindAddress()</code></a>, |
| <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="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 used by clients to lookup the Locator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String indicating the hostname Locator binding used in client lookups.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setHostnameForClients-java.lang.String-"><code>setHostnameForClients(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHostnameForClients-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHostnameForClients</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setHostnameForClients(<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">Sets the hostname used by clients to lookup the Locator.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hostnameForClients</code> - a String indicating the hostname Locator binding used in client |
| lookups.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</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 the hostname was not specified (is blank or empty), such |
| as when the --hostname-for-clients command-line option may have been specified |
| without any argument.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getHostnameForClients--"><code>getHostnameForClients()</code></a></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 member name of this Locator in Geode.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String indicating the member name of this Locator in Geode.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setMemberName-java.lang.String-"><code>setMemberName(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMemberName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMemberName</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setMemberName(<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> memberName)</pre> |
| <div class="block">Sets the member name of the Locator in Geode.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>memberName</code> - a String indicating the member name of this Locator in Geode.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</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 the member name is invalid.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getMemberName--"><code>getMemberName()</code></a></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 process ID (PID) of the running Locator indicated by the user as an argument to the |
| LocatorLauncher. This PID is used by the Locator launcher to determine the Locator's status, |
| or invoke shutdown on the Locator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a user specified Integer value indicating the process ID of the running Locator.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setPid-java.lang.Integer-"><code>setPid(Integer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPid-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPid</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setPid(<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> pid)</pre> |
| <div class="block">Sets the process ID (PID) of the running Locator indicated by the user as an argument to the |
| LocatorLauncher. This PID will be used by the Locator launcher to determine the Locator's |
| status, or invoke shutdown on the Locator.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pid</code> - a user specified Integer value indicating the process ID of the running Locator.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</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 the process ID (PID) is not valid (greater than zero if |
| not null).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getPid--"><code>getPid()</code></a></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 used by the Locator to listen for client requests. If the port was not |
| specified, then the default Locator port (10334) is returned.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the specified Locator port or the default port if unspecified.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setPort-java.lang.Integer-"><code>setPort(Integer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPort-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPort</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setPort(<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> port)</pre> |
| <div class="block">Sets the port number used by the Locator to listen for client requests. The port number must |
| be between 1 and 65535 inclusive.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - an Integer value indicating the port used by the Locator to listen for client |
| requests.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</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 the port number is not valid.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getPort--"><code>getPort()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRedirectOutput--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRedirectOutput</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> getRedirectOutput()</pre> |
| <div class="block">Determines whether the new instance of LocatorLauncher will redirect output to system logs |
| when starting a Locator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating if output will be redirected to system logs when starting |
| a Locator</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setRedirectOutput-java.lang.Boolean-"><code>setRedirectOutput(Boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRedirectOutput-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRedirectOutput</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setRedirectOutput(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> redirectOutput)</pre> |
| <div class="block">Sets whether the new instance of LocatorLauncher will redirect output to system logs when |
| starting a Locator.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>redirectOutput</code> - a boolean value indicating if output will be redirected to system logs |
| when starting a Locator.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getRedirectOutput--"><code>getRedirectOutput()</code></a></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 ran. If the directory is |
| unspecified, then working directory defaults to the current directory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String indicating the working directory pathname.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#setWorkingDirectory-java.lang.String-"><code>setWorkingDirectory(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWorkingDirectory-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWorkingDirectory</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> setWorkingDirectory(<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> workingDirectory)</pre> |
| <div class="block">Sets the working directory in which the Locator will be ran. This also the directory in which |
| all Locator files (such as log and license files) will be written. If the directory is |
| unspecified, then the working directory defaults to the current directory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>workingDirectory</code> - a String indicating the pathname of the directory in which the |
| Locator will be ran.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</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> - wrapping a FileNotFoundException if the working directory |
| pathname cannot be found.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#getWorkingDirectory--"><code>getWorkingDirectory()</code></a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io"><code>FileNotFoundException</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="set-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> set(<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> propertyName, |
| <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> propertyValue)</pre> |
| <div class="block">Sets a Geode Distributed System Property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propertyName</code> - a String indicating the name of the Geode Distributed System property |
| as described in <a href="../../../../org/apache/geode/distributed/ConfigurationProperties.html" title="interface in org.apache.geode.distributed"><code>ConfigurationProperties</code></a></dd> |
| <dd><code>propertyValue</code> - a String value for the Geode Distributed System property.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="set-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html" title="class in org.apache.geode.distributed">LocatorLauncher.Builder</a> set(<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> properties)</pre> |
| <div class="block">add the properties in the Geode Distributed System Property</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - a property object that holds one or more Geode Distributed System |
| properties as described in <a href="../../../../org/apache/geode/distributed/ConfigurationProperties.html" title="interface in org.apache.geode.distributed"><code>ConfigurationProperties</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.12</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void validate()</pre> |
| <div class="block">Validates the configuration settings and properties of this Builder, ensuring that all |
| invariants have been met. Currently, the only invariant constraining the Builder is that the |
| user must specify the member name for the Locator in the Geode distributed system as a |
| command-line argument, or by setting the memberName property programmatically using the |
| corresponding setter method. If the member name is not given, then the user must have |
| specified the pathname to the gemfire.properties file before validate is called. It is then |
| assumed, but not further validated, that the user has specified the Locator's member name in |
| the properties file.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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 Builder is not properly configured.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateOnStart--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateOnStart</h4> |
| <pre>protected void validateOnStart()</pre> |
| <div class="block">Validates the arguments passed to the Builder when the 'start' command has been issued.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html#START"><code>LocatorLauncher.Command.START</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateOnStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateOnStatus</h4> |
| <pre>protected void validateOnStatus()</pre> |
| <div class="block">Validates the arguments passed to the Builder when the 'status' command has been issued.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html#STATUS"><code>LocatorLauncher.Command.STATUS</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateOnStop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateOnStop</h4> |
| <pre>protected void validateOnStop()</pre> |
| <div class="block">Validates the arguments passed to the Builder when the 'stop' command has been issued.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html#STOP"><code>LocatorLauncher.Command.STOP</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed">LocatorLauncher</a> build()</pre> |
| <div class="block">Validates the Builder configuration settings and then constructs an instance of the |
| LocatorLauncher class to invoke operations on a Geode Locator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly constructed instance of LocatorLauncher configured with this Builder.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Builder.html#validate--"><code>validate()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed"><code>LocatorLauncher</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </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/LocatorLauncher.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/LocatorLauncher.Command.html" title="enum 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.Builder.html" target="_top">Frames</a></li> |
| <li><a href="LocatorLauncher.Builder.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> |