org.exoplatform.container.web

Class AbstractFilter

java.lang.Object

org.exoplatform.container.web.AbstractFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

PortalContainerFilter

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

This class is the root class of all the Filters that require an ExoContainer Created by The eXo Platform SAS Author : Nicolas Filotto nicolas.filotto@exoplatform.com

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.FilterConfig	config The filter configuration
protected String	servletContextName The Servlet context name

Constructor Summary

Constructors

Constructor and Description
AbstractFilter()

Method Summary

Modifier and Type	Method and Description
protected void	afterInit(javax.servlet.FilterConfig config) Allows sub-classes to initialize
protected ExoContainer	getContainer()
protected javax.servlet.ServletContext	getServletContext()
void	init(javax.servlet.FilterConfig config)
protected boolean	requirePortalEnvironment() Indicates if it requires that a full portal environment must be set

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.Filter

destroy, doFilter

Field Detail

config

protected javax.servlet.FilterConfig config

The filter configuration

servletContextName

protected String servletContextName

The Servlet context name

Constructor Detail

AbstractFilter

public AbstractFilter()

Method Detail

init

public final void init(javax.servlet.FilterConfig config)
                throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

afterInit

protected void afterInit(javax.servlet.FilterConfig config)
                  throws javax.servlet.ServletException

Allows sub-classes to initialize

Parameters:

config - the current filter configuration

Throws:

javax.servlet.ServletException

getContainer

protected final ExoContainer getContainer()

Returns:

Gives the ExoContainer that fits best with the current context

requirePortalEnvironment

protected boolean requirePortalEnvironment()

Indicates if it requires that a full portal environment must be set

Returns:

true if it requires the portal environment false otherwise.

getServletContext

protected javax.servlet.ServletContext getServletContext()

Returns:

the current ServletContext