Package org.riversun.jetty.basicauth

Class BasicAuthSecurityHandler

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.security.SecurityHandler

org.eclipse.jetty.security.ConstraintSecurityHandler

org.riversun.jetty.basicauth.BasicAuthSecurityHandler

public class BasicAuthSecurityHandler
extends org.eclipse.jetty.security.ConstraintSecurityHandler

BasicAuthSecurityHandler

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

Nested classes/interfaces inherited from class org.eclipse.jetty.security.SecurityHandler

org.eclipse.jetty.security.SecurityHandler.NotChecked

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

Fields inherited from class org.eclipse.jetty.security.SecurityHandler

__NO_USER, __NOBODY

Constructor Summary

Constructors

Constructor	Description
BasicAuthSecurityHandler()

Method Summary

Modifier and Type	Method	Description
BasicAuthSecurityHandler	addRetryBasicAuthExcludedPath(String path)	Add path to ignore #setRetryBasicAuth effect
void	handle(String pathInContext, org.eclipse.jetty.server.Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
BasicAuthSecurityHandler	setBasicAuth(BasicAuth basicAuth)	Set the condition of basic authentication
BasicAuthSecurityHandler	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.
BasicAuthSecurityHandler	setSkipBasicAuthCallback(BasicAuthLogicCore.SkipBasicAuthCallback listener)

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

doError, 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.security.ConstraintSecurityHandler

addConstraintMapping, addRole, checkPathsWithUncoveredHttpMethods, checkUserDataPermissions, checkWebResourcePermissions, configureRoleInfo, createConstraint, createConstraint, createConstraint, createConstraint, createConstraint, createConstraintsWithMappingsForPath, doStart, doStop, dump, getConstraintMappings, getConstraintMappingsForPath, getOmittedMethods, getPathsWithUncoveredHttpMethods, getRoles, isAuthMandatory, isDenyUncoveredHttpMethods, omissionsExist, prepareConstraintInfo, processConstraintMapping, processConstraintMappingWithMethodOmissions, removeConstraintMappingsForPath, setConstraintMappings, setConstraintMappings, setConstraintMappings, setDenyUncoveredHttpMethods, setRoles

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

addBean, addBean, addBean, addEventListener, addManaged, contains, 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.security.SecurityHandler

checkSecurity, findIdentityService, findLoginService, getAuthenticator, getAuthenticatorFactory, getAuthMethod, getCurrentSecurityHandler, getIdentityService, getInitParameter, getInitParameterNames, getLoginService, getRealmName, isCheckWelcomeFiles, isSessionRenewedOnAuthentication, logout, setAuthenticator, setAuthenticatorFactory, setAuthMethod, setCheckWelcomeFiles, setIdentityService, setInitParameter, setLoginService, setRealmName, setSessionRenewedOnAuthentication

Constructor Detail

BasicAuthSecurityHandler

public BasicAuthSecurityHandler()

Method Detail

setBasicAuth

public BasicAuthSecurityHandler setBasicAuth(BasicAuth basicAuth)

Set the condition of basic authentication

Parameters:

basicAuth -

Returns:

handle

public void handle(String pathInContext,
                   org.eclipse.jetty.server.Request baseRequest,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws IOException,
                   javax.servlet.ServletException

Overrides:

handle in class org.eclipse.jetty.security.SecurityHandler

Throws:

IOException

javax.servlet.ServletException

addRetryBasicAuthExcludedPath

public BasicAuthSecurityHandler addRetryBasicAuthExcludedPath(String path)

Add path to ignore #setRetryBasicAuth effect

Parameters:

path -

Returns:

setRetryBasicAuth

public BasicAuthSecurityHandler 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:

setSkipBasicAuthCallback

public BasicAuthSecurityHandler setSkipBasicAuthCallback(BasicAuthLogicCore.SkipBasicAuthCallback listener)