A B C D F G I L N S T

A

ActiveStreamsServlet - class com.opensymphony.clickstream.servlet.ActiveStreamsServlet.

A simple servlet that shows active streams.

ActiveStreamsServlet() - Constructor for class com.opensymphony.clickstream.servlet.ActiveStreamsServlet

addBotAgent(String) - Method in class com.opensymphony.clickstream.config.ClickstreamConfig

addBotHost(String) - Method in class com.opensymphony.clickstream.config.ClickstreamConfig

addRequest(HttpServletRequest) - Method in class com.opensymphony.clickstream.Clickstream

Adds a new request to the stream of clicks.

B

BotChecker - class com.opensymphony.clickstream.BotChecker.

Determines if a request is actually a bot or spider.

BotChecker() - Constructor for class com.opensymphony.clickstream.BotChecker

C

CLICKSTREAMS_ATTRIBUTE_KEY - Static variable in class com.opensymphony.clickstream.ClickstreamListener

The servlet context attribute key.

Clickstream - class com.opensymphony.clickstream.Clickstream.

The actual stream of clicks tracked during a user's navigation through a site.

Clickstream() - Constructor for class com.opensymphony.clickstream.Clickstream

ClickstreamConfig - class com.opensymphony.clickstream.config.ClickstreamConfig.

Clickstream configuration data.

ClickstreamConfig() - Constructor for class com.opensymphony.clickstream.config.ClickstreamConfig

ClickstreamFilter - class com.opensymphony.clickstream.ClickstreamFilter.

The filter that keeps track of a new entry in the clickstream for every request.

ClickstreamFilter() - Constructor for class com.opensymphony.clickstream.ClickstreamFilter

ClickstreamListener - class com.opensymphony.clickstream.ClickstreamListener.

The listener that keeps track of all clickstreams in the container as well as the creating new Clickstream objects and initiating logging when the clickstream dies (session has been invalidated).

ClickstreamListener() - Constructor for class com.opensymphony.clickstream.ClickstreamListener

ClickstreamLogger - interface com.opensymphony.clickstream.logger.ClickstreamLogger.

A simple interface that is called when a session is invalidated the clickstream is finished.

ClickstreamLoggerFactory - class com.opensymphony.clickstream.logger.ClickstreamLoggerFactory.

Simple factory that creates ClickstreamLogger instances.

ClickstreamLoggerFactory() - Constructor for class com.opensymphony.clickstream.logger.ClickstreamLoggerFactory

ClickstreamRequest - class com.opensymphony.clickstream.ClickstreamRequest.

A small class that captures the most important info from the HttpServletRequest for each "click".

ClickstreamRequest(HttpServletRequest, Date) - Constructor for class com.opensymphony.clickstream.ClickstreamRequest

ConfigLoader - class com.opensymphony.clickstream.config.ConfigLoader.

Loads up either clickstream.xml or clickstream-default.xml and returns a singleton instance of ClickstreamConfig.

com.opensymphony.clickstream - package com.opensymphony.clickstream

com.opensymphony.clickstream.config - package com.opensymphony.clickstream.config

com.opensymphony.clickstream.logger - package com.opensymphony.clickstream.logger

com.opensymphony.clickstream.servlet - package com.opensymphony.clickstream.servlet

contextDestroyed(ServletContextEvent) - Method in class com.opensymphony.clickstream.ClickstreamListener

Notification that the ServletContext has been destroyed.

contextInitialized(ServletContextEvent) - Method in class com.opensymphony.clickstream.ClickstreamListener

Notification that the ServletContext has been initialized.

D

destroy() - Method in class com.opensymphony.clickstream.ClickstreamFilter

Destroys this filter.

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class com.opensymphony.clickstream.ClickstreamFilter

Processes the given request and/or response.

doGet(HttpServletRequest, HttpServletResponse) - Method in class com.opensymphony.clickstream.servlet.ActiveStreamsServlet

F

filterConfig - Variable in class com.opensymphony.clickstream.ClickstreamFilter

G

getAttribute(String) - Method in class com.opensymphony.clickstream.Clickstream

Gets an attribute for this clickstream.

getAttributeNames() - Method in class com.opensymphony.clickstream.Clickstream

Gets the attribute names for this clickstream.

getBotAgents() - Method in class com.opensymphony.clickstream.config.ClickstreamConfig

getBotHosts() - Method in class com.opensymphony.clickstream.config.ClickstreamConfig

getConfig() - Method in class com.opensymphony.clickstream.config.ConfigLoader

getHostname() - Method in class com.opensymphony.clickstream.Clickstream

Returns the host name that this clickstream relates to.

getInitialReferrer() - Method in class com.opensymphony.clickstream.Clickstream

The URL of the initial referer.

getInstance() - Static method in class com.opensymphony.clickstream.config.ConfigLoader

getLastRequest() - Method in class com.opensymphony.clickstream.Clickstream

Returns the last Date that the clickstream was modified.

getLogger() - Static method in class com.opensymphony.clickstream.logger.ClickstreamLoggerFactory

Returns a new logging instance.

getLoggerClass() - Method in class com.opensymphony.clickstream.config.ClickstreamConfig

getProtocol() - Method in class com.opensymphony.clickstream.ClickstreamRequest

getQueryString() - Method in class com.opensymphony.clickstream.ClickstreamRequest

getRemoteUser() - Method in class com.opensymphony.clickstream.ClickstreamRequest

getRequestURI() - Method in class com.opensymphony.clickstream.ClickstreamRequest

getServerName() - Method in class com.opensymphony.clickstream.ClickstreamRequest

getServerPort() - Method in class com.opensymphony.clickstream.ClickstreamRequest

getSession() - Method in class com.opensymphony.clickstream.Clickstream

Returns the HttpSession associated with this clickstream.

getStart() - Method in class com.opensymphony.clickstream.Clickstream

Returns the Date when the clickstream began.

getStream() - Method in class com.opensymphony.clickstream.Clickstream

Returns the actual List of ClickstreamRequest objects.

getTimestamp() - Method in class com.opensymphony.clickstream.ClickstreamRequest

I

init(FilterConfig) - Method in class com.opensymphony.clickstream.ClickstreamFilter

Initializes this filter.

init(ServletConfig) - Method in class com.opensymphony.clickstream.servlet.ActiveStreamsServlet

isBot(HttpServletRequest) - Static method in class com.opensymphony.clickstream.BotChecker

isBot() - Method in class com.opensymphony.clickstream.Clickstream

Returns the bot status.

L

log(Clickstream) - Method in interface com.opensymphony.clickstream.logger.ClickstreamLogger

Initiates logging on a clickstream that just recently finished or was invalidated.

log(Clickstream) - Method in class com.opensymphony.clickstream.logger.NullClickstreamLogger

log(Clickstream) - Method in class com.opensymphony.clickstream.logger.SimpleClickstreamLogger

N

NullClickstreamLogger - class com.opensymphony.clickstream.logger.NullClickstreamLogger.

A simple ClickstreamLogger that outputs nothing (Null Design Pattern).

NullClickstreamLogger() - Constructor for class com.opensymphony.clickstream.logger.NullClickstreamLogger

S

SESSION_ATTRIBUTE_KEY - Static variable in class com.opensymphony.clickstream.ClickstreamListener

The click stream (individual) attribute key: this is the one inserted into the HttpSession.

SimpleClickstreamLogger - class com.opensymphony.clickstream.logger.SimpleClickstreamLogger.

A simple ClickstreamLogger that outputs the entire clickstream to the Jakarta Commons Logging component.

SimpleClickstreamLogger() - Constructor for class com.opensymphony.clickstream.logger.SimpleClickstreamLogger

sessionCreated(HttpSessionEvent) - Method in class com.opensymphony.clickstream.ClickstreamListener

Notification that a Session has been created.

sessionDestroyed(HttpSessionEvent) - Method in class com.opensymphony.clickstream.ClickstreamListener

Notification that a session has been destroyed.

setAttribute(String, Object) - Method in class com.opensymphony.clickstream.Clickstream

Sets an attribute for this clickstream.

setLoggerClass(String) - Method in class com.opensymphony.clickstream.config.ClickstreamConfig

T

toString() - Method in class com.opensymphony.clickstream.ClickstreamRequest

Returns a string representation of the HTTP request being tracked.

A B C D F G I L N S T