blob: 60f636a5e21ec1b17e18498b620c18f5948fc630 [file] [log] [blame]
<!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>AbstractLauncher (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="AbstractLauncher (Apache Geode 1.15.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":6,"i9":10,"i10":10,"i11":10,"i12":6,"i13":6,"i14":10,"i15":10,"i16":10,"i17":10,"i18":9,"i19":9,"i20":10,"i21":10,"i22":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/geode/distributed/AbstractLauncher.ServiceState.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/distributed/AbstractLauncher.html" target="_top">Frames</a></li>
<li><a href="AbstractLauncher.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 AbstractLauncher" class="title">Class AbstractLauncher&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;T&gt;&gt;</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.AbstractLauncher&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/geode/distributed/LocatorLauncher.html" title="class in org.apache.geode.distributed">LocatorLauncher</a>, <a href="../../../../org/apache/geode/distributed/ServerLauncher.html" title="class in org.apache.geode.distributed">ServerLauncher</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractLauncher&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;T&gt;&gt;</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>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></pre>
<div class="block">The AbstractLauncher class is a base class for implementing various launchers to construct and
run different GemFire processes, like Cache Servers, Locators, Managers, HTTP servers and so on.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 7.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang"><code>Runnable</code></a>,
<a href="../../../../org/apache/geode/lang/Identifiable.html" title="interface in org.apache.geode.lang"><code>Identifiable</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.ServiceState.html" title="class in org.apache.geode.distributed">AbstractLauncher.ServiceState</a>&lt;<a href="../../../../org/apache/geode/distributed/AbstractLauncher.ServiceState.html" title="type parameter in AbstractLauncher.ServiceState">T</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../org/apache/geode/distributed/AbstractLauncher.ServiceState.html" title="type parameter in AbstractLauncher.ServiceState">T</a>&gt;&gt;</span></code>
<div class="block">The ServiceState is an immutable type representing the state of the specified Locator at any
given moment in time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.Status.html" title="enum in org.apache.geode.distributed">AbstractLauncher.Status</a></span></code>
<div class="block">The Status enumerated type represents the various lifecycle states of a GemFire service (such
as a Cache Server, a Locator or a Manager).</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== 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">&nbsp;</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="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/AbstractLauncher.html#DEFAULT_FORCE">DEFAULT_FORCE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/AbstractLauncher.html#DEFAULT_WORKING_DIRECTORY">DEFAULT_WORKING_DIRECTORY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#logger">logger</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Please use Log4J 2 instead.</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/AbstractLauncher.html#MEMBER_NAME_ERROR_MESSAGE">MEMBER_NAME_ERROR_MESSAGE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <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/AbstractLauncher.html#OPTION_PREFIX">OPTION_PREFIX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#READ_PID_FILE_TIMEOUT_MILLIS">READ_PID_FILE_TIMEOUT_MILLIS</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This timeout is no longer needed.</span></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#running">running</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/AbstractLauncher.html#SIGNAL_HANDLER_REGISTRATION_SYSTEM_PROPERTY">SIGNAL_HANDLER_REGISTRATION_SYSTEM_PROPERTY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/AbstractLauncher.html#WORKING_DIRECTORY_NOT_FOUND_ERROR_MESSAGE">WORKING_DIRECTORY_NOT_FOUND_ERROR_MESSAGE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/AbstractLauncher.html#WORKING_DIRECTORY_OPTION_NOT_VALID_ERROR_MESSAGE">WORKING_DIRECTORY_OPTION_NOT_VALID_ERROR_MESSAGE</a></span></code>&nbsp;</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">&nbsp;</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/AbstractLauncher.html#AbstractLauncher--">AbstractLauncher</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>protected static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#assertPortAvailable-java.net.InetAddress-int-">assertPortAvailable</a></span>(<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>&nbsp;bindAddress,
int&nbsp;port)</code>
<div class="block">Asserts that the specified port is available on the specified network interface, indicated by
it's assigned IP address, on this local system.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#assertPortAvailable-int-">assertPortAvailable</a></span>(int&nbsp;port)</code>
<div class="block">Asserts that the specified port is available on all network interfaces on this local system.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#debug-java.lang.String-java.lang.Object...-">debug</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>&nbsp;message,
<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>...&nbsp;args)</code>
<div class="block">Prints the specified debug message to standard err, replacing any placeholder values with the
specified arguments on output, if debugging has been enabled.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#debug-java.lang.Throwable-">debug</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</code>
<div class="block">Prints the stack trace of the given Throwable to standard err if debugging has been enabled.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getDistributedSystemProperties--">getDistributedSystemProperties</a></span>()</code>
<div class="block">Creates a Properties object with configuration settings that the launcher has that should take
precedence over anything the user has defined in their gemfire properties file.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getDistributedSystemProperties-java.util.Properties-">getDistributedSystemProperties</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>&nbsp;defaults)</code>
<div class="block">Creates a Properties object with configuration settings that the launcher has that should take
precedence over anything the user has defined in their gemfire properties file.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getLogFile--">getLogFile</a></span>()</code>
<div class="block">Gets a File reference with the path to the log file for the process.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getLogFileCanonicalPath--">getLogFileCanonicalPath</a></span>()</code>
<div class="block">Gets the fully qualified canonical path of the log file for the process.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract <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/AbstractLauncher.html#getLogFileName--">getLogFileName</a></span>()</code>
<div class="block">Gets the name of the log file used to log information about this GemFire service.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getMember--">getMember</a></span>()</code>
<div class="block">Gets the name or ID of the member in the GemFire distributed system.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getMemberId--">getMemberId</a></span>()</code>
<div class="block">Gets the ID of the member in the GemFire distributed system as determined and assigned by
GemFire when the member process joins the distributed system.</div>
</td>
</tr>
<tr id="i11" 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/AbstractLauncher.html#getMemberName--">getMemberName</a></span>()</code>
<div class="block">Gets the name of the member in the GemFire distributed system as determined by the 'name'
GemFire property.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getPid--">getPid</a></span>()</code>
<div class="block">Gets the user-specified process ID (PID) of the running GemFire service that AbstractLauncher
implementations can use to determine status, or stop the service.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract <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/AbstractLauncher.html#getServiceName--">getServiceName</a></span>()</code>
<div class="block">Gets the name of the GemFire service.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getWorkingDirectory--">getWorkingDirectory</a></span>()</code>
<div class="block">Gets the working directory pathname in which the process will be run.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#info-java.lang.Object-java.lang.Object...-">info</a></span>(<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>&nbsp;message,
<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>...&nbsp;args)</code>
<div class="block">Prints the specified informational message to standard err, replacing any placeholder values
with the specified arguments on output.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#isDebugging--">isDebugging</a></span>()</code>
<div class="block">Determines whether the Locator launcher is in debug mode.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#isRunning--">isRunning</a></span>()</code>
<div class="block">Determines whether the Locator referenced by this launcher is running.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#isSet-java.util.Properties-java.lang.String-">isSet</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>&nbsp;properties,
<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>&nbsp;propertyName)</code>
<div class="block">Determines whether the specified property with name is set to a value in the referenced
Properties.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected static <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/AbstractLauncher.html#loadGemFireProperties-java.net.URL-">loadGemFireProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>&nbsp;url)</code>
<div class="block">Loads the GemFire properties at the specified URL.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#redirectOutput-org.apache.geode.distributed.DistributedSystem-">redirectOutput</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a>&nbsp;distributedSystem)</code>
<div class="block">Redirects the standard out and standard err to the configured log file as specified in the
GemFire distributed system properties.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#setDebug-boolean-">setDebug</a></span>(boolean&nbsp;debug)</code>
<div class="block">Sets the debug mode of the GemFire launcher class.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#version--">version</a></span>()</code>
<div class="block">Gets the version of GemFire currently running.</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&nbsp;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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Runnable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true#run--" title="class or interface in java.lang">run</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="MEMBER_NAME_ERROR_MESSAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MEMBER_NAME_ERROR_MESSAGE</h4>
<pre>public static final&nbsp;<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> MEMBER_NAME_ERROR_MESSAGE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.geode.distributed.AbstractLauncher.MEMBER_NAME_ERROR_MESSAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WORKING_DIRECTORY_OPTION_NOT_VALID_ERROR_MESSAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WORKING_DIRECTORY_OPTION_NOT_VALID_ERROR_MESSAGE</h4>
<pre>public static final&nbsp;<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> WORKING_DIRECTORY_OPTION_NOT_VALID_ERROR_MESSAGE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.geode.distributed.AbstractLauncher.WORKING_DIRECTORY_OPTION_NOT_VALID_ERROR_MESSAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WORKING_DIRECTORY_NOT_FOUND_ERROR_MESSAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WORKING_DIRECTORY_NOT_FOUND_ERROR_MESSAGE</h4>
<pre>public static final&nbsp;<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> WORKING_DIRECTORY_NOT_FOUND_ERROR_MESSAGE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.geode.distributed.AbstractLauncher.WORKING_DIRECTORY_NOT_FOUND_ERROR_MESSAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_FORCE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_FORCE</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
protected static final&nbsp;<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> DEFAULT_FORCE</pre>
</li>
</ul>
<a name="READ_PID_FILE_TIMEOUT_MILLIS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>READ_PID_FILE_TIMEOUT_MILLIS</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
protected static final&nbsp;long READ_PID_FILE_TIMEOUT_MILLIS</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This timeout is no longer needed.</span></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.geode.distributed.AbstractLauncher.READ_PID_FILE_TIMEOUT_MILLIS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_WORKING_DIRECTORY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_WORKING_DIRECTORY</h4>
<pre>public static final&nbsp;<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> DEFAULT_WORKING_DIRECTORY</pre>
</li>
</ul>
<a name="SIGNAL_HANDLER_REGISTRATION_SYSTEM_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SIGNAL_HANDLER_REGISTRATION_SYSTEM_PROPERTY</h4>
<pre>public static final&nbsp;<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> SIGNAL_HANDLER_REGISTRATION_SYSTEM_PROPERTY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.geode.distributed.AbstractLauncher.SIGNAL_HANDLER_REGISTRATION_SYSTEM_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OPTION_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPTION_PREFIX</h4>
<pre>protected static final&nbsp;<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> OPTION_PREFIX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.geode.distributed.AbstractLauncher.OPTION_PREFIX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="running">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>running</h4>
<pre>protected final transient&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a> running</pre>
</li>
</ul>
<a name="logger">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logger</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a> logger</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Please use Log4J 2 instead.</span></div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractLauncher--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractLauncher</h4>
<pre>public&nbsp;AbstractLauncher()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="assertPortAvailable-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertPortAvailable</h4>
<pre>protected static&nbsp;void&nbsp;assertPortAvailable(int&nbsp;port)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/net/BindException.html?is-external=true" title="class or interface in java.net">BindException</a></pre>
<div class="block">Asserts that the specified port is available on all network interfaces on this local system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>port</code> - an integer indicating the network port to listen for client network requests.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/BindException.html?is-external=true" title="class or interface in java.net">BindException</a></code> - if the network port is not available.</dd>
</dl>
</li>
</ul>
<a name="assertPortAvailable-java.net.InetAddress-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertPortAvailable</h4>
<pre>protected static&nbsp;void&nbsp;assertPortAvailable(<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>&nbsp;bindAddress,
int&nbsp;port)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/net/BindException.html?is-external=true" title="class or interface in java.net">BindException</a></pre>
<div class="block">Asserts that the specified port is available on the specified network interface, indicated by
it's assigned IP address, on this local system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bindAddress</code> - an InetAddress indicating the bounded network interface to determine whether
the service port is available or not.</dd>
<dd><code>port</code> - an integer indicating the network port to listen for client network requests.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/BindException.html?is-external=true" title="class or interface in java.net">BindException</a></code> - if the network address and port are not available. Address defaults to
localhost (or all network interfaces on the local system) if null.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>AvailablePort</code></dd>
</dl>
</li>
</ul>
<a name="isSet-java.util.Properties-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSet</h4>
<pre>protected static&nbsp;boolean&nbsp;isSet(<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>&nbsp;properties,
<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>&nbsp;propertyName)</pre>
<div class="block">Determines whether the specified property with name is set to a value in the referenced
Properties. The property is considered "set" if the String value of the property is not
non-null, non-empty and non-blank. Therefore, the Properties may "have" a property with name,
but having no value as determined by this method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>properties</code> - the Properties used in determining whether the given property is set.</dd>
<dd><code>propertyName</code> - a String indicating the name of the property to check if set.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a boolean indicating whether the specified property with name has been given a value in
the referenced Properties.</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="loadGemFireProperties-java.net.URL-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadGemFireProperties</h4>
<pre>protected static&nbsp;<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>&nbsp;loadGemFireProperties(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a>&nbsp;url)</pre>
<div class="block">Loads the GemFire properties at the specified URL.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - the URL to the gemfire.properties to load.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Properties instance populated with the gemfire.properties.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a></dd>
</dl>
</li>
</ul>
<a name="isDebugging--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDebugging</h4>
<pre>public&nbsp;boolean&nbsp;isDebugging()</pre>
<div class="block">Determines whether the Locator launcher is in debug mode.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a boolean to indicate whether the Locator launcher is in debug mode.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#setDebug-boolean-"><code>setDebug(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setDebug-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDebug</h4>
<pre>public&nbsp;void&nbsp;setDebug(boolean&nbsp;debug)</pre>
<div class="block">Sets the debug mode of the GemFire launcher class. This mutable property of the launcher
enables the user to turn the debug mode on and off programmatically.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>debug</code> - a boolean used to enable or disable debug mode.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#isDebugging--"><code>isDebugging()</code></a></dd>
</dl>
</li>
</ul>
<a name="isRunning--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRunning</h4>
<pre>public&nbsp;boolean&nbsp;isRunning()</pre>
<div class="block">Determines whether the Locator referenced by this launcher is running.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a boolean valued indicating if the referenced Locator is running.</dd>
</dl>
</li>
</ul>
<a name="getDistributedSystemProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistributedSystemProperties</h4>
<pre>protected&nbsp;<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>&nbsp;getDistributedSystemProperties()</pre>
<div class="block">Creates a Properties object with configuration settings that the launcher has that should take
precedence over anything the user has defined in their gemfire properties file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Properties object with GemFire properties that the launcher has defined.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getDistributedSystemProperties-java.util.Properties-"><code>getDistributedSystemProperties(java.util.Properties)</code></a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a></dd>
</dl>
</li>
</ul>
<a name="getDistributedSystemProperties-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistributedSystemProperties</h4>
<pre>protected&nbsp;<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>&nbsp;getDistributedSystemProperties(<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>&nbsp;defaults)</pre>
<div class="block">Creates a Properties object with configuration settings that the launcher has that should take
precedence over anything the user has defined in their gemfire properties file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaults</code> - default GemFire Distributed System properties as configured in the Builder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Properties object with GemFire properties that the launcher has defined.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="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="getLogFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogFile</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getLogFile()</pre>
<div class="block">Gets a File reference with the path to the log file for the process.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a File reference to the path of the log file for the process.</dd>
</dl>
</li>
</ul>
<a name="getLogFileCanonicalPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogFileCanonicalPath</h4>
<pre>protected&nbsp;<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>&nbsp;getLogFileCanonicalPath()</pre>
<div class="block">Gets the fully qualified canonical path of the log file for the process.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String value indicating the canonical path of the log file for the process.</dd>
</dl>
</li>
</ul>
<a name="getLogFileName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogFileName</h4>
<pre>public abstract&nbsp;<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>&nbsp;getLogFileName()</pre>
<div class="block">Gets the name of the log file used to log information about this GemFire service.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String value indicating the name of this GemFire service's log file.</dd>
</dl>
</li>
</ul>
<a name="getMember--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMember</h4>
<pre>public&nbsp;<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>&nbsp;getMember()</pre>
<div class="block">Gets the name or ID of the member in the GemFire distributed system. This method prefers name
if specified, otherwise the ID is returned. If name was not specified to the Builder that
created this Launcher and this call is not in-process, then null is returned.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String value indicating the member's name if specified, otherwise the member's ID is
returned if this call is made in-process, or finally, null is returned if neither name
name was specified or the call is out-of-process.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getMemberName--"><code>getMemberName()</code></a>,
<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#getMemberId--"><code>getMemberId()</code></a></dd>
</dl>
</li>
</ul>
<a name="getMemberId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemberId</h4>
<pre>public&nbsp;<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>&nbsp;getMemberId()</pre>
<div class="block">Gets the ID of the member in the GemFire distributed system as determined and assigned by
GemFire when the member process joins the distributed system. Note, this call only works if the
API is used in-process.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String value indicating the ID of the member in the GemFire distributed system.</dd>
</dl>
</li>
</ul>
<a name="getMemberName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemberName</h4>
<pre>public&nbsp;<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>&nbsp;getMemberName()</pre>
<div class="block">Gets the name of the member in the GemFire distributed system as determined by the 'name'
GemFire property. Note, this call only works if the API is used in-process.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String value indicating the name of the member in the GemFire distributed system.</dd>
</dl>
</li>
</ul>
<a name="getPid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPid</h4>
<pre>public abstract&nbsp;<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>&nbsp;getPid()</pre>
<div class="block">Gets the user-specified process ID (PID) of the running GemFire service that AbstractLauncher
implementations can use to determine status, or stop the service.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an Integer value indicating the process ID (PID) of the running GemFire service.</dd>
</dl>
</li>
</ul>
<a name="getServiceName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServiceName</h4>
<pre>public abstract&nbsp;<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>&nbsp;getServiceName()</pre>
<div class="block">Gets the name of the GemFire service.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String indicating the name of the GemFire service.</dd>
</dl>
</li>
</ul>
<a name="getWorkingDirectory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkingDirectory</h4>
<pre>public&nbsp;<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>&nbsp;getWorkingDirectory()</pre>
<div class="block">Gets the working directory pathname in which the process will be run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String value indicating the pathname of the Server's working directory.</dd>
</dl>
</li>
</ul>
<a name="debug-java.lang.String-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>debug</h4>
<pre>protected&nbsp;void&nbsp;debug(<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>&nbsp;message,
<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>...&nbsp;args)</pre>
<div class="block">Prints the specified debug message to standard err, replacing any placeholder values with the
specified arguments on output, if debugging has been enabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the String value written to standard err.</dd>
<dd><code>args</code> - an Object array containing arguments to replace the placeholder values in the
message.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#err" title="class or interface in java.lang"><code>System.err</code></a>,
<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#isDebugging--"><code>isDebugging()</code></a>,
<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#debug-java.lang.Throwable-"><code>debug(Throwable)</code></a>,
<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#info-java.lang.Object-java.lang.Object...-"><code>info(Object, Object...)</code></a></dd>
</dl>
</li>
</ul>
<a name="debug-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>debug</h4>
<pre>protected&nbsp;void&nbsp;debug(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</pre>
<div class="block">Prints the stack trace of the given Throwable to standard err if debugging has been enabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>t</code> - the Throwable who's stack trace is printed to standard err.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#err" title="class or interface in java.lang"><code>System.err</code></a>,
<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#isDebugging--"><code>isDebugging()</code></a>,
<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#debug-java.lang.String-java.lang.Object...-"><code>debug(String, Object...)</code></a></dd>
</dl>
</li>
</ul>
<a name="info-java.lang.Object-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>info</h4>
<pre>protected&nbsp;void&nbsp;info(<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>&nbsp;message,
<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>...&nbsp;args)</pre>
<div class="block">Prints the specified informational message to standard err, replacing any placeholder values
with the specified arguments on output.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the String value written to standard err.</dd>
<dd><code>args</code> - an Object array containing arguments to replace the placeholder values in the
message.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#err" title="class or interface in java.lang"><code>System.err</code></a>,
<a href="../../../../org/apache/geode/distributed/AbstractLauncher.html#debug-java.lang.String-java.lang.Object...-"><code>debug(String, Object...)</code></a></dd>
</dl>
</li>
</ul>
<a name="redirectOutput-org.apache.geode.distributed.DistributedSystem-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>redirectOutput</h4>
<pre>protected&nbsp;void&nbsp;redirectOutput(<a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a>&nbsp;distributedSystem)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Redirects the standard out and standard err to the configured log file as specified in the
GemFire distributed system properties.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>distributedSystem</code> - the GemFire model for a distributed system.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the standard out and err redirection was unsuccessful.</dd>
</dl>
</li>
</ul>
<a name="version--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>version</h4>
<pre>public&nbsp;<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>&nbsp;version()</pre>
<div class="block">Gets the version of GemFire currently running.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String representation of GemFire's version.</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>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/geode/distributed/AbstractLauncher.ServiceState.html" title="class in org.apache.geode.distributed"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/distributed/AbstractLauncher.html" target="_top">Frames</a></li>
<li><a href="AbstractLauncher.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>