Top Description Fields Constructors Methods
org.apache.tomcat.util.descriptor.web

public Class FilterDef

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, java.util.HashMap, .Map, jakarta.servlet.Filter, org.apache.tomcat.util.res.StringManager

Representation of a filter definition for a web application, as represented in a <filter> element in the deployment descriptor.
Author
Craig R. McClanahan

Field Summary

Modifier and TypeField and Description
private String
private String
description

The description of this filter.

private String
displayName

The display name of this filter.

private transient Filter
filter

The filter instance associated with this definition

private String
filterClass

The fully qualified name of the Java class that implements this filter.

private String
filterName

The name of this filter, which must be unique among the filters defined for a particular web application.

private String
largeIcon

The large icon associated with this filter.

private final Map<String, String>
parameters

The set of initialization parameters for this filter, keyed by parameter name.

private static final long
private static final StringManager
private String
smallIcon

The small icon associated with this filter.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
addInitParameter(String
The initialization parameter name
name
,
String
The initialization parameter value
value
)

Add an initialization parameter to the set of parameters associated with this filter.

public String
public String
public String
public Filter
public String
public String
public String
public Map<String, String>
public String
public void
setAsyncSupported(String asyncSupported)

public void
setDescription(String description)

public void
setDisplayName(String displayName)

public void
setFilter(Filter filter)

public void
setFilterClass(String filterClass)

public void
setFilterName(String filterName)

public void
setLargeIcon(String largeIcon)

public void
setSmallIcon(String smallIcon)

public String
toString()

Overrides java.lang.Object.toString.

Render a String representation of this object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

asyncSupportedback to summary
private String asyncSupported
descriptionback to summary
private String description

The description of this filter.

displayNameback to summary
private String displayName

The display name of this filter.

filterback to summary
private transient Filter filter

The filter instance associated with this definition

filterClassback to summary
private String filterClass

The fully qualified name of the Java class that implements this filter.

filterNameback to summary
private String filterName

The name of this filter, which must be unique among the filters defined for a particular web application.

largeIconback to summary
private String largeIcon

The large icon associated with this filter.

parametersback to summary
private final Map<String, String> parameters

The set of initialization parameters for this filter, keyed by parameter name.

serialVersionUIDback to summary
private static final long serialVersionUID
smback to summary
private static final StringManager sm
smallIconback to summary
private String smallIcon

The small icon associated with this filter.

Constructor Detail

FilterDefback to summary
public FilterDef()

Method Detail

addInitParameterback to summary
public void addInitParameter(String name, String value)

Add an initialization parameter to the set of parameters associated with this filter.

Parameters
name:String

The initialization parameter name

value:String

The initialization parameter value

getAsyncSupportedback to summary
public String getAsyncSupported()
getDescriptionback to summary
public String getDescription()
getDisplayNameback to summary
public String getDisplayName()
getFilterback to summary
public Filter getFilter()
getFilterClassback to summary
public String getFilterClass()
getFilterNameback to summary
public String getFilterName()
getLargeIconback to summary
public String getLargeIcon()
getParameterMapback to summary
public Map<String, String> getParameterMap()
getSmallIconback to summary
public String getSmallIcon()
setAsyncSupportedback to summary
public void setAsyncSupported(String asyncSupported)
setDescriptionback to summary
public void setDescription(String description)
setDisplayNameback to summary
public void setDisplayName(String displayName)
setFilterback to summary
public void setFilter(Filter filter)
setFilterClassback to summary
public void setFilterClass(String filterClass)
setFilterNameback to summary
public void setFilterName(String filterName)
setLargeIconback to summary
public void setLargeIcon(String largeIcon)
setSmallIconback to summary
public void setSmallIcon(String smallIcon)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Render a String representation of this object.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override