com.atlassian.plugin.servlet.filter

Class PluginFilterConfig

java.lang.Object

com.atlassian.plugin.servlet.filter.PluginFilterConfig

All Implemented Interfaces:

javax.servlet.FilterConfig

public class PluginFilterConfig
extends Object
implements javax.servlet.FilterConfig

Instances of the PluginFilterConfig are passed to plugins Filter init() method. It provides access to the init parameters defined in the plugin xml as well as the ServletContext shared by other filters and servlets in the plugin.

Since:

2.1.0

Constructor Summary

Constructors

Constructor and Description
PluginFilterConfig(ServletFilterModuleDescriptor descriptor, javax.servlet.ServletContext servletContext)

Method Summary

Modifier and Type	Method and Description
String	getFilterName()
String	getInitParameter(String name)
Enumeration<String>	getInitParameterNames()
javax.servlet.ServletContext	getServletContext()

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginFilterConfig

public PluginFilterConfig(ServletFilterModuleDescriptor descriptor,
                          javax.servlet.ServletContext servletContext)

Method Detail

getFilterName

public String getFilterName()

Specified by:

getFilterName in interface javax.servlet.FilterConfig

getInitParameter

public String getInitParameter(String name)

Specified by:

getInitParameter in interface javax.servlet.FilterConfig

getInitParameterNames

public Enumeration<String> getInitParameterNames()

Specified by:

getInitParameterNames in interface javax.servlet.FilterConfig

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.FilterConfig