org.apache.calcite.avatica.server

Class AbstractAvaticaHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.apache.calcite.avatica.server.AbstractAvaticaHandler

All Implemented Interfaces:

AvaticaHandler, MetricsAwareAvaticaHandler, org.eclipse.jetty.server.Handler, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

Direct Known Subclasses:

AvaticaJsonHandler, AvaticaProtobufHandler

public abstract class AbstractAvaticaHandler
extends org.eclipse.jetty.server.handler.AbstractHandler
implements MetricsAwareAvaticaHandler

Base-class for Avatica implemented Jetty Handlers.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.apache.calcite.avatica.server.MetricsAwareAvaticaHandler

HANDLER_PREFIX, REQUEST_TIMER_NAME

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor and Description
AbstractAvaticaHandler()

Method Summary

Modifier and Type	Method and Description
boolean	isUserPermitted(AvaticaServerConfiguration serverConfig, org.eclipse.jetty.server.Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Determines if a request is permitted to be executed.

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

destroy, doError, doStart, doStop, getServer, handle, setServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

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

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.avatica.server.MetricsAwareAvaticaHandler

getMetrics

Methods inherited from interface org.apache.calcite.avatica.server.AvaticaHandler

setServerRpcMetadata

Methods inherited from interface org.eclipse.jetty.server.Handler

destroy, getServer, handle, setServer

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, start, stop, stop

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

Constructor Detail

AbstractAvaticaHandler

public AbstractAvaticaHandler()

Method Detail

isUserPermitted

public boolean isUserPermitted(AvaticaServerConfiguration serverConfig,
                               org.eclipse.jetty.server.Request baseRequest,
                               javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws IOException

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 response and the caller should return immediately.

Parameters:

serverConfig - The server's configuration

request - The user's request

response - The response to the user's request

Returns:

True if request can proceed, false otherwise.

Throws:

IOException