Google Git
Sign in
apache / gobblin / refs/heads/gh-pages / . / javadoc / latest / gobblin-admin / gobblin / admin / AdminWebServer.html
blob: 583326479da393f93665c9fd40bd6b91f8a6a386 [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 (1.8.0_40) on Thu Jul 20 13:17:47 PDT 2017 -->
<title>AdminWebServer (gobblin-admin 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<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="AdminWebServer (gobblin-admin 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/admin/AdminWebServer.html" target="_top">Frames</a></li>
<li><a href="AdminWebServer.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>Nested&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">gobblin.admin</div>
<h2 title="Class AdminWebServer" class="title">Class AdminWebServer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/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><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true" title="class or interface in com.google.common.util.concurrent">com.google.common.util.concurrent.AbstractIdleService</a></li>
<li>
<ul class="inheritance">
<li>gobblin.admin.AdminWebServer</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true" title="class or interface in com.google.common.util.concurrent">Service</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">AdminWebServer</span>
extends <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true" title="class or interface in com.google.common.util.concurrent">AbstractIdleService</a></pre>
<div class="block">Serves the admin UI interface using embedded Jetty.</div>
</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.google.common.util.concurrent.Service">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.google.common.util.concurrent.<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.html?is-external=true" title="class or interface in com.google.common.util.concurrent">Service</a></h3>
<code><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.Listener.html?is-external=true" title="class or interface in com.google.common.util.concurrent">Service.Listener</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/Service.State.html?is-external=true" title="class or interface in com.google.common.util.concurrent">Service.State</a></code></li>
</ul>
</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 org.eclipse.jetty.server.Server</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/admin/AdminWebServer.html#server">server</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="../../gobblin/admin/AdminWebServer.html#AdminWebServer-java.util.Properties-java.net.URI-">AdminWebServer</a></span>(<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;restServerUri)</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="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/admin/AdminWebServer.html#shutDown--">shutDown</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/admin/AdminWebServer.html#startUp--">startUp</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.google.common.util.concurrent.AbstractIdleService">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.google.common.util.concurrent.<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true" title="class or interface in com.google.common.util.concurrent">AbstractIdleService</a></h3>
<code><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#addListener-com.google.common.util.concurrent.Service.Listener-java.util.concurrent.Executor-" title="class or interface in com.google.common.util.concurrent">addListener</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#awaitRunning--" title="class or interface in com.google.common.util.concurrent">awaitRunning</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#awaitRunning-long-java.util.concurrent.TimeUnit-" title="class or interface in com.google.common.util.concurrent">awaitRunning</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#awaitTerminated--" title="class or interface in com.google.common.util.concurrent">awaitTerminated</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#awaitTerminated-long-java.util.concurrent.TimeUnit-" title="class or interface in com.google.common.util.concurrent">awaitTerminated</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#executor--" title="class or interface in com.google.common.util.concurrent">executor</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#failureCause--" title="class or interface in com.google.common.util.concurrent">failureCause</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#isRunning--" title="class or interface in com.google.common.util.concurrent">isRunning</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#serviceName--" title="class or interface in com.google.common.util.concurrent">serviceName</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#start--" title="class or interface in com.google.common.util.concurrent">start</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#startAndWait--" title="class or interface in com.google.common.util.concurrent">startAndWait</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#startAsync--" title="class or interface in com.google.common.util.concurrent">startAsync</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#state--" title="class or interface in com.google.common.util.concurrent">state</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#stop--" title="class or interface in com.google.common.util.concurrent">stop</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#stopAndWait--" title="class or interface in com.google.common.util.concurrent">stopAndWait</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#stopAsync--" title="class or interface in com.google.common.util.concurrent">stopAsync</a>, <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#toString--" title="class or interface in com.google.common.util.concurrent">toString</a></code></li>
</ul>
<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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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="server">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>server</h4>
<pre>protected&nbsp;org.eclipse.jetty.server.Server server</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AdminWebServer-java.util.Properties-java.net.URI-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AdminWebServer</h4>
<pre>public&nbsp;AdminWebServer(<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>&nbsp;restServerUri)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="startUp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startUp</h4>
<pre>protected&nbsp;void&nbsp;startUp()
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#startUp--" title="class or interface in com.google.common.util.concurrent">startUp</a></code>&nbsp;in class&nbsp;<code><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true" title="class or interface in com.google.common.util.concurrent">AbstractIdleService</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="shutDown--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>shutDown</h4>
<pre>protected&nbsp;void&nbsp;shutDown()
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true#shutDown--" title="class or interface in com.google.common.util.concurrent">shutDown</a></code>&nbsp;in class&nbsp;<code><a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/util/concurrent/AbstractIdleService.html?is-external=true" title="class or interface in com.google.common.util.concurrent">AbstractIdleService</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></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>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/admin/AdminWebServer.html" target="_top">Frames</a></li>
<li><a href="AdminWebServer.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>Nested&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>