Package org.riversun.jetty.basicauth

Class BasicAuthResourceHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.server.handler.ResourceHandler

org.riversun.jetty.basicauth.BasicAuthResourceHandler

public class BasicAuthResourceHandler
extends org.eclipse.jetty.server.handler.ResourceHandler

Resourcehandler supporting basic authentication

Author:

Tom Misawa (riversun.org@gmail.com)

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.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.LifeCycle

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

Field Summary

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

_handler

Constructor Summary

Constructors

Constructor	Description
BasicAuthResourceHandler()

Method Summary

Modifier and Type	Method	Description
BasicAuthResourceHandler	addRetryBasicAuthExcludedPath(String path)	Add path to ignore #setRetryBasicAuth effect
void	handle(String target, org.eclipse.jetty.server.Request baseRequest, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
BasicAuthResourceHandler	setBasicAuth(BasicAuth basicAuth)	Set the condition of basic authentication
BasicAuthResourceHandler	setRetryBasicAuth(boolean enabled)	Enabling retry of basic authentication when authorization failed If the user-A who has already passed the BASIC authentication for page-A.
BasicAuthResourceHandler	setsetSkipBasicAuthCallback(BasicAuthLogicCore.SkipBasicAuthCallback listener)

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

doError, doStop, dumpThis, getServer

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

doShutdown, expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

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 org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

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

destroy, expandChildren, getHandler, getHandlers, insertHandler, setHandler

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 class java.lang.Object

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

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

doStart, getBaseResource, getCacheControl, getGzipEquivalentFileExtensions, getMimeTypes, getMinAsyncContentLength, getMinMemoryMappedContentLength, getPrecompressedFormats, getResource, getResourceBase, getStylesheet, getWelcomeFile, getWelcomeFiles, isAcceptRanges, isDirAllowed, isDirectoriesListed, isEtags, isGzip, isPathInfoOnly, isRedirectWelcome, setAcceptRanges, setBaseResource, setCacheControl, setDirAllowed, setDirectoriesListed, setEtags, setGzip, setGzipEquivalentFileExtensions, setMimeTypes, setMinAsyncContentLength, setMinMemoryMappedContentLength, setPathInfoOnly, setPrecompressedFormats, setRedirectWelcome, setResourceBase, setStylesheet, setWelcomeFiles

Constructor Detail

BasicAuthResourceHandler

public BasicAuthResourceHandler()

Method Detail

setBasicAuth

public BasicAuthResourceHandler setBasicAuth(BasicAuth basicAuth)

Set the condition of basic authentication

Parameters:

basicAuth -

Returns:

handle

public void handle(String target,
                   org.eclipse.jetty.server.Request baseRequest,
                   javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse resp)
            throws IOException,
                   javax.servlet.ServletException

Overrides:

handle in class org.eclipse.jetty.server.handler.ResourceHandler

Throws:

IOException

javax.servlet.ServletException

addRetryBasicAuthExcludedPath

public BasicAuthResourceHandler addRetryBasicAuthExcludedPath(String path)

Add path to ignore #setRetryBasicAuth effect

Parameters:

path -

Returns:

setRetryBasicAuth

public BasicAuthResourceHandler setRetryBasicAuth(boolean enabled)

Enabling retry of basic authentication when authorization failed If the user-A who has already passed the BASIC authentication for page-A. Then the user-A who doesn't have the permission for page-B tries to access page-B. True:Show BASIC authentication dialog again for the user who has correct permission for page-B. False:Show error page that shows FORBIDDEN, "You don't have permission to access."

Parameters:

enabled -

Returns:

setsetSkipBasicAuthCallback

public BasicAuthResourceHandler setsetSkipBasicAuthCallback(BasicAuthLogicCore.SkipBasicAuthCallback listener)