com.tridion.ambientdata.web

Class AbstractAmbientDataServletFilter

java.lang.Object

com.tridion.ambientdata.web.AbstractAmbientDataServletFilter

All Implemented Interfaces:

javax.servlet.Filter

public abstract class AbstractAmbientDataServletFilter
extends Object
implements javax.servlet.Filter

Abstract filter that is called by the application server when a request is received.

To use the ambient data framework in a web application, you have to configure this filter class in the web.xml deployment descriptor, as in the following example:

 <?xml version="1.0" encoding="UTF-8"?>
 <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 <filter>
 <description>Servlet filter for the ambient data framework.</description>
 <filter-name>Ambient Data Framework</filter-name>
 <filter-class>com.tridion.ambientdata.web.AmbientDataServletFilter</filter-class>
 </filter>
 <filter-mapping>
 <filter-name>Ambient Data Framework</filter-name>
 <url-pattern>/*</url-pattern>
 <dispatcher>REQUEST</dispatcher>
 </filter-mapping>
 <welcome-file-list>
 <welcome-file>index.jsp</welcome-file>
 </welcome-file-list>
 </web-app>
 

Constructor Summary

Constructors

Constructor and Description
AbstractAmbientDataServletFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp, javax.servlet.FilterChain chain)
protected abstract RequestValidator	getRequestValidator()
void	init(javax.servlet.FilterConfig filterConfig)
protected abstract void	initializeEngine()
protected boolean	isRequestPathExcluded(String requestURL)
protected abstract ClaimStore	processEndEvents(ClaimStore claimStore)
protected abstract ClaimStore	processStartEvents(ClaimStore claimStore, boolean sessionIsNew)
void	setADFService(boolean adfServiceValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAmbientDataServletFilter

public AbstractAmbientDataServletFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

isRequestPathExcluded

protected boolean isRequestPathExcluded(String requestURL)

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

doFilter

public void doFilter(javax.servlet.ServletRequest req,
                     javax.servlet.ServletResponse resp,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

initializeEngine

protected abstract void initializeEngine()
                                  throws AmbientDataException

Throws:

AmbientDataException

processStartEvents

protected abstract ClaimStore processStartEvents(ClaimStore claimStore,
                                                 boolean sessionIsNew)
                                          throws AmbientDataException

Throws:

AmbientDataException

processEndEvents

protected abstract ClaimStore processEndEvents(ClaimStore claimStore)
                                        throws AmbientDataException

Throws:

AmbientDataException

getRequestValidator

protected abstract RequestValidator getRequestValidator()
                                                 throws TridionReflectionException

Throws:

TridionReflectionException

setADFService

public void setADFService(boolean adfServiceValue)