public class

ServletFilterModuleDescriptor

extends BaseServletModuleDescriptor<T>
implements StateAware

java.lang.Object
↳	com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
	↳	com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor<T>
		↳	com.atlassian.plugin.servlet.descriptors.ServletFilterModuleDescriptor

Class Overview

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.

Summary

Fields
public static final Comparator<ServletFilterModuleDescriptor>	byWeight

[Expand]

Inherited Fields

From class com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor

From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

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

Public Methods
void	disabled() Disables the module descriptor.
void	enabled() Enables the descriptor by loading the module class.
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()
Filter	getModule() The particular module object created by this plugin.
int	getWeight()
void	init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module.

Protected Methods
void	provideValidationRules(ValidationPattern pattern) Provides validation rules for the pattern

[Expand]

Inherited Methods

From class com.atlassian.plugin.servlet.descriptors.BaseServletModuleDescriptor

From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

From class java.lang.Object

From interface com.atlassian.plugin.ModuleDescriptor

abstract void	destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed.
abstract String	getCompleteKey() The complete key for this module, including the plugin key.
abstract String	getDescription() A simple description of this descriptor.
abstract String	getDescriptionKey() Key used to override `getDescription()` when using internationalisation.
abstract String	getI18nNameKey() Key used to override `getName()` when using internationalisation.
abstract String	getKey() The key for this module, unique within the plugin.
abstract Float	getMinJavaVersion()
abstract T	getModule() The particular module object created by this plugin.
abstract Class<T>	getModuleClass() The class of the module this descriptor creates.
abstract String	getName() A simple string name for this descriptor.
abstract Map<String, String>	getParams()
abstract Plugin	getPlugin()
abstract String	getPluginKey() The plugin key for this module, derived from the complete key.
abstract void	init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module.
abstract boolean	isEnabledByDefault() Whether or not this plugin module is enabled by default.
abstract boolean	isSystemModule() Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.
abstract boolean	satisfiesMinJavaVersion() If a min java version has been specified this will return true if the running jvm is >= to the specified version.

From interface com.atlassian.plugin.Resourced

From interface com.atlassian.plugin.StateAware

Fields

public static final Comparator<ServletFilterModuleDescriptor> byWeight

Public Constructors

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

Public Methods

public void disabled ()

Disables the module descriptor. Classes overriding this method MUST call super.disabled() after their own disabling code.

public void enabled ()

Enables the descriptor by loading the module class. Classes overriding this method MUST call super.enabled() before their own enabling code.

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.

public FilterLocation getLocation ()

public Filter getModule ()

The particular module object created by this plugin.

Returns

The module object created by this plugin.

public int getWeight ()

public void init (Plugin plugin, Element element)

Initialise a module given it's parent plugin and the XML element representing the module.

Since atlassian-plugins v2.2, you can no longer load classes from the plugin in this method, because the OSGi bundle that they will live in is not built yet. Load classes in the enabled() method instead.

Parameters

plugin	The plugin that the module belongs to. Must not be null.
element	XML element representing the module. Must not be null.

Throws

PluginParseException

Protected Methods

protected void provideValidationRules (ValidationPattern pattern)

Provides validation rules for the pattern

Parameters

pattern	The validation pattern