org.apache.catalina.deploy

Class FilterMap

Implemented Interfaces:
Serializable

public class FilterMap
extends java.lang.Object
implements Serializable

Representation of a filter mapping for a web application, as represented in a <filter-mapping> element in the deployment descriptor. Each filter mapping must contain a filter name plus either a URL pattern or a servlet name.

Version:
$Revision: 1.7 $ $Date: 2004/05/13 20:40:49 $

Author:
Craig R. McClanahan

Field Summary

static int
ERROR
The name of this filter to be executed when this mapping matches a particular request.
static int
FORWARD
static int
FORWARD_ERROR
static int
INCLUDE
static int
INCLUDE_ERROR
static int
INCLUDE_ERROR_FORWARD
static int
INCLUDE_FORWARD
static int
REQUEST
static int
REQUEST_ERROR
static int
REQUEST_ERROR_FORWARD
static int
REQUEST_ERROR_FORWARD_INCLUDE
static int
REQUEST_ERROR_INCLUDE
static int
REQUEST_FORWARD
static int
REQUEST_FORWARD_INCLUDE
static int
REQUEST_INCLUDE

Method Summary

int
getDispatcherMapping()
String
getFilterName()
String
getServletName()
String
getURLPattern()
void
setDispatcher(String dispatcherString)
This method will be used to set the current state of the FilterMap representing the state of when filters should be applied: ERROR FORWARD FORWARD_ERROR INCLUDE INCLUDE_ERROR INCLUDE_ERROR_FORWARD REQUEST REQUEST_ERROR REQUEST_ERROR_INCLUDE REQUEST_ERROR_FORWARD_INCLUDE REQUEST_INCLUDE REQUEST_FORWARD, REQUEST_FORWARD_INCLUDE
void
setFilterName(String filterName)
void
setServletName(String servletName)
void
setURLPattern(String urlPattern)
String
toString()
Render a String representation of this object.

Field Details

ERROR

public static final int ERROR
The name of this filter to be executed when this mapping matches a particular request.

Field Value:
1


FORWARD

public static final int FORWARD

Field Value:
2


FORWARD_ERROR

public static final int FORWARD_ERROR

Field Value:
3


INCLUDE

public static final int INCLUDE

Field Value:
4


INCLUDE_ERROR

public static final int INCLUDE_ERROR

Field Value:
5


INCLUDE_ERROR_FORWARD

public static final int INCLUDE_ERROR_FORWARD

Field Value:
6


INCLUDE_FORWARD

public static final int INCLUDE_FORWARD

Field Value:
7


REQUEST

public static final int REQUEST

Field Value:
8


REQUEST_ERROR

public static final int REQUEST_ERROR

Field Value:
9


REQUEST_ERROR_FORWARD

public static final int REQUEST_ERROR_FORWARD

Field Value:
10


REQUEST_ERROR_FORWARD_INCLUDE

public static final int REQUEST_ERROR_FORWARD_INCLUDE

Field Value:
11


REQUEST_ERROR_INCLUDE

public static final int REQUEST_ERROR_INCLUDE

Field Value:
12


REQUEST_FORWARD

public static final int REQUEST_FORWARD

Field Value:
13


REQUEST_FORWARD_INCLUDE

public static final int REQUEST_FORWARD_INCLUDE

Field Value:
15


REQUEST_INCLUDE

public static final int REQUEST_INCLUDE

Field Value:
14

Method Details

getDispatcherMapping

public int getDispatcherMapping()


getFilterName

public String getFilterName()


getServletName

public String getServletName()


getURLPattern

public String getURLPattern()


setDispatcher

public void setDispatcher(String dispatcherString)
This method will be used to set the current state of the FilterMap representing the state of when filters should be applied: ERROR FORWARD FORWARD_ERROR INCLUDE INCLUDE_ERROR INCLUDE_ERROR_FORWARD REQUEST REQUEST_ERROR REQUEST_ERROR_INCLUDE REQUEST_ERROR_FORWARD_INCLUDE REQUEST_INCLUDE REQUEST_FORWARD, REQUEST_FORWARD_INCLUDE


setFilterName

public void setFilterName(String filterName)


setServletName

public void setServletName(String servletName)


setURLPattern

public void setURLPattern(String urlPattern)


toString

public String toString()
Render a String representation of this object.


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.