avatica/apidocs/org/apache/calcite/avatica/server/AbstractAvaticaHandler.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>AbstractAvaticaHandler (Apache Calcite Avatica API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.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.3.1.js"></script>
 <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
 <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="AbstractAvaticaHandler (Apache Calcite Avatica API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":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";
 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="class-use/AbstractAvaticaHandler.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" 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><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>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.calcite.avatica.server</a></div>
 <h2 title="Class AbstractAvaticaHandler" class="title">Class AbstractAvaticaHandler</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li>org.eclipse.jetty.util.component.AbstractLifeCycle</li>
 <li>
 <ul class="inheritance">
 <li>org.eclipse.jetty.util.component.ContainerLifeCycle</li>
 <li>
 <ul class="inheritance">
 <li>org.eclipse.jetty.server.handler.AbstractHandler</li>
 <li>
 <ul class="inheritance">
 <li>org.apache.calcite.avatica.server.AbstractAvaticaHandler</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></code>, <code><a href="MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></code>, <code>org.eclipse.jetty.server.Handler</code>, <code>org.eclipse.jetty.util.component.Container</code>, <code>org.eclipse.jetty.util.component.Destroyable</code>, <code>org.eclipse.jetty.util.component.Dumpable</code>, <code>org.eclipse.jetty.util.component.LifeCycle</code></dd>
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="AvaticaJsonHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaJsonHandler</a></code>, <code><a href="AvaticaProtobufHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaProtobufHandler</a></code></dd>
 </dl>
 <hr>
 <pre>public abstract class <span class="typeNameLabel">AbstractAvaticaHandler</span>
 extends org.eclipse.jetty.server.handler.AbstractHandler
 implements <a href="MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></pre>
 <div class="block">Base-class for Avatica implemented Jetty Handlers.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="nested.class.summary">
 <!--   -->
 </a>
 <h3>Nested Class Summary</h3>
 <ul class="blockList">
 <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandler">
 <!--   -->
 </a>
 <h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.server.handler.AbstractHandler</h3>
 <code>org.eclipse.jetty.server.handler.AbstractHandler.ErrorDispatchHandler</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
 <!--   -->
 </a>
 <h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.util.component.AbstractLifeCycle</h3>
 <code>org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container">
 <!--   -->
 </a>
 <h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.Container</h3>
 <code>org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
 <!--   -->
 </a>
 <h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.LifeCycle</h3>
 <code>org.eclipse.jetty.util.component.LifeCycle.Listener</code></li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- =========== FIELD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <ul class="blockList">
 <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
 <!--   -->
 </a>
 <h3>Fields inherited from class&nbsp;org.eclipse.jetty.util.component.AbstractLifeCycle</h3>
 <code>FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
 <!--   -->
 </a>
 <h3>Fields inherited from interface&nbsp;org.eclipse.jetty.util.component.Dumpable</h3>
 <code>KEY</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.avatica.server.MetricsAwareAvaticaHandler">
 <!--   -->
 </a>
 <h3>Fields inherited from interface&nbsp;org.apache.calcite.avatica.server.<a href="MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></h3>
 <code><a href="MetricsAwareAvaticaHandler.html#HANDLER_PREFIX">HANDLER_PREFIX</a>, <a href="MetricsAwareAvaticaHandler.html#REQUEST_TIMER_NAME">REQUEST_TIMER_NAME</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <section role="region">
 <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()">AbstractAvaticaHandler</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <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="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>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUserPermitted(org.apache.calcite.avatica.server.AvaticaServerConfiguration,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">isUserPermitted</a></span>&#8203;(<a href="AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;serverConfig,
                org.eclipse.jetty.server.Request&nbsp;baseRequest,
                javax.servlet.http.HttpServletRequest&nbsp;request,
                javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
 <td class="colLast">
 <div class="block">Determines if a request is permitted to be executed.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandler">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.eclipse.jetty.server.handler.AbstractHandler</h3>
 <code>destroy, doError, doStart, doStop, getServer, handle, setServer</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.ContainerLifeCycle">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.ContainerLifeCycle</h3>
 <code>addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.AbstractLifeCycle</h3>
 <code>addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString</code></li>
 </ul>
 <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, wait, wait, wait</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.avatica.server.AvaticaHandler">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.calcite.avatica.server.<a href="AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></h3>
 <code><a href="AvaticaHandler.html#setServerRpcMetadata(org.apache.calcite.avatica.remote.Service.RpcMetadataResponse)">setServerRpcMetadata</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.component.Dumpable</h3>
 <code>dumpSelf</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.Handler">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.eclipse.jetty.server.Handler</h3>
 <code>destroy, getServer, handle, setServer</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.component.LifeCycle</h3>
 <code>addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.avatica.server.MetricsAwareAvaticaHandler">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.calcite.avatica.server.<a href="MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></h3>
 <code><a href="MetricsAwareAvaticaHandler.html#getMetrics()">getMetrics</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <section role="region">
 <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>AbstractAvaticaHandler</h4>
 <pre>public&nbsp;AbstractAvaticaHandler()</pre>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="isUserPermitted(org.apache.calcite.avatica.server.AvaticaServerConfiguration,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>isUserPermitted</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;isUserPermitted&#8203;(<a href="AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;serverConfig,
                                org.eclipse.jetty.server.Request&nbsp;baseRequest,
                                javax.servlet.http.HttpServletRequest&nbsp;request,
                                javax.servlet.http.HttpServletResponse&nbsp;response)
                         throws java.io.IOException</pre>
 <div class="block">Determines if a request is permitted to be executed. The server may require authentication
  and the login mechanism might have failed. This check verifies that only authenticated
  users are permitted through when the server is requiring authentication. When a user
  is disallowed, a status code and response will be automatically written to the provided
  <code>response</code> and the caller should return immediately.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>serverConfig</code> - The server's configuration</dd>
 <dd><code>request</code> - The user's request</dd>
 <dd><code>response</code> - The response to the user's request</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>True if request can proceed, false otherwise.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code>java.io.IOException</code></dd>
 </dl>
 </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="class-use/AbstractAvaticaHandler.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" 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><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>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>
 <p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc -->
	<title>AbstractAvaticaHandler (Apache Calcite Avatica API)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.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.3.1.js"></script>
	<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
	<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="AbstractAvaticaHandler (Apache Calcite Avatica API)";
	}
	}
	catch(err) {
	}
	//-->
	var data = {"i0":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";
	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="class-use/AbstractAvaticaHandler.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" id="allclasses_navbar_top">
	<li><a href="../../../../../allclasses.html">All 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: </li>
	<li><a href="#nested.class.summary">Nested</a> \| </li>
	<li><a href="#field.summary">Field</a> \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </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"> </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> <a href="package-summary.html">org.apache.calcite.avatica.server</a></div>
	<h2 title="Class AbstractAvaticaHandler" class="title">Class AbstractAvaticaHandler</h2>
	</div>
	<div class="contentContainer">
	<ul class="inheritance">
	<li>java.lang.Object</li>
	<li>
	<ul class="inheritance">
	<li>org.eclipse.jetty.util.component.AbstractLifeCycle</li>
	<li>
	<ul class="inheritance">
	<li>org.eclipse.jetty.util.component.ContainerLifeCycle</li>
	<li>
	<ul class="inheritance">
	<li>org.eclipse.jetty.server.handler.AbstractHandler</li>
	<li>
	<ul class="inheritance">
	<li>org.apache.calcite.avatica.server.AbstractAvaticaHandler</li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<dl>
	<dt>All Implemented Interfaces:</dt>
	<dd><code><a href="AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></code>, <code><a href="MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></code>, <code>org.eclipse.jetty.server.Handler</code>, <code>org.eclipse.jetty.util.component.Container</code>, <code>org.eclipse.jetty.util.component.Destroyable</code>, <code>org.eclipse.jetty.util.component.Dumpable</code>, <code>org.eclipse.jetty.util.component.LifeCycle</code></dd>
	</dl>
	<dl>
	<dt>Direct Known Subclasses:</dt>
	<dd><code><a href="AvaticaJsonHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaJsonHandler</a></code>, <code><a href="AvaticaProtobufHandler.html" title="class in org.apache.calcite.avatica.server">AvaticaProtobufHandler</a></code></dd>
	</dl>
	<hr>
	<pre>public abstract class <span class="typeNameLabel">AbstractAvaticaHandler</span>
	extends org.eclipse.jetty.server.handler.AbstractHandler
	implements <a href="MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></pre>
	<div class="block">Base-class for Avatica implemented Jetty Handlers.</div>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- ======== NESTED CLASS SUMMARY ======== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="nested.class.summary">
	<!-- -->
	</a>
	<h3>Nested Class Summary</h3>
	<ul class="blockList">
	<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandler">
	<!-- -->
	</a>
	<h3>Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler</h3>
	<code>org.eclipse.jetty.server.handler.AbstractHandler.ErrorDispatchHandler</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
	<!-- -->
	</a>
	<h3>Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle</h3>
	<code>org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container">
	<!-- -->
	</a>
	<h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container</h3>
	<code>org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
	<!-- -->
	</a>
	<h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle</h3>
	<code>org.eclipse.jetty.util.component.LifeCycle.Listener</code></li>
	</ul>
	</li>
	</ul>
	</section>
	<!-- =========== FIELD SUMMARY =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="field.summary">
	<!-- -->
	</a>
	<h3>Field Summary</h3>
	<ul class="blockList">
	<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
	<!-- -->
	</a>
	<h3>Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle</h3>
	<code>FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
	<!-- -->
	</a>
	<h3>Fields inherited from interface org.eclipse.jetty.util.component.Dumpable</h3>
	<code>KEY</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.avatica.server.MetricsAwareAvaticaHandler">
	<!-- -->
	</a>
	<h3>Fields inherited from interface org.apache.calcite.avatica.server.<a href="MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></h3>
	<code><a href="MetricsAwareAvaticaHandler.html#HANDLER_PREFIX">HANDLER_PREFIX</a>, <a href="MetricsAwareAvaticaHandler.html#REQUEST_TIMER_NAME">REQUEST_TIMER_NAME</a></code></li>
	</ul>
	</li>
	</ul>
	</section>
	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
	<section role="region">
	<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"> </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()">AbstractAvaticaHandler</a></span>()</code></th>
	<td class="colLast"> </td>
	</tr>
	</table>
	</li>
	</ul>
	</section>
	<!-- ========== METHOD SUMMARY =========== -->
	<section role="region">
	<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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colSecond" scope="col">Method</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	<tr id="i0" class="altColor">
	<td class="colFirst"><code>boolean</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUserPermitted(org.apache.calcite.avatica.server.AvaticaServerConfiguration,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">isUserPermitted</a></span>(<a href="AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a> serverConfig,
	org.eclipse.jetty.server.Request baseRequest,
	javax.servlet.http.HttpServletRequest request,
	javax.servlet.http.HttpServletResponse response)</code></th>
	<td class="colLast">
	<div class="block">Determines if a request is permitted to be executed.</div>
	</td>
	</tr>
	</table>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandler">
	<!-- -->
	</a>
	<h3>Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler</h3>
	<code>destroy, doError, doStart, doStop, getServer, handle, setServer</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.ContainerLifeCycle">
	<!-- -->
	</a>
	<h3>Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle</h3>
	<code>addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
	<!-- -->
	</a>
	<h3>Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle</h3>
	<code>addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
	<!-- -->
	</a>
	<h3>Methods inherited from class java.lang.Object</h3>
	<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.avatica.server.AvaticaHandler">
	<!-- -->
	</a>
	<h3>Methods inherited from interface org.apache.calcite.avatica.server.<a href="AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></h3>
	<code><a href="AvaticaHandler.html#setServerRpcMetadata(org.apache.calcite.avatica.remote.Service.RpcMetadataResponse)">setServerRpcMetadata</a></code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
	<!-- -->
	</a>
	<h3>Methods inherited from interface org.eclipse.jetty.util.component.Dumpable</h3>
	<code>dumpSelf</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.Handler">
	<!-- -->
	</a>
	<h3>Methods inherited from interface org.eclipse.jetty.server.Handler</h3>
	<code>destroy, getServer, handle, setServer</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
	<!-- -->
	</a>
	<h3>Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle</h3>
	<code>addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop</code></li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.avatica.server.MetricsAwareAvaticaHandler">
	<!-- -->
	</a>
	<h3>Methods inherited from interface org.apache.calcite.avatica.server.<a href="MetricsAwareAvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">MetricsAwareAvaticaHandler</a></h3>
	<code><a href="MetricsAwareAvaticaHandler.html#getMetrics()">getMetrics</a></code></li>
	</ul>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ========= CONSTRUCTOR DETAIL ======== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="constructor.detail">
	<!-- -->
	</a>
	<h3>Constructor Detail</h3>
	<a id="<init>()">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>AbstractAvaticaHandler</h4>
	<pre>public AbstractAvaticaHandler()</pre>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	<!-- ============ METHOD DETAIL ========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a id="isUserPermitted(org.apache.calcite.avatica.server.AvaticaServerConfiguration,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>isUserPermitted</h4>
	<pre class="methodSignature">public boolean isUserPermitted(<a href="AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a> serverConfig,
	org.eclipse.jetty.server.Request baseRequest,
	javax.servlet.http.HttpServletRequest request,
	javax.servlet.http.HttpServletResponse response)
	throws java.io.IOException</pre>
	<div class="block">Determines if a request is permitted to be executed. The server may require authentication
	and the login mechanism might have failed. This check verifies that only authenticated
	users are permitted through when the server is requiring authentication. When a user
	is disallowed, a status code and response will be automatically written to the provided
	<code>response</code> and the caller should return immediately.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>serverConfig</code> - The server's configuration</dd>
	<dd><code>request</code> - The user's request</dd>
	<dd><code>response</code> - The response to the user's request</dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>True if request can proceed, false otherwise.</dd>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code>java.io.IOException</code></dd>
	</dl>
	</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="class-use/AbstractAvaticaHandler.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" id="allclasses_navbar_bottom">
	<li><a href="../../../../../allclasses.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_bottom");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li><a href="#nested.class.summary">Nested</a> \| </li>
	<li><a href="#field.summary">Field</a> \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<a id="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</nav>
	<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
	</footer>
	</body>
	</html>