XI2PLocationFilter

net.i2p.servlet.filters.XI2PLocationFilter

All Implemented Interfaces:: Handler, HandlerContainer, Container, Destroyable, Dumpable, LifeCycle

public class XI2PLocationFilterextends HandlerWrapper

Adds a header, X-I2P-Location, to requests when they do **not** come in on an I2P hostname. This header contains a URL that looks like: [scheme://][i2phostname.i2p][/path][?query] and expresses the I2P-Equivalent URL of the clearnet query. Clients can use this to prompt users to switch from a non-I2P host to an I2P host or to redirect them automatically. It automatically enabled on the default I2P site located on port 7658 by default.

Nested Class Summary
Nested classes/interfaces inherited from class AbstractLifeCycle
AbstractLifeCycle.AbstractLifeCycleListener
Nested classes/interfaces inherited from interface Container
Container.InheritedListener, Container.Listener
Nested classes/interfaces inherited from interface LifeCycle
LifeCycle.Listener
Field Summary
Fields
Modifier and Type
Field
Description
private final Log
_log
The log for the filter.
private static final long
failTimeout
Time before retrying after a failure.
private long
lastFailure
When the last fetch failed.
private static final String
PROP_ENABLE_LOCATION_HEADER
Config key enabling the location header.
private String
X_I2P_Location
The cached header value.
Fields inherited from class HandlerWrapper
_handler
Fields inherited from class AbstractLifeCycle
FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING
Constructor Summary
Constructors
Constructor
Description
XI2PLocationFilter()
No location header prefix is cached and no failure is recorded; setLocation(String) picks the prefix up from the first request that carries one.
Method Summary
Modifier and Type
Method
Description
private String
getXI2PLocation(String host, String port)
Gets the location header for a target.
void
handle(String target, Request request, HttpServletRequest httpRequest, HttpServletResponse httpResponse)

private String
headerContents(HttpServletRequest httpRequest)
Builds the header value from the request.
private void
setLocation(String xi2plocation)
Caches the header value.
private boolean
shouldRecheck()
Whether to retry the fetch after a failure.
Methods inherited from class HandlerWrapper
destroy, expandChildren, getHandler, getHandlers, insertHandler, setHandler
Methods inherited from class AbstractHandlerContainer
expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer
Methods inherited from class AbstractHandler
doStart, doStop, dumpThis, getServer
Methods inherited from class ContainerLifeCycle
addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans
Methods inherited from class AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- PROP_ENABLE_LOCATION_HEADER
  private static final String PROP_ENABLE_LOCATION_HEADER
  Config key enabling the location header.
  See Also:
  Constant Field Values
- X_I2P_Location
  private String X_I2P_Location
  The cached header value.
- lastFailure
  private long lastFailure
  When the last fetch failed.
- failTimeout
  private static final long failTimeout
  Time before retrying after a failure.
  See Also:
  Constant Field Values
- _log
  private final Log _log
  The log for the filter.
Constructor Details
- XI2PLocationFilter
  public XI2PLocationFilter()
  No location header prefix is cached and no failure is recorded; setLocation(String) picks the prefix up from the first request that carries one.
Method Details
- setLocation
  private void setLocation(String xi2plocation)
  Caches the header value.
  Parameters:
  xi2plocation - the value to cache
- shouldRecheck
  private boolean shouldRecheck()
  Whether to retry the fetch after a failure.
  Returns:
  true when it is time to retry
- getXI2PLocation
  private String getXI2PLocation(String host, String port)
  Gets the location header for a target.
  Parameters:
  host - the target host
  port - the target port
  Returns:
  the header value
- headerContents
  private String headerContents(HttpServletRequest httpRequest)
  Builds the header value from the request.
  Parameters:
  httpRequest - the request to describe
  Returns:
  the header value
- handle
  public void handle(String target, Request request, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException
  Specified by:
  handle in interface Handler
  Overrides:
  handle in class HandlerWrapper
  Throws:
  IOException
  ServletException

Nested Class Summary

Nested classes/interfaces inherited from class AbstractLifeCycle

Nested classes/interfaces inherited from interface Container

Nested classes/interfaces inherited from interface LifeCycle

Field Summary

Fields inherited from class HandlerWrapper

Fields inherited from class AbstractLifeCycle

Constructor Summary

Method Summary

Methods inherited from class HandlerWrapper

Methods inherited from class AbstractHandlerContainer

Methods inherited from class AbstractHandler

Methods inherited from class ContainerLifeCycle

Methods inherited from class AbstractLifeCycle

Methods inherited from class Object

Field Details

PROP_ENABLE_LOCATION_HEADER

X_I2P_Location

lastFailure

failTimeout

_log

Constructor Details

Method Details

setLocation

shouldRecheck

getXI2PLocation

headerContents

handle