com.atlassian.plugin.servlet.descriptors

Class ServletFilterModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor<javax.servlet.Filter>

com.atlassian.plugin.servlet.descriptors.ServletFilterModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<javax.servlet.Filter>, Resourced, StateAware

public class ServletFilterModuleDescriptor
extends BaseServletModuleDescriptor<javax.servlet.Filter>
implements StateAware

A module descriptor that allows plugin developers to define servlet filters. Developers can define what urls the filter should be applied to by defining one or more <url-pattern> elements and they can decide where in the filter stack a plugin filter should go by defining the "location" and "weight" attributes.

The location attribute can have one of four values:

• after-encoding - after the character encoding filter
• before-login - before the login filter
• before-decoration - before any global decoration like sitemesh
• before-dispatch - before any dispatching filters or servlets

The default for the location attribute is "before-dispatch".

The weight attribute can have any integer value. Filters with lower values of the weight attribute will come before those with higher values within the same location.

Since:

2.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<ServletFilterModuleDescriptor>	byWeight

Fields inherited from class com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor

log

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

Constructors

Constructor and Description
ServletFilterModuleDescriptor(ModuleFactory moduleFactory, ServletModuleManager servletModuleManager) Creates a descriptor that uses a module class factory to create instances.

Method Summary

Modifier and Type	Method and Description
void	disabled()
void	enabled()
Set<FilterDispatcherCondition>	getDispatcherConditions() Returns a set of dispatcher conditions that have been set for this filter, these conditions will be one of the following: REQUEST, FORWARD, INCLUDE or ERROR.
FilterLocation	getLocation()
javax.servlet.Filter	getModule()
int	getWeight()
void	init(Plugin plugin, org.dom4j.Element element)
protected void	provideValidationRules(ValidationPattern pattern)

Methods inherited from class com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor

getInitParams, getPaths

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isBroken, isEnabled, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

byWeight

public static final Comparator<ServletFilterModuleDescriptor> byWeight

Constructor Detail

ServletFilterModuleDescriptor

public ServletFilterModuleDescriptor(ModuleFactory moduleFactory,
                                     ServletModuleManager servletModuleManager)

Creates a descriptor that uses a module class factory to create instances.

Parameters:

moduleFactory - The module factory

servletModuleManager - The module manager

Since:

2.5.0

Method Detail

init

public void init(Plugin plugin,
                 org.dom4j.Element element)
          throws PluginParseException

Specified by:

init in interface ModuleDescriptor<javax.servlet.Filter>

Overrides:

init in class BaseServletModuleDescriptor<javax.servlet.Filter>

Throws:

PluginParseException

provideValidationRules

protected void provideValidationRules(ValidationPattern pattern)

Overrides:

provideValidationRules in class BaseServletModuleDescriptor<javax.servlet.Filter>

enabled

public void enabled()

Specified by:

enabled in interface StateAware

Overrides:

enabled in class AbstractModuleDescriptor<javax.servlet.Filter>

disabled

public void disabled()

Specified by:

disabled in interface StateAware

Overrides:

disabled in class AbstractModuleDescriptor<javax.servlet.Filter>

getModule

public javax.servlet.Filter getModule()

Specified by:

getModule in interface ModuleDescriptor<javax.servlet.Filter>

Specified by:

getModule in class AbstractModuleDescriptor<javax.servlet.Filter>

getLocation

public FilterLocation getLocation()

getWeight

public int getWeight()

getDispatcherConditions

public Set<FilterDispatcherCondition> getDispatcherConditions()

Returns a set of dispatcher conditions that have been set for this filter, these conditions will be one of the following: REQUEST, FORWARD, INCLUDE or ERROR.

Returns:

A set of dispatcher conditions that have been set for this filter.

Since:

2.5.0