org.ops4j.pax.web.extender.war.internal.model
Class WebAppFilter

java.lang.Object
  org.ops4j.pax.web.extender.war.internal.model.WebAppFilter

public class WebAppFilter
extends Object

Models filter element in web.xml.

Since:

0.3.0, December 27, 2007

Author:

Alin Dreghiciu

Constructor Summary

WebAppFilter()
Creates a new web app filter.

Method Summary

void	addInitParam(WebAppInitParam param) Add a init param for filter.
void	addServletName(String servletName) Add a servlet name for filter.
void	addUrlPattern(String urlPattern) Add an url mapping for filter.
javax.servlet.Filter	getFilter() Getter.
String	getFilterClass() Getter.
String	getFilterName() Getter.
WebAppInitParam[]	getInitParams() Returns the init params associated with this filter.
String[]	getServletNames() Returns the servlet names associated with this filter.
String[]	getUrlPatterns() Returns the url patterns associated with this filter.
void	setFilter(javax.servlet.Filter filter) Setter.
void	setFilterClass(String filterClass) Setter.
void	setFilterName(String filterName) Setter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAppFilter

public WebAppFilter()

Creates a new web app filter.

Method Detail

getFilterName

public String getFilterName()

Getter.

Returns:

filter name

setFilterName

public void setFilterName(String filterName)

Setter.

Parameters:

filterName - value to set. Cannot be null

Throws:

org.ops4j.lang.NullArgumentException - if filter name is null

getFilterClass

public String getFilterClass()

Getter.

Returns:

filter class name

setFilterClass

public void setFilterClass(String filterClass)

Setter.

Parameters:

filterClass - value to set. Cannot be null.

Throws:

org.ops4j.lang.NullArgumentException - if filter class is null

getFilter

public javax.servlet.Filter getFilter()

Getter.

Returns:

filter

setFilter

public void setFilter(javax.servlet.Filter filter)

Setter.

Parameters:

filter - value to set

getUrlPatterns

public String[] getUrlPatterns()

Returns the url patterns associated with this filter. If there are no associated url patterns an empty array is returned.

Returns:

array of url patterns

addUrlPattern

public void addUrlPattern(String urlPattern)

Add an url mapping for filter.

Parameters:

urlPattern - to be added. Cannot be null

Throws:

org.ops4j.lang.NullArgumentException - if url pattern is null or empty

getServletNames

public String[] getServletNames()

Returns the servlet names associated with this filter. If there are no associated servlet names an empty array is returned.

Returns:

array of servlet names

addServletName

public void addServletName(String servletName)

Add a servlet name for filter.

Parameters:

servletName - to be added. Cannot be null

Throws:

org.ops4j.lang.NullArgumentException - if servlet name is null or empty

addInitParam

public void addInitParam(WebAppInitParam param)

Add a init param for filter.

Parameters:

param - to be added. Canot be null

Throws:

org.ops4j.lang.NullArgumentException - if param, param name, param value is null

getInitParams

public WebAppInitParam[] getInitParams()

Returns the init params associated with this filter. If there are no associated init params an empty array is returned.

Returns:

array of url patterns

toString

public String toString()

Overrides:

toString in class Object