org.apache.catalina.valves

## Class CrawlerSessionManagerValve

- java.lang.Object
- - org.apache.catalina.util.LifecycleBase
  - - org.apache.catalina.util.LifecycleMBeanBase
    - - org.apache.catalina.valves.ValveBase
      - - org.apache.catalina.valves.CrawlerSessionManagerValve

- All Implemented Interfaces:
    EventListener, MBeanRegistration, HttpSessionBindingListener, Contained, Lifecycle, Valve

      public class CrawlerSessionManagerValve
      extends ValveBase
      implements HttpSessionBindingListener

  Web crawlers can trigger the creation of many thousands of sessions as they crawl a site which may result in significant memory consumption. This Valve ensures that crawlers are associated with a single session - just like normal users - regardless of whether or not they provide a session token with their requests.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

      `Lifecycle.SingleUse`

  - ### Field Summary

    - ### Fields inherited from class org.apache.catalina.valves.ValveBase

      `asyncSupported, container, containerLog, info, next, sm`

    - ### Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

      `mserver`

    - ### Fields inherited from interface org.apache.catalina.Lifecycle

      `AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `CrawlerSessionManagerValve()` Specifies a default constructor so async support can be configured.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,String>` | `getClientIpSessionId()`
    `String` | `getCrawlerIps()`
    `String` | `getCrawlerUserAgents()`
    `int` | `getSessionInactiveInterval()`
    `protected void` | `initInternal()` Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
    `void` | `invoke(Request request, Response response)` The implementation-specific logic represented by this Valve.
    `void` | `setCrawlerIps(String crawlerIps)` Specify the regular expression (using `Pattern`) that will be used to identify crawlers based on their IP address.
    `void` | `setCrawlerUserAgents(String crawlerUserAgents)` Specify the regular expression (using `Pattern`) that will be used to identify crawlers based in the User-Agent header provided.
    `void` | `setSessionInactiveInterval(int sessionInactiveInterval)` Specify the session timeout (in seconds) for a crawler's session.
    `void` | `valueBound(HttpSessionBindingEvent event)` Notifies the object that it is being bound to a session and identifies the session.
    `void` | `valueUnbound(HttpSessionBindingEvent event)` Notifies the object that it is being unbound from a session and identifies the session.

    - ### Methods inherited from class org.apache.catalina.valves.ValveBase

      `backgroundProcess, event, getContainer, getDomainInternal, getInfo, getNext, getObjectNameKeyProperties, isAsyncSupported, setAsyncSupported, setContainer, setNext, startInternal, stopInternal, toString`

    - ### Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

      `destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister`

    - ### Methods inherited from class org.apache.catalina.util.LifecycleBase

      `addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### CrawlerSessionManagerValve

          public CrawlerSessionManagerValve()

      Specifies a default constructor so async support can be configured.

  - ### Method Detail

    - #### setCrawlerUserAgents

          public void setCrawlerUserAgents(String crawlerUserAgents)

      Specify the regular expression (using `Pattern`) that will be used to identify crawlers based in the User-Agent header provided. The default is ".*GoogleBot.*|.*bingbot.*|.*Yahoo! Slurp.*"
      Parameters:
        `crawlerUserAgents` - The regular expression using `Pattern`

    - #### getCrawlerUserAgents

          public String getCrawlerUserAgents()

      Returns:
        The current regular expression being used to match user agents.
      See Also:
        `setCrawlerUserAgents(String)`

    - #### setCrawlerIps

          public void setCrawlerIps(String crawlerIps)

      Specify the regular expression (using `Pattern`) that will be used to identify crawlers based on their IP address. The default is no crawler IPs.
      Parameters:
        `crawlerIps` - The regular expression using `Pattern`

    - #### getCrawlerIps

          public String getCrawlerIps()

      Returns:
        The current regular expression being used to match IP addresses.
      See Also:
        `setCrawlerIps(String)`

    - #### setSessionInactiveInterval

          public void setSessionInactiveInterval(int sessionInactiveInterval)

      Specify the session timeout (in seconds) for a crawler's session. This is typically lower than that for a user session. The default is 60 seconds.
      Parameters:
        `sessionInactiveInterval` - The new timeout for crawler sessions

    - #### getSessionInactiveInterval

          public int getSessionInactiveInterval()

      Returns:
        The current timeout in seconds
      See Also:
        `setSessionInactiveInterval(int)`

    - #### getClientIpSessionId

          public Map<String,String> getClientIpSessionId()

    - #### initInternal

          protected void initInternal()
                               throws LifecycleException

      Description copied from class: `LifecycleMBeanBase`
      Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
      Overrides:
        `initInternal` in class `ValveBase`
      Throws:
        `LifecycleException`

    - #### invoke

          public void invoke(Request request,
                    Response response)
                      throws IOException,
                             ServletException

      Description copied from class: `ValveBase`
      The implementation-specific logic represented by this Valve. See the Valve description for the normal design patterns for this method.

      This method MUST be provided by a subclass.

      Specified by:
        `invoke` in interface `Valve`
      Specified by:
        `invoke` in class `ValveBase`
      Parameters:
        `request` - The servlet request to be processed
        `response` - The servlet response to be created
      Throws:
        `IOException` - if an input/output error occurs
        `ServletException` - if a servlet error occurs

    - #### valueBound

          public void valueBound(HttpSessionBindingEvent event)

      Description copied from interface: `javax.servlet.http.HttpSessionBindingListener`
      Notifies the object that it is being bound to a session and identifies the session.
      Specified by:
        `valueBound` in interface `HttpSessionBindingListener`
      Parameters:
        `event` - the event that identifies the session
      See Also:
        `HttpSessionBindingListener.valueUnbound(javax.servlet.http.HttpSessionBindingEvent)`

    - #### valueUnbound

          public void valueUnbound(HttpSessionBindingEvent event)

      Description copied from interface: `javax.servlet.http.HttpSessionBindingListener`
      Notifies the object that it is being unbound from a session and identifies the session.
      Specified by:
        `valueUnbound` in interface `HttpSessionBindingListener`
      Parameters:
        `event` - the event that identifies the session
      See Also:
        `HttpSessionBindingListener.valueBound(javax.servlet.http.HttpSessionBindingEvent)`

Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.