jrun.servlet.metadata
Class FilterMetaData

java.lang.Object
  |
  +--jrunx.xml.XMLMetaData
        |
        +--jrun.servlet.metadata.FilterMetaData

public class FilterMetaData

extends XMLMetaData

Declares a filter in the web application. The filter is mapped to either a servlet or a URL pattern in the filter-mapping element, using the filter-name value as a reference. Filters can access the initialization parameters declared in the deployment descriptor at runtime via the FilterConfig interface.

The filter element can be used within the web-app element

Author:

Paul Reilly

See Also:

WebAppMetaData

Inner classes inherited from class jrunx.xml.XMLMetaData

XMLMetaData.BaseException, XMLMetaData.CouldNotCreateDocumentException, XMLMetaData.CreateInstanceException, XMLMetaData.ElementRequiredException, XMLMetaData.IntegerExpectedException, XMLMetaData.InvalidElementException, XMLMetaData.InvalidObjectException, XMLMetaData.MetaDataExportIOException, XMLMetaData.NoLocationException, XMLMetaData.NoStringConstructorException, XMLMetaData.UnsupportedArrayTypeException

Fields inherited from class jrunx.xml.XMLMetaData

logger

Constructor Summary

FilterMetaData()

Method Summary

void	addInitParam(InitParamMetaData initParam)
void	clearInitParams()
java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.lang.String	getFilterClass()
java.lang.String	getFilterName()
IconMetaData	getIcon()
java.util.Iterator	getInitParams()
InitParamMetaData	removeInitParam(int index)
void	setDescription(java.lang.String description)
void	setDisplayName(java.lang.String displayName)
void	setFilterClass(java.lang.String filterClass)
void	setFilterName(java.lang.String filterName)
void	setIcon(IconMetaData icon)
void	setInitParams(java.util.List initParams)

Methods inherited from class jrunx.xml.XMLMetaData

addAcronym, addAcronyms, addPackagePrefix, addPackagePrefixes, exportDocument, getAttribute, getMetaDataSource, getParent, getPersistenceContext, getText, importXML, importXML, remove, removeAttribute, setAttribute, setMetaDataSource, setMetaDataSource, setParent, setParent, setPersistenceContext, setPublicID, setSystemID, setText, sync, sync, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterMetaData

public FilterMetaData()

Method Detail

getIcon

public IconMetaData getIcon()

setIcon

public void setIcon(IconMetaData icon)

getFilterName

public java.lang.String getFilterName()

setFilterName

public void setFilterName(java.lang.String filterName)

getDisplayName

public java.lang.String getDisplayName()

setDisplayName

public void setDisplayName(java.lang.String displayName)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getFilterClass

public java.lang.String getFilterClass()

setFilterClass

public void setFilterClass(java.lang.String filterClass)

getInitParams

public java.util.Iterator getInitParams()

setInitParams

public void setInitParams(java.util.List initParams)

addInitParam

public void addInitParam(InitParamMetaData initParam)

removeInitParam

public InitParamMetaData removeInitParam(int index)

clearInitParams

public void clearInitParams()