blob: 4e86a4be163e676d1191205ea746d42c6e4b7317 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.drill.exec.server.rest (Drill : 1.20.3 API)</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="org.apache.drill.exec.server.rest (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/drill/exec/server/options/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/drill/exec/server/rest/auth/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/server/rest/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.drill.exec.server.rest</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/BaseQueryRunner.html" title="class in org.apache.drill.exec.server.rest">BaseQueryRunner</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/BaseWebUserConnection.html" title="class in org.apache.drill.exec.server.rest">BaseWebUserConnection</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/CsrfTokenInjectFilter.html" title="class in org.apache.drill.exec.server.rest">CsrfTokenInjectFilter</a></td>
<td class="colLast">
<div class="block">Generates and adds a CSRF token to a HTTP session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/CsrfTokenValidateFilter.html" title="class in org.apache.drill.exec.server.rest">CsrfTokenValidateFilter</a></td>
<td class="colLast">
<div class="block">All forms on site have a field with a CSRF token injected by server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRestServer.html" title="class in org.apache.drill.exec.server.rest">DrillRestServer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRestServer.AnonDrillUserPrincipalProvider.html" title="class in org.apache.drill.exec.server.rest">DrillRestServer.AnonDrillUserPrincipalProvider</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRestServer.AnonWebUserConnectionProvider.html" title="class in org.apache.drill.exec.server.rest">DrillRestServer.AnonWebUserConnectionProvider</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRestServer.AuthWebUserConnectionProvider.html" title="class in org.apache.drill.exec.server.rest">DrillRestServer.AuthWebUserConnectionProvider</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRestServer.DrillUserPrincipalProvider.html" title="class in org.apache.drill.exec.server.rest">DrillRestServer.DrillUserPrincipalProvider</a></td>
<td class="colLast">
<div class="block">Provider which injects DrillUserPrincipal directly instead of getting it
from SecurityContext and typecasting</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRestServer.UserAuthEnabled.html" title="class in org.apache.drill.exec.server.rest">DrillRestServer.UserAuthEnabled</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRoot.html" title="class in org.apache.drill.exec.server.rest">DrillRoot</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRoot.ClusterInfo.html" title="class in org.apache.drill.exec.server.rest">DrillRoot.ClusterInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRoot.DrillbitInfo.html" title="class in org.apache.drill.exec.server.rest">DrillRoot.DrillbitInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/DrillRoot.QueueInfo.html" title="class in org.apache.drill.exec.server.rest">DrillRoot.QueueInfo</a></td>
<td class="colLast">
<div class="block">Pretty-printing wrapper class around the ZK-based queue summary.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/GenericExceptionMapper.html" title="class in org.apache.drill.exec.server.rest">GenericExceptionMapper</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/GenericExceptionMapper.GenericErrorMessage.html" title="class in org.apache.drill.exec.server.rest">GenericExceptionMapper.GenericErrorMessage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/LogInLogOutResources.html" title="class in org.apache.drill.exec.server.rest">LogInLogOutResources</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/LogsResources.html" title="class in org.apache.drill.exec.server.rest">LogsResources</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/MetricsResources.html" title="class in org.apache.drill.exec.server.rest">MetricsResources</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/PluginConfigWrapper.html" title="class in org.apache.drill.exec.server.rest">PluginConfigWrapper</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/QueryResources.html" title="class in org.apache.drill.exec.server.rest">QueryResources</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/QueryResources.QueryPage.html" title="class in org.apache.drill.exec.server.rest">QueryResources.QueryPage</a></td>
<td class="colLast">
<div class="block">Model class for Query page</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/QueryResources.TabularResult.html" title="class in org.apache.drill.exec.server.rest">QueryResources.TabularResult</a></td>
<td class="colLast">
<div class="block">Model class for Results page</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/QueryWrapper.html" title="class in org.apache.drill.exec.server.rest">QueryWrapper</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/QueryWrapper.RestQueryBuilder.html" title="class in org.apache.drill.exec.server.rest">QueryWrapper.RestQueryBuilder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/RestQueryRunner.html" title="class in org.apache.drill.exec.server.rest">RestQueryRunner</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/RestQueryRunner.QueryResult.html" title="class in org.apache.drill.exec.server.rest">RestQueryRunner.QueryResult</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/StatusResources.html" title="class in org.apache.drill.exec.server.rest">StatusResources</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/StatusResources.OptionsListing.html" title="class in org.apache.drill.exec.server.rest">StatusResources.OptionsListing</a></td>
<td class="colLast">
<div class="block">Data Model for rendering /options on webUI</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/StatusResources.OptionWrapper.html" title="class in org.apache.drill.exec.server.rest">StatusResources.OptionWrapper</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/StorageResources.html" title="class in org.apache.drill.exec.server.rest">StorageResources</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/StorageResources.StoragePluginModel.html" title="class in org.apache.drill.exec.server.rest">StorageResources.StoragePluginModel</a></td>
<td class="colLast">
<div class="block">Model class for Storage Plugin page.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/ThreadsResources.html" title="class in org.apache.drill.exec.server.rest">ThreadsResources</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/ViewableWithPermissions.html" title="class in org.apache.drill.exec.server.rest">ViewableWithPermissions</a></td>
<td class="colLast">
<div class="block">Overrides <code>Viewable</code> to create a model which contains additional info of what control to display in menubar.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/WebServer.html" title="class in org.apache.drill.exec.server.rest">WebServer</a></td>
<td class="colLast">
<div class="block">Wrapper class around jetty based web server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/WebServerConstants.html" title="class in org.apache.drill.exec.server.rest">WebServerConstants</a></td>
<td class="colLast">
<div class="block">Holds various constants used by WebServer components.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/WebSessionResources.html" title="class in org.apache.drill.exec.server.rest">WebSessionResources</a></td>
<td class="colLast">
<div class="block">Holds the resources required for Web User Session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/WebUserConnection.html" title="class in org.apache.drill.exec.server.rest">WebUserConnection</a></td>
<td class="colLast">
<div class="block"><code>WebUserConnectionWrapper</code> which represents the <code>UserClientConnection</code> between
WebServer and Foreman, for the WebUser submitting the query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/WebUserConnection.AnonWebUserConnection.html" title="class in org.apache.drill.exec.server.rest">WebUserConnection.AnonWebUserConnection</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/server/rest/WebUtils.html" title="class in org.apache.drill.exec.server.rest">WebUtils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/drill/exec/server/options/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/drill/exec/server/rest/auth/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/server/rest/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>