Modifier and Type	Class and Description
private static class	CrawlerSessionManagerValve.CrawlerHttpSessionBindingListener

Modifier and Type	Field and Description
private final Map<String, String>	clientIdSessionId
private String	crawlerIps
private String	crawlerUserAgents
private Pattern	ipPattern
private boolean	isContextAware
private boolean	isHostAware
private static final Log	log Hides org.apache.catalina.util.LifecycleMBeanBase.log.
private final Map<String, String>	sessionIdClientId
private int	sessionInactiveInterval
private Pattern	uaPattern

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

Method Summary

Modifier and Type	Method and Description
private String	getClientIdentifier(Host host, Context context, String clientIp)
public Map<String, String>	getClientIpSessionId()
public String	Returns: The current regular expression being used to match IP addresses. getCrawlerIps()
public String	Returns: The current regular expression being used to match user agents. getCrawlerUserAgents()
public int	Returns: The current timeout in seconds getSessionInactiveInterval()
protected void	initInternal() Overrides org.apache.catalina.valves.ValveBase.initInternal. Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
public void	invoke(Request The servlet request to be processed request, Response The servlet response to be created response) Implements org.apache.catalina.Valve.invoke. Perform request processing as required by this Valve.
public boolean	isContextAware()
public boolean	isHostAware()
public void	setContextAware(boolean isContextAware)
public void	setCrawlerIps(String The regular expression using `Pattern` crawlerIps) Specify the regular expression (using `Pattern`) that will be used to identify crawlers based on their IP address.
public void	setCrawlerUserAgents(String The regular expression using `Pattern` crawlerUserAgents) Specify the regular expression (using `Pattern`) that will be used to identify crawlers based in the User-Agent header provided.
public void	setHostAware(boolean isHostAware)
public void	setSessionInactiveInterval(int The new timeout for crawler sessions sessionInactiveInterval) Specify the session timeout (in seconds) for a crawler's session.

Inherited from org.apache.catalina.valves.ValveBase:: backgroundProcess getContainer getDomainInternal getNext getObjectNameKeyProperties isAsyncSupported setAsyncSupported setContainer setNext startInternal stopInternal toString

Field Detail

clientIdSessionId	back to summary
private final Map<String, String> clientIdSessionId

crawlerIps	back to summary
private String crawlerIps

crawlerUserAgents	back to summary
private String crawlerUserAgents

ipPattern	back to summary
private Pattern ipPattern

isContextAware	back to summary
private boolean isContextAware

isHostAware	back to summary
private boolean isHostAware

log	back to summary
private static final Log log Hides org.apache.catalina.util.LifecycleMBeanBase.log.

sessionIdClientId	back to summary
private final Map<String, String> sessionIdClientId

sessionInactiveInterval	back to summary
private int sessionInactiveInterval

uaPattern	back to summary
private Pattern uaPattern

Constructor Detail

CrawlerSessionManagerValve	back to summary
public CrawlerSessionManagerValve() Specifies a default constructor so async support can be configured.

Method Detail

getClientIdentifier	back to summary
private String getClientIdentifier(Host host, Context context, String clientIp)

getClientIpSessionId	back to summary
public Map<String, String> getClientIpSessionId()

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

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

getSessionInactiveInterval	back to summary
public int getSessionInactiveInterval() Returns:int The current timeout in seconds See Also `setSessionInactiveInterval(int)`

initInternal	back to summary
protected void initInternal() throws LifecycleException Overrides org.apache.catalina.valves.ValveBase.initInternal. Doc from org.apache.catalina.util.LifecycleMBeanBase.initInternal. Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method. Annotations @Override Exceptions LifecycleException: Doc from org.apache.catalina.util.LifecycleBase.initInternal. If the initialisation fails

initInternal

back to summary

protected void initInternal() throws LifecycleException

Overrides org.apache.catalina.valves.ValveBase.initInternal.

Doc from org.apache.catalina.util.LifecycleMBeanBase.initInternal.

Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.

Annotations

@Override

Exceptions

LifecycleException:

Doc from org.apache.catalina.util.LifecycleBase.initInternal.

If the initialisation fails

invoke back to summary

invoke	back to summary
public void invoke(Request request, Response response) throws IOException, ServletException Implements org.apache.catalina.Valve.invoke. Doc from org.apache.catalina.Valve.invoke. Perform request processing as required by this Valve. An individual Valve MAY perform the following actions, in the specified order: Examine and/or modify the properties of the specified Request and Response. Examine the properties of the specified Request, completely generate the corresponding Response, and return control to the caller. Examine the properties of the specified Request and Response, wrap either or both of these objects to supplement their functionality, and pass them on. If the corresponding Response was not generated (and control was not returned, call the next Valve in the pipeline (if there is one) by executing `getNext().invoke()`. Examine, but not modify, the properties of the resulting Response (which was created by a subsequently invoked Valve or Container). A Valve MUST NOT do any of the following things: Change request properties that have already been used to direct the flow of processing control for this request (for instance, trying to change the virtual host to which a Request should be sent from a pipeline attached to a Host or Context in the standard implementation). Create a completed Response AND pass this Request and Response on to the next Valve in the pipeline. Consume bytes from the input stream associated with the Request, unless it is completely generating the response, or wrapping the request before passing it on. Modify the HTTP headers included with the Response after the `getNext().invoke()` method has returned. Perform any actions on the output stream associated with the specified Response after the `getNext().invoke()` method has returned. Parameters request:Request The servlet request to be processed response:Response The servlet response to be created Annotations @Override Exceptions IOException: if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet ServletException: if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet

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

Implements org.apache.catalina.Valve.invoke.

Doc from org.apache.catalina.Valve.invoke.

Perform request processing as required by this Valve.

An individual Valve MAY perform the following actions, in the specified order:

Examine and/or modify the properties of the specified Request and Response.
Examine the properties of the specified Request, completely generate the corresponding Response, and return control to the caller.
Examine the properties of the specified Request and Response, wrap either or both of these objects to supplement their functionality, and pass them on.
If the corresponding Response was not generated (and control was not returned, call the next Valve in the pipeline (if there is one) by executing getNext().invoke().
Examine, but not modify, the properties of the resulting Response (which was created by a subsequently invoked Valve or Container).

A Valve MUST NOT do any of the following things:

Change request properties that have already been used to direct the flow of processing control for this request (for instance, trying to change the virtual host to which a Request should be sent from a pipeline attached to a Host or Context in the standard implementation).
Create a completed Response AND pass this Request and Response on to the next Valve in the pipeline.
Consume bytes from the input stream associated with the Request, unless it is completely generating the response, or wrapping the request before passing it on.
Modify the HTTP headers included with the Response after the getNext().invoke() method has returned.
Perform any actions on the output stream associated with the specified Response after the getNext().invoke() method has returned.

Parameters

request:Request: The servlet request to be processed
response:Response: The servlet response to be created

Annotations

@Override

Exceptions

IOException:: if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet
ServletException:: if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet

isContextAware	back to summary
public boolean isContextAware()

isHostAware	back to summary
public boolean isHostAware()

setContextAware	back to summary
public void setContextAware(boolean isContextAware)

setCrawlerIps back to summary

setCrawlerIps	back to summary
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:String The regular expression using `Pattern`

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:String: The regular expression using Pattern

setCrawlerUserAgents back to summary

setCrawlerUserAgents	back to summary
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:String The regular expression using `Pattern`

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:String: The regular expression using Pattern

setHostAware	back to summary
public void setHostAware(boolean isHostAware)

setSessionInactiveInterval	back to summary
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:int The new timeout for crawler sessions

setSessionInactiveInterval

back to summary

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:int: The new timeout for crawler sessions

org.apache.catalina.valves back to summary

private Class CrawlerSessionManagerValve.CrawlerHttpSessionBindingListener

Class Inheritance

extends Object
implements HttpSessionBindingListener, Serializable

java.lang.Object
org.apache.catalina.valves.CrawlerSessionManagerValve.CrawlerHttpSessionBindingListener

All Implemented Interfaces

java.io.Serializable, jakarta.servlet.http.HttpSessionBindingListener, java.util.EventListener

Field Summary

Modifier and Type	Field and Description
private final transient String	clientIdentifier
private final transient Map<String, String>	clientIdSessionId
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
private	CrawlerHttpSessionBindingListener(Map<String, String> clientIdSessionId, String clientIdentifier)

Method Summary

Modifier and Type	Method and Description
public void	valueUnbound(HttpSessionBindingEvent the event that identifies the session event) Overrides default jakarta.servlet.http.HttpSessionBindingListener.valueUnbound. Notifies the object that it is being unbound from a session and identifies the session.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

clientIdentifier	back to summary
private final transient String clientIdentifier

clientIdSessionId	back to summary
private final transient Map<String, String> clientIdSessionId

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

CrawlerHttpSessionBindingListener	back to summary
private CrawlerHttpSessionBindingListener(Map<String, String> clientIdSessionId, String clientIdentifier)

Method Detail

valueUnbound	back to summary
public void valueUnbound(HttpSessionBindingEvent event) Overrides default jakarta.servlet.http.HttpSessionBindingListener.valueUnbound. Doc from jakarta.servlet.http.HttpSessionBindingListener.valueUnbound. Notifies the object that it is being unbound from a session and identifies the session. The default implementation is a NO-OP. Parameters event:HttpSessionBindingEvent the event that identifies the session Annotations @Override

valueUnbound

back to summary

public void valueUnbound(HttpSessionBindingEvent event)

Overrides default jakarta.servlet.http.HttpSessionBindingListener.valueUnbound.

Doc from jakarta.servlet.http.HttpSessionBindingListener.valueUnbound.

Notifies the object that it is being unbound from a session and identifies the session. The default implementation is a NO-OP.

Parameters

event:HttpSessionBindingEvent: the event that identifies the session

Annotations

@Override

public Class CrawlerSessionManagerValve

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CrawlerSessionManagerValve.CrawlerHttpSessionBindingListener

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail