Class InetAccessHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.Handler.Abstract

org.eclipse.jetty.server.Handler.AbstractContainer

org.eclipse.jetty.server.Handler.Wrapper

org.eclipse.jetty.server.handler.ConditionalHandler

org.eclipse.jetty.server.handler.ConditionalHandler.Abstract

org.eclipse.jetty.server.handler.InetAccessHandler

All Implemented Interfaces:

Handler, Handler.Container, Handler.Singleton, Request.Handler, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable

public class InetAccessHandler
extends ConditionalHandler.Abstract

InetAddress Access Handler

Controls access to the wrapped handler using 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 ConditionalHandler

ConditionalHandler.Abstract, ConditionalHandler.ConnectorPredicate, ConditionalHandler.DontHandle, ConditionalHandler.ElseNext, ConditionalHandler.InetAddressPatternPredicate, ConditionalHandler.MethodPredicate, ConditionalHandler.PathSpecPredicate, ConditionalHandler.PredicateSet, ConditionalHandler.Reject, ConditionalHandler.SkipNext

Nested classes/interfaces inherited from class Handler.Abstract

Handler.Abstract.NonBlocking

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface Handler

Handler.AbstractContainer, Handler.Collection, Handler.Container, Handler.Sequence, Handler.Singleton, Handler.Wrapper

Nested classes/interfaces inherited from interface Invocable

Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Nested classes/interfaces inherited from interface Request.Handler

Request.Handler.AbortException

Field Summary

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Fields inherited from interface Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
InetAccessHandler()
InetAccessHandler(Handler handler)

Method Summary

Modifier and Type	Method	Description
void	exclude(String pattern)	Excludes an InetAccess entry pattern with an optional connector name, address and URI mapping.
void	exclude(String... patterns)	Excludes InetAccess patterns
void	exclude(String connectorName, String addressPattern, PathSpec pathSpec)	Excludes an InetAccess entry.
void	include(String pattern)	Includes an InetAccess pattern with an optional connector name, address and URI mapping.
void	include(String... patterns)	Includes InetAccess patterns
void	include(String connectorName, String addressPattern, PathSpec pathSpec)	Includes an InetAccess entry.
protected boolean	onConditionsMet(Request request, Response response, Callback callback)	Handle a request that has met the conditions.
protected boolean	onConditionsNotMet(Request request, Response response, Callback callback)	This method is called when the request has not met the conditions and is not to be handled by this handler.

Methods inherited from class ConditionalHandler

clear, doStart, dump, exclude, exclude, exclude, excludeInetAddressPattern, excludeMethod, excludePath, from, from, handle, include, include, include, includeInetAddressPattern, includeMethod, includePath, nextHandler

Methods inherited from class Handler.Wrapper

getHandler, getInvocationType, setHandler

Methods inherited from class Handler.AbstractContainer

findContainerOf, getDescendant, getDescendants, isDynamic, setDynamic, setServer

Methods inherited from class Handler.Abstract

destroy, doStop, getServer

Methods inherited from class ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

Methods inherited from class Object

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

Methods inherited from interface Container

getCachedBeans, getEventListeners

Methods inherited from interface Destroyable

destroy

Methods inherited from interface Dumpable

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Methods inherited from interface Handler

getServer, setServer

Methods inherited from interface Handler.Container

getContainer, getDescendant, getDescendants, getDescendants

Methods inherited from interface Handler.Singleton

getHandlers, getTail, insertHandler, setHandler

Methods inherited from interface LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Constructor Details

InetAccessHandler

public InetAccessHandler()

InetAccessHandler

public InetAccessHandler(Handler handler)

Method Details

onConditionsMet

protected boolean onConditionsMet(Request request,
 Response response,
 Callback callback)
                           throws Exception

Description copied from class: ConditionalHandler

Handle a request that has met the conditions. Typically, the implementation will provide optional handling and then call the ConditionalHandler.nextHandler(Request, Response, Callback) method to continue handling.

Specified by:

onConditionsMet in class ConditionalHandler

Parameters:

request - The request to handle

response - The response to generate

callback - The callback for completion

Returns:

True if this handler will complete the callback

Throws:

Exception - If there is a problem handling

See Also:

• Request.Handler.handle(Request, Response, Callback)

onConditionsNotMet

protected boolean onConditionsNotMet(Request request,
 Response response,
 Callback callback)
                              throws Exception

Description copied from class: ConditionalHandler

This method is called when the request has not met the conditions and is not to be handled by this handler. Implementations may return false; send an error response; or handle the request differently.

Specified by:

onConditionsNotMet in class ConditionalHandler

Parameters:

request - The request to handle

response - The response to generate

callback - The callback for completion

Returns:

True if this handler will complete the callback

Throws:

Exception - If there is a problem handling

See Also:

• Request.Handler.handle(Request, Response, Callback)

include

public void include(String pattern)

Includes an InetAccess pattern with an optional connector name, address and URI mapping.

The connector name is separated from the InetAddress pattern with an '@' character, and the InetAddress pattern is separated from the URI pattern using the "|" (pipe) character. URI patterns follow the servlet specification for simple * prefix and suffix wild cards (e.g. /, /foo, /foo/bar, /foo/bar/*, *.baz).

Examples:

• "connector1@127.0.0.1|/foo"
• "127.0.0.1|/foo"
• "connector1@127.0.0.1"
• "127.0.0.1"

Parameters:

pattern - InetAccess pattern to include

See Also:

• InetAddressSet

include

public void include(String... patterns)

Includes InetAccess patterns

Parameters:

patterns - InetAddress patterns to include

See Also:

• InetAddressSet

include

public void include(String connectorName,
 String addressPattern,
 PathSpec pathSpec)

Includes an InetAccess entry.

Parameters:

connectorName - optional name of a connector to include.

addressPattern - optional InetAddress pattern to include.

pathSpec - optional pathSpec to include.

exclude

public void exclude(String pattern)

Excludes an InetAccess entry pattern with an optional connector name, address and URI mapping.

The connector name is separated from the InetAddress pattern with an '@' character, and the InetAddress pattern is separated from the URI pattern using the "|" (pipe) character. A method name is separated from the URI pattern using the ">" character. URI patterns follow the servlet specification for simple * prefix and suffix wild cards (e.g. /, /foo, /foo/bar, /foo/bar/*, *.baz).

Examples:

• "connector1@127.0.0.1|/foo"
• "127.0.0.1|/foo"
• "127.0.0.1>GET|/foo"
• "127.0.0.1>GET"
• "connector1@127.0.0.1"
• "127.0.0.1"

Parameters:

pattern - InetAddress pattern to exclude

See Also:

• InetAddressSet

exclude

public void exclude(String... patterns)

Excludes InetAccess patterns

Parameters:

patterns - InetAddress patterns to exclude

See Also:

• InetAddressSet

exclude

public void exclude(String connectorName,
 String addressPattern,
 PathSpec pathSpec)

Excludes an InetAccess entry.

Parameters:

connectorName - optional name of a connector to exclude.

addressPattern - optional InetAddress pattern to exclude.

pathSpec - optional pathSpec to exclude.