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

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

public class WebAppFilter
extends java.lang.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(java.lang.String servletName)
          Add a servlet name for filter.
 void addUrlPattern(java.lang.String urlPattern)
          Add an url mapping for filter.
 javax.servlet.Filter getFilter()
          Getter.
 java.lang.String getFilterClass()
          Getter.
 java.lang.String getFilterName()
          Getter.
 WebAppInitParam[] getInitParams()
          Returns the init params associated with this filter.
 java.lang.String[] getServletNames()
          Returns the servlet names associated with this filter.
 java.lang.String[] getUrlPatterns()
          Returns the url patterns associated with this filter.
 void setFilter(javax.servlet.Filter filter)
          Setter.
 void setFilterClass(java.lang.String filterClass)
          Setter.
 void setFilterName(java.lang.String filterName)
          Setter.
 java.lang.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 java.lang.String getFilterName()
Getter.

Returns:
filter name

setFilterName

public void setFilterName(java.lang.String filterName)
Setter.

Parameters:
filterName - value to set. Cannot be null
Throws:
org.ops4j.lang.NullArgumentException - if filter name is null

getFilterClass

public java.lang.String getFilterClass()
Getter.

Returns:
filter class name

setFilterClass

public void setFilterClass(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2006-2011 OPS4J - Open Participation Software for Java. All Rights Reserved.