org.eclipse.jetty.server.handler

Class InetAccessHandler

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

All Implemented Interfaces:

Handler, HandlerContainer, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.LifeCycle

public class InetAccessHandler
extends HandlerWrapper

Inet Address Access Handler

Controls access to the wrapped handler by the real remote IP. Control is provided by and IncludeExcludeSet over a InetAddressSet. This handler uses the real internet address of the connection, not one reported in the forwarded for headers, as this cannot be as easily forged.

Nested Class Summary

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

Field Summary

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

_handler

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
InetAccessHandler() Creates new handler object

Method Summary

Methods

Modifier and Type	Method and Description
void	dump(Appendable out, String indent)
void	exclude(String... patterns) Include a InetAddress pattern
void	exclude(String pattern) Exclude a InetAddress pattern
void	handle(String target, Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Checks the incoming request against the whitelist and blacklist
void	include(String... patterns) Include a InetAddress pattern
void	include(String pattern) Include a InetAddress pattern
protected boolean	isAllowed(InetAddress address) Check if specified request is allowed by current IPAccess rules.

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

destroy, expandChildren, getHandler, getHandlers, setHandler, setServer

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

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass

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

doStart, doStop, dumpThis, getServer

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, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, 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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

InetAccessHandler

public InetAccessHandler()

Creates new handler object

Method Detail

include

public void include(String pattern)

Include a InetAddress pattern

Parameters:

pattern - InetAddress pattern to exclude

See Also:

InetAddressSet

include

public void include(String... patterns)

Include a InetAddress pattern

Parameters:

patterns - InetAddress patterns to exclude

See Also:

InetAddressSet

exclude

public void exclude(String pattern)

Exclude a InetAddress pattern

Parameters:

pattern - InetAddress pattern to exclude

See Also:

InetAddressSet

exclude

public void exclude(String... patterns)

Include a InetAddress pattern

Parameters:

patterns - InetAddress patterns to exclude

See Also:

InetAddressSet

handle

public void handle(String target,
          Request baseRequest,
          javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
            throws IOException,
                   javax.servlet.ServletException

Checks the incoming request against the whitelist and blacklist

Specified by:

handle in interface Handler

Overrides:

handle in class HandlerWrapper

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request. The HttpChannel.getCurrentHttpChannel() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpChannel.getCurrentHttpChannel() method can be used access the Response object if required.

Throws:

IOException

javax.servlet.ServletException

See Also:

HandlerWrapper.handle(java.lang.String, org.eclipse.jetty.server.Request, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

isAllowed

protected boolean isAllowed(InetAddress address)

Check if specified request is allowed by current IPAccess rules.

Parameters:

address - internet address

Returns:

true if address is allowed

dump

public void dump(Appendable out,
        String indent)
          throws IOException

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

Overrides:

dump in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

IOException