| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ServerLauncher.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="ServerLauncher.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,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":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/ServerLauncher.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/ServerLauncher.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/ServerLauncher.Builder.html" target="_top">Frames</a></li> |
| <li><a href="ServerLauncher.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 ServerLauncher.Builder" class="title">Class ServerLauncher.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.ServerLauncher.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/ServerLauncher.html" title="class in org.apache.geode.distributed">ServerLauncher</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">ServerLauncher.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">The Builder class, modeled after the Builder creational design pattern, is used to construct a |
| properly configured and initialized instance of the ServerLauncher to control and run Geode |
| servers (in particular, cache servers).</div> |
| </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/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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/ServerLauncher.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/ServerLauncher.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, passed in 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/ServerLauncher.html" title="class in org.apache.geode.distributed">ServerLauncher</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#build--">build</a></span>()</code> |
| <div class="block">Validates the Builder configuration settings and then constructs an instance of the |
| ServerLauncher class to invoke operations on a Geode Server.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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/ServerLauncher.Builder.html#getAssignBuckets--">getAssignBuckets</a></span>()</code> |
| <div class="block">Determines whether buckets should be assigned to partitioned regions in the cache upon Server |
| start.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getCommand--">getCommand</a></span>()</code> |
| <div class="block">Gets the Server launcher command used during the invocation of the ServerLauncher.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getCriticalHeapPercentage--">getCriticalHeapPercentage</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getCriticalOffHeapPercentage--">getCriticalOffHeapPercentage</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/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/ServerLauncher.Builder.html#getDebug--">getDebug</a></span>()</code> |
| <div class="block">Determines whether the new instance of the ServerLauncher will be set to debug mode.</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/ServerLauncher.Builder.html#getDeletePidFileOnStop--">getDeletePidFileOnStop</a></span>()</code> |
| <div class="block">Determines whether the Geode Server should delete the pid file when its service stops or when |
| the JVM exits.</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/ServerLauncher.Builder.html#getDisableDefaultServer--">getDisableDefaultServer</a></span>()</code> |
| <div class="block">Determines whether a default cache server will be added when the Geode Server comes online.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getDistributedSystemProperties--">getDistributedSystemProperties</a></span>()</code> |
| <div class="block">Gets the Geode Distributed System (cluster) Properties configuration.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getEvictionHeapPercentage--">getEvictionHeapPercentage</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getEvictionOffHeapPercentage--">getEvictionOffHeapPercentage</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" 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/ServerLauncher.Builder.html#getForce--">getForce</a></span>()</code> |
| <div class="block">Gets the boolean value used by the Server to determine if it should overwrite the PID file if |
| it already exists.</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/ServerLauncher.Builder.html#getHelp--">getHelp</a></span>()</code> |
| <div class="block">Determines whether the new instance of the ServerLauncher will be used to output help |
| information for either a specific command, or for using ServerLauncher in general.</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/ServerLauncher.Builder.html#getHostNameForClients--">getHostNameForClients</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getMaxConnections--">getMaxConnections</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getMaxMessageCount--">getMaxMessageCount</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getMaxThreads--">getMaxThreads</a></span>()</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getMemberName--">getMemberName</a></span>()</code> |
| <div class="block">Gets the member name of this Server in Geode.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getMessageTimeToLive--">getMessageTimeToLive</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getPid--">getPid</a></span>()</code> |
| <div class="block">Gets the process ID (PID) of the running Server indicated by the user as an argument to the |
| ServerLauncher.</div> |
| </td> |
| </tr> |
| <tr id="i20" 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/ServerLauncher.Builder.html#getRebalance--">getRebalance</a></span>()</code> |
| <div class="block">Determines whether a rebalance operation on the cache will occur upon starting the Geode |
| server.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/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/ServerLauncher.Builder.html#getRedirectOutput--">getRedirectOutput</a></span>()</code> |
| <div class="block">Determines whether the new instance of ServerLauncher will redirect output to system logs |
| when starting a Server.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getServerBindAddress--">getServerBindAddress</a></span>()</code> |
| <div class="block">Gets the IP address to which the Server will be bound listening for and accepting cache |
| client connections in a client/server topology.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getServerPort--">getServerPort</a></span>()</code> |
| <div class="block">Gets the port on which the Server will listen for and accept cache client connections in a |
| client/server topology.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getSocketBufferSize--">getSocketBufferSize</a></span>()</code> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getSpringXmlLocation--">getSpringXmlLocation</a></span>()</code> |
| <div class="block">Gets the location of the Spring XML configuration meta-data file used to bootstrap, configure |
| and initialize the Geode Server on start.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getWorkingDirectory--">getWorkingDirectory</a></span>()</code> |
| <div class="block">Gets the working directory pathname in which the Server will be ran.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#isHelping--">isHelping</a></span>()</code> |
| <div class="block">Determines whether help has been enabled.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 Server launcher command.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 Server's Geode member name.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 Gemfire Distributed System Property</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setAssignBuckets-java.lang.Boolean-">setAssignBuckets</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> assignBuckets)</code> |
| <div class="block">Sets whether buckets should be assigned to partitioned regions in the cache upon Server |
| start.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setCommand-org.apache.geode.distributed.ServerLauncher.Command-">setCommand</a></span>(<a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a> command)</code> |
| <div class="block">Sets the Sever launcher command used during the invocation of the ServerLauncher</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setCriticalHeapPercentage-java.lang.Float-">setCriticalHeapPercentage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> criticalHeapPercentage)</code> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setCriticalOffHeapPercentage-java.lang.Float-">setCriticalOffHeapPercentage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> criticalOffHeapPercentage)</code> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 ServerLauncher will be set to debug mode.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 Server should delete the pid file when its service stops or when the |
| JVM exits.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setDisableDefaultServer-java.lang.Boolean-">setDisableDefaultServer</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> disableDefaultServer)</code> |
| <div class="block">Sets a boolean value indicating whether to add a default cache when the Geode Server comes |
| online.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setEvictionHeapPercentage-java.lang.Float-">setEvictionHeapPercentage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> evictionHeapPercentage)</code> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setEvictionOffHeapPercentage-java.lang.Float-">setEvictionOffHeapPercentage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> evictionOffHeapPercentage)</code> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 Server to determine if it should overwrite the PID file if |
| it already exists.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 ServerLauncher will be used to output help information for |
| either a specific command, or for using ServerLauncher in general.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setMaxConnections-java.lang.Integer-">setMaxConnections</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> maxConnections)</code> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setMaxMessageCount-java.lang.Integer-">setMaxMessageCount</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> maxMessageCount)</code> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setMaxThreads-java.lang.Integer-">setMaxThreads</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> maxThreads)</code> </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 Server in Geode.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setMessageTimeToLive-java.lang.Integer-">setMessageTimeToLive</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> messageTimeToLive)</code> </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setPdxDiskStore-java.lang.String-">setPdxDiskStore</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> pdxDiskStore)</code> |
| <div class="block">Sets the Geode Disk Store to be used to persist PDX type meta-data.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setPdxIgnoreUnreadFields-boolean-">setPdxIgnoreUnreadFields</a></span>(boolean ignore)</code> |
| <div class="block">Sets whether fields in the PDX instance should be ignored when unread.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setPdxPersistent-boolean-">setPdxPersistent</a></span>(boolean persistent)</code> |
| <div class="block">Sets whether the PDX type meta-data should be persisted to disk.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setPdxReadSerialized-boolean-">setPdxReadSerialized</a></span>(boolean readSerialized)</code> |
| <div class="block">Sets whether PDX instances should be returned as is when Region.get(key:String):Object is |
| called.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setPdxSerializer-org.apache.geode.pdx.PdxSerializer-">setPdxSerializer</a></span>(<a href="../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx">PdxSerializer</a> pdxSerializer)</code> |
| <div class="block">Set the PdxSerializer to use to serialize POJOs to the Geode Cache Region or when sent |
| between peers, client/server, or during persistence to disk.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 Server indicated by the user as an argument to the |
| ServerLauncher.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setRebalance-java.lang.Boolean-">setRebalance</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> rebalance)</code> |
| <div class="block">Set a boolean value indicating whether a rebalance operation on the cache should occur upon |
| starting the Geode server.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 ServerLauncher will redirect output to system logs when |
| starting a Server.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setServerBindAddress-java.lang.String-">setServerBindAddress</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> serverBindAddress)</code> |
| <div class="block">Sets the IP address to which the Server will be bound listening for and accepting cache |
| client connections in a client/server topology.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setServerPort-java.lang.Integer-">setServerPort</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> serverPort)</code> |
| <div class="block">Sets the port on which the Server will listen for and accept cache client connections in a |
| client/server topology.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setSocketBufferSize-java.lang.Integer-">setSocketBufferSize</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> socketBufferSize)</code> </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setSpringXmlLocation-java.lang.String-">setSpringXmlLocation</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> springXmlLocation)</code> |
| <div class="block">Sets the location of the Spring XML configuration meta-data file used to bootstrap, configure |
| and initialize the Geode Server on start.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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 Server will be ran.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/ServerLauncher.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> |
| </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/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.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, passed in 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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#parseArguments-java.lang.String...-"><code>parseArguments(String...)</code></a></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="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 Server 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 Server launcher command.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html#valueOfName-java.lang.String-"><code>ServerLauncher.Command.valueOfName(String)</code></a>, |
| <a href="../../../../org/apache/geode/distributed/ServerLauncher.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 Server's Geode member name. If the argument |
| does not start with '-' or is not the name of a Server launcher command, then the value is |
| presumed to be the member name for the Server 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 Server's member name in |
| Geode.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html#isCommand-java.lang.String-"><code>ServerLauncher.Command.isCommand(String)</code></a>, |
| <a href="../../../../org/apache/geode/distributed/ServerLauncher.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/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a> getCommand()</pre> |
| <div class="block">Gets the Server launcher command used during the invocation of the ServerLauncher.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Server launcher command used to invoke (run) the ServerLauncher class.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setCommand-org.apache.geode.distributed.ServerLauncher.Command-"><code>setCommand(ServerLauncher.Command)</code></a>, |
| <a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed"><code>ServerLauncher.Command</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCommand-org.apache.geode.distributed.ServerLauncher.Command-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCommand</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setCommand(<a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed">ServerLauncher.Command</a> command)</pre> |
| <div class="block">Sets the Sever launcher command used during the invocation of the ServerLauncher</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the targeted Server launcher command used during the invocation (run) of |
| ServerLauncher.</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/ServerLauncher.Builder.html#getCommand--"><code>getCommand()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/ServerLauncher.Command.html" title="enum in org.apache.geode.distributed"><code>ServerLauncher.Command</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAssignBuckets--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAssignBuckets</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> getAssignBuckets()</pre> |
| <div class="block">Determines whether buckets should be assigned to partitioned regions in the cache upon Server |
| start.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean indicating if buckets should be assigned upon Server start.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setAssignBuckets-java.lang.Boolean-"><code>setAssignBuckets(Boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAssignBuckets-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAssignBuckets</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setAssignBuckets(<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> assignBuckets)</pre> |
| <div class="block">Sets whether buckets should be assigned to partitioned regions in the cache upon Server |
| start.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>assignBuckets</code> - a boolean indicating if buckets should be assigned upon Server start.</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/ServerLauncher.Builder.html#getAssignBuckets--"><code>getAssignBuckets()</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 ServerLauncher 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/ServerLauncher.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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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 ServerLauncher 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/ServerLauncher.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 Server 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/ServerLauncher.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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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 Server 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/ServerLauncher.Builder.html#getDeletePidFileOnStop--"><code>getDeletePidFileOnStop()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDisableDefaultServer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDisableDefaultServer</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> getDisableDefaultServer()</pre> |
| <div class="block">Determines whether a default cache server will be added when the Geode Server comes online.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean value indicating whether to add a default cache server.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setDisableDefaultServer-java.lang.Boolean-"><code>setDisableDefaultServer(Boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDisableDefaultServer-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDisableDefaultServer</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setDisableDefaultServer(<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> disableDefaultServer)</pre> |
| <div class="block">Sets a boolean value indicating whether to add a default cache when the Geode Server comes |
| online.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>disableDefaultServer</code> - a boolean value indicating whether to add a default cache server.</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/ServerLauncher.Builder.html#getDisableDefaultServer--"><code>getDisableDefaultServer()</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 Server 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/ServerLauncher.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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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 Server 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/ServerLauncher.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 the ServerLauncher will be used to output help |
| information for either a specific command, or for using ServerLauncher 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 the |
| ServerLauncher.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setHelp-java.lang.Boolean-"><code>setHelp(Boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isHelping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHelping</h4> |
| <pre>protected boolean isHelping()</pre> |
| <div class="block">Determines whether help has been enabled.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean indicating if help was enabled.</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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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 ServerLauncher will be used to output help information for |
| either a specific command, or for using ServerLauncher 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 ServerLauncher.</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/ServerLauncher.Builder.html#getHelp--"><code>getHelp()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRebalance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRebalance</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> getRebalance()</pre> |
| <div class="block">Determines whether a rebalance operation on the cache will occur upon starting the Geode |
| server.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a boolean indicating if the cache will be rebalance when the Geode server starts.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setRebalance-java.lang.Boolean-"><code>setRebalance(Boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRebalance-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRebalance</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setRebalance(<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> rebalance)</pre> |
| <div class="block">Set a boolean value indicating whether a rebalance operation on the cache should occur upon |
| starting the Geode server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rebalance</code> - a boolean indicating if the cache will be rebalanced when the Geode server |
| starts.</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/ServerLauncher.Builder.html#getRebalance--"><code>getRebalance()</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 Server in Geode.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String indicating the member name of this Server in Geode.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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 Server in Geode.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>memberName</code> - a String indicating the member name of this Server 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/ServerLauncher.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 Server indicated by the user as an argument to the |
| ServerLauncher. This PID is used by the Server launcher to determine the Server's status, or |
| invoke shutdown on the Server.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a user specified Integer value indicating the process ID of the running Server.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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 Server indicated by the user as an argument to the |
| ServerLauncher. This PID will be used by the Server launcher to determine the Server's |
| status, or invoke shutdown on the Server.</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 Server.</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/ServerLauncher.Builder.html#getPid--"><code>getPid()</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 ServerLauncher will redirect output to system logs |
| when starting a Server.</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 Server</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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 ServerLauncher will redirect output to system logs when |
| starting a Server.</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 Server.</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/ServerLauncher.Builder.html#getRedirectOutput--"><code>getRedirectOutput()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerBindAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerBindAddress</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> getServerBindAddress()</pre> |
| <div class="block">Gets the IP address to which the Server will be bound listening for and accepting cache |
| client connections in a client/server topology.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an InetAddress indicating the IP address that the Server is bound to listening for |
| and accepting cache client connections in a client/server topology.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setServerBindAddress-java.lang.String-"><code>setServerBindAddress(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setServerBindAddress-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServerBindAddress</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setServerBindAddress(<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> serverBindAddress)</pre> |
| <div class="block">Sets the IP address to which the Server will be bound listening for and accepting cache |
| client connections in a client/server topology.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serverBindAddress</code> - a String specifying the IP address or hostname that the Server will |
| be bound to listen for and accept cache client connections in a client/server |
| topology.</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 server bind address is unknown.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#getServerBindAddress--"><code>getServerBindAddress()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServerPort--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerPort</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getServerPort()</pre> |
| <div class="block">Gets the port on which the Server will listen for and accept cache client connections in a |
| client/server topology.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Integer value specifying the port the Server will listen on and accept cache |
| client connections in a client/server topology.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setServerPort-java.lang.Integer-"><code>setServerPort(Integer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setServerPort-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServerPort</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setServerPort(<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> serverPort)</pre> |
| <div class="block">Sets the port on which the Server will listen for and accept cache client connections in a |
| client/server topology.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serverPort</code> - an Integer value specifying the port the Server will listen on and accept |
| cache client connections in a client/server topology.</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/ServerLauncher.Builder.html#getServerPort--"><code>getServerPort()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSpringXmlLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpringXmlLocation</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSpringXmlLocation()</pre> |
| <div class="block">Gets the location of the Spring XML configuration meta-data file used to bootstrap, configure |
| and initialize the Geode Server on start. |
| <p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String indicating the location of the Spring XML configuration file.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#setSpringXmlLocation-java.lang.String-"><code>setSpringXmlLocation(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSpringXmlLocation-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSpringXmlLocation</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setSpringXmlLocation(<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> springXmlLocation)</pre> |
| <div class="block">Sets the location of the Spring XML configuration meta-data file used to bootstrap, configure |
| and initialize the Geode Server on start. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>springXmlLocation</code> - a String indicating the location of the Spring XML configuration |
| file.</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/ServerLauncher.Builder.html#getSpringXmlLocation--"><code>getSpringXmlLocation()</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 Server 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/ServerLauncher.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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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 Server will be ran. This also the directory in which |
| all Server 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 Server |
| 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/ServerLauncher.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="getCriticalHeapPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCriticalHeapPercentage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> getCriticalHeapPercentage()</pre> |
| </li> |
| </ul> |
| <a name="setCriticalHeapPercentage-java.lang.Float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCriticalHeapPercentage</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setCriticalHeapPercentage(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> criticalHeapPercentage)</pre> |
| </li> |
| </ul> |
| <a name="getCriticalOffHeapPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCriticalOffHeapPercentage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> getCriticalOffHeapPercentage()</pre> |
| </li> |
| </ul> |
| <a name="setCriticalOffHeapPercentage-java.lang.Float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCriticalOffHeapPercentage</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setCriticalOffHeapPercentage(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> criticalOffHeapPercentage)</pre> |
| </li> |
| </ul> |
| <a name="getEvictionHeapPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictionHeapPercentage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> getEvictionHeapPercentage()</pre> |
| </li> |
| </ul> |
| <a name="setEvictionHeapPercentage-java.lang.Float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEvictionHeapPercentage</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setEvictionHeapPercentage(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> evictionHeapPercentage)</pre> |
| </li> |
| </ul> |
| <a name="getEvictionOffHeapPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictionOffHeapPercentage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> getEvictionOffHeapPercentage()</pre> |
| </li> |
| </ul> |
| <a name="setEvictionOffHeapPercentage-java.lang.Float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEvictionOffHeapPercentage</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setEvictionOffHeapPercentage(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> evictionOffHeapPercentage)</pre> |
| </li> |
| </ul> |
| <a name="getHostNameForClients--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostNameForClients</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getHostNameForClients()</pre> |
| </li> |
| </ul> |
| <a name="setHostNameForClients-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHostNameForClients</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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> |
| </li> |
| </ul> |
| <a name="getMaxConnections--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxConnections</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getMaxConnections()</pre> |
| </li> |
| </ul> |
| <a name="setMaxConnections-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxConnections</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setMaxConnections(<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> maxConnections)</pre> |
| </li> |
| </ul> |
| <a name="getMaxMessageCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxMessageCount</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getMaxMessageCount()</pre> |
| </li> |
| </ul> |
| <a name="setMaxMessageCount-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxMessageCount</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setMaxMessageCount(<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> maxMessageCount)</pre> |
| </li> |
| </ul> |
| <a name="getMaxThreads--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxThreads</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getMaxThreads()</pre> |
| </li> |
| </ul> |
| <a name="setMaxThreads-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxThreads</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setMaxThreads(<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> maxThreads)</pre> |
| </li> |
| </ul> |
| <a name="getMessageTimeToLive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageTimeToLive</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getMessageTimeToLive()</pre> |
| </li> |
| </ul> |
| <a name="setMessageTimeToLive-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMessageTimeToLive</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setMessageTimeToLive(<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> messageTimeToLive)</pre> |
| </li> |
| </ul> |
| <a name="getSocketBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSocketBufferSize</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getSocketBufferSize()</pre> |
| </li> |
| </ul> |
| <a name="setSocketBufferSize-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSocketBufferSize</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setSocketBufferSize(<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> socketBufferSize)</pre> |
| </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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.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 Gemfire Distributed System Property</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - a property object that holds one or more Gemfire 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="setPdxPersistent-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPdxPersistent</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setPdxPersistent(boolean persistent)</pre> |
| <div class="block">Sets whether the PDX type meta-data should be persisted to disk.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>persistent</code> - a boolean indicating whether PDX type meta-data should be persisted to |
| disk.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPdxDiskStore-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPdxDiskStore</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setPdxDiskStore(<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> pdxDiskStore)</pre> |
| <div class="block">Sets the Geode Disk Store to be used to persist PDX type meta-data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pdxDiskStore</code> - a String indicating the name of the Geode Disk Store to use to store |
| PDX type meta-data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPdxIgnoreUnreadFields-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPdxIgnoreUnreadFields</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setPdxIgnoreUnreadFields(boolean ignore)</pre> |
| <div class="block">Sets whether fields in the PDX instance should be ignored when unread.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ignore</code> - a boolean indicating whether unread fields in the PDX instance should be |
| ignored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPdxReadSerialized-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPdxReadSerialized</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setPdxReadSerialized(boolean readSerialized)</pre> |
| <div class="block">Sets whether PDX instances should be returned as is when Region.get(key:String):Object is |
| called.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>readSerialized</code> - a boolean indicating whether the PDX instance should be returned from a |
| call to Region.get(key:String):Object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPdxSerializer-org.apache.geode.pdx.PdxSerializer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPdxSerializer</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html" title="class in org.apache.geode.distributed">ServerLauncher.Builder</a> setPdxSerializer(<a href="../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx">PdxSerializer</a> pdxSerializer)</pre> |
| <div class="block">Set the PdxSerializer to use to serialize POJOs to the Geode Cache Region or when sent |
| between peers, client/server, or during persistence to disk.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pdxSerializer</code> - the PdxSerializer that is used to serialize application domain objects |
| into PDX.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Builder instance.</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 Server in the Geode distributed system as a |
| command-line argument, or by setting the memberName property programmatically using the |
| corresponding setter method.</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="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../org/apache/geode/distributed/ServerLauncher.html" title="class in org.apache.geode.distributed">ServerLauncher</a> build()</pre> |
| <div class="block">Validates the Builder configuration settings and then constructs an instance of the |
| ServerLauncher class to invoke operations on a Geode Server.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly constructed instance of the ServerLauncher configured with this Builder.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/distributed/ServerLauncher.Builder.html#validate--"><code>validate()</code></a>, |
| <a href="../../../../org/apache/geode/distributed/ServerLauncher.html" title="class in org.apache.geode.distributed"><code>ServerLauncher</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </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/ServerLauncher.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/distributed/ServerLauncher.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/ServerLauncher.Builder.html" target="_top">Frames</a></li> |
| <li><a href="ServerLauncher.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> |