blob: c858efa2833ec7302cacb91ac21cafc472e895b7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>TManagerSink (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TManagerSink (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.heron.metricsmgr.sink.tmanager</a></div>
<h2 title="Class TManagerSink" class="title">Class TManagerSink</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.metricsmgr.sink.tmanager.TManagerSink</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html" title="interface in org.apache.heron.spi.metricsmgr.sink">IMetricsSink</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">TManagerSink</span>
extends java.lang.Object
implements <a href="../../../spi/metricsmgr/sink/IMetricsSink.html" title="interface in org.apache.heron.spi.metricsmgr.sink">IMetricsSink</a></pre>
<div class="block">An IMetricsSink sends Metrics to TManager.
1. It gets the TManagerLocation
<p>
2. Then it would construct a long-live Service running TManagerClient, which could automatically
recover from uncaught exceptions, i.e. close the old one and start a new one.
Also, it provides API to update the TManagerLocation that TManagerClient need to connect and
restart the TManagerClient.
There are two scenarios we need to restart a TManagerClient in our case:
<p>
-- Uncaught exceptions happen within TManagerClient; then we would restart TManagerClient inside
the same ExecutorService inside the UncaughtExceptionHandlers.
Notice that, in java, exceptions occur inside UncaughtExceptionHandlers would not invoke
UncaughtExceptionHandlers; instead, it would kill the thread with that exception.
So if exceptions thrown during restart a new TManagerClient, this TManagerSink would die, and
external logic would take care of it.
<p>
-- TManagerLocation changes (though in fact, TManagerClient might also throw exceptions in this case),
in this case, we would invoke TManagerService to start from tManagerLocationStarter's thread.
But the TManagerService and TManagerClient still start wihtin the thread they run.
<p>
3. When a new MetricsRecord comes by invoking processRecord, it would push the MetricsRecord
to the Communicator Queue to TManagerClient
<p>
Notice that we would not send all metrics to TManager; we would use MetricsFilter to figure out
needed metrics.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">TManagerSink</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkCommunicator(org.apache.heron.common.basics.Communicator,int)">checkCommunicator</a></span>&#8203;(<a href="../../../common/basics/Communicator.html" title="class in org.apache.heron.common.basics">Communicator</a>&lt;<a href="../../../proto/tmanager/TopologyManager.PublishMetrics.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.PublishMetrics</a>&gt;&nbsp;communicator,
int&nbsp;maxSize)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Closes this stream and releases any system resources associated
with it.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSimpleTManagerClientService(java.util.Map)">createSimpleTManagerClientService</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;serviceConfig)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush()">flush</a></span>()</code></th>
<td class="colLast">
<div class="block">Flush any buffered metrics
It would be called at an interval according to the configuration</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="../../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentTManagerLocation()">getCurrentTManagerLocation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentTManagerLocationInService()">getCurrentTManagerLocationInService</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="TManagerClient.html" title="class in org.apache.heron.metricsmgr.sink.tmanager">TManagerClient</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTManagerClient()">getTManagerClient</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected org.apache.heron.metricsmgr.sink.tmanager.TManagerSink.TManagerClientService</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTManagerClientService()">getTManagerClientService</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTManagerStartedAttempts()">getTManagerStartedAttempts</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(java.util.Map,org.apache.heron.spi.metricsmgr.sink.SinkContext)">init</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;conf,
<a href="../../../spi/metricsmgr/sink/SinkContext.html" title="interface in org.apache.heron.spi.metricsmgr.sink">SinkContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Initialize the MetricsSink</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#processRecord(org.apache.heron.spi.metricsmgr.metrics.MetricsRecord)">processRecord</a></span>&#8203;(<a href="../../../spi/metricsmgr/metrics/MetricsRecord.html" title="class in org.apache.heron.spi.metricsmgr.metrics">MetricsRecord</a>&nbsp;record)</code></th>
<td class="colLast">
<div class="block">Process a metrics record in the sink</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startNewTManagerClient(org.apache.heron.proto.tmanager.TopologyManager.TManagerLocation)">startNewTManagerClient</a></span>&#8203;(<a href="../../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a>&nbsp;location)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TManagerSink</h4>
<pre>public&nbsp;TManagerSink()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="init(java.util.Map,org.apache.heron.spi.metricsmgr.sink.SinkContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;init&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;conf,
<a href="../../../spi/metricsmgr/sink/SinkContext.html" title="interface in org.apache.heron.spi.metricsmgr.sink">SinkContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html#init(java.util.Map,org.apache.heron.spi.metricsmgr.sink.SinkContext)">IMetricsSink</a></code></span></div>
<div class="block">Initialize the MetricsSink</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html#init(java.util.Map,org.apache.heron.spi.metricsmgr.sink.SinkContext)">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html" title="interface in org.apache.heron.spi.metricsmgr.sink">IMetricsSink</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - An unmodifiableMap containing basic configuration</dd>
<dd><code>context</code> - context objects for Sink to init
Attempts to modify the returned map,
whether direct or via its collection views, result in an UnsupportedOperationException.</dd>
</dl>
</li>
</ul>
<a id="processRecord(org.apache.heron.spi.metricsmgr.metrics.MetricsRecord)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processRecord</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;processRecord&#8203;(<a href="../../../spi/metricsmgr/metrics/MetricsRecord.html" title="class in org.apache.heron.spi.metricsmgr.metrics">MetricsRecord</a>&nbsp;record)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html#processRecord(org.apache.heron.spi.metricsmgr.metrics.MetricsRecord)">IMetricsSink</a></code></span></div>
<div class="block">Process a metrics record in the sink</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html#processRecord(org.apache.heron.spi.metricsmgr.metrics.MetricsRecord)">processRecord</a></code>&nbsp;in interface&nbsp;<code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html" title="interface in org.apache.heron.spi.metricsmgr.sink">IMetricsSink</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>record</code> - the record to put</dd>
</dl>
</li>
</ul>
<a id="checkCommunicator(org.apache.heron.common.basics.Communicator,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkCommunicator</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;checkCommunicator&#8203;(<a href="../../../common/basics/Communicator.html" title="class in org.apache.heron.common.basics">Communicator</a>&lt;<a href="../../../proto/tmanager/TopologyManager.PublishMetrics.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.PublishMetrics</a>&gt;&nbsp;communicator,
int&nbsp;maxSize)</pre>
</li>
</ul>
<a id="flush()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;flush()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html#flush()">IMetricsSink</a></code></span></div>
<div class="block">Flush any buffered metrics
It would be called at an interval according to the configuration</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html#flush()">flush</a></code>&nbsp;in interface&nbsp;<code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html" title="interface in org.apache.heron.spi.metricsmgr.sink">IMetricsSink</a></code></dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html#close()">IMetricsSink</a></code></span></div>
<div class="block">Closes this stream and releases any system resources associated
with it. If the stream is already closed then invoking this
method has no effect.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../spi/metricsmgr/sink/IMetricsSink.html" title="interface in org.apache.heron.spi.metricsmgr.sink">IMetricsSink</a></code></dd>
</dl>
</li>
</ul>
<a id="getTManagerClientService()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTManagerClientService</h4>
<pre class="methodSignature">protected&nbsp;org.apache.heron.metricsmgr.sink.tmanager.TManagerSink.TManagerClientService&nbsp;getTManagerClientService()</pre>
</li>
</ul>
<a id="createSimpleTManagerClientService(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSimpleTManagerClientService</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;createSimpleTManagerClientService&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;serviceConfig)</pre>
</li>
</ul>
<a id="getTManagerClient()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTManagerClient</h4>
<pre class="methodSignature">protected&nbsp;<a href="TManagerClient.html" title="class in org.apache.heron.metricsmgr.sink.tmanager">TManagerClient</a>&nbsp;getTManagerClient()</pre>
</li>
</ul>
<a id="startNewTManagerClient(org.apache.heron.proto.tmanager.TopologyManager.TManagerLocation)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startNewTManagerClient</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;startNewTManagerClient&#8203;(<a href="../../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a>&nbsp;location)</pre>
</li>
</ul>
<a id="getTManagerStartedAttempts()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTManagerStartedAttempts</h4>
<pre class="methodSignature">protected&nbsp;int&nbsp;getTManagerStartedAttempts()</pre>
</li>
</ul>
<a id="getCurrentTManagerLocation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentTManagerLocation</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a>&nbsp;getCurrentTManagerLocation()</pre>
</li>
</ul>
<a id="getCurrentTManagerLocationInService()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCurrentTManagerLocationInService</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a>&nbsp;getCurrentTManagerLocationInService()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>