org.apache.catalina.deploy

Class FilterMap

public class FilterMap extends 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: 504726 $ $Date: 2007-02-07 23:53:07 +0100 (Wed, 07 Feb 2007) $

Author: Craig R. McClanahan

Field Summary
static intERROR
The name of this filter to be executed when this mapping matches a particular request.
static intFORWARD
static intFORWARD_ERROR
static intINCLUDE
static intINCLUDE_ERROR
static intINCLUDE_ERROR_FORWARD
static intINCLUDE_FORWARD
static intREQUEST
static intREQUEST_ERROR
static intREQUEST_ERROR_FORWARD
static intREQUEST_ERROR_FORWARD_INCLUDE
static intREQUEST_ERROR_INCLUDE
static intREQUEST_FORWARD
static intREQUEST_FORWARD_INCLUDE
static intREQUEST_INCLUDE
Method Summary
voidaddServletName(String servletName)
voidaddURLPattern(String urlPattern)
intgetDispatcherMapping()
StringgetFilterName()
booleangetMatchAllServletNames()
booleangetMatchAllUrlPatterns()
String[]getServletNames()
String[]getURLPatterns()
voidsetDispatcher(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
voidsetFilterName(String filterName)
StringtoString()
Render a String representation of this object.

Field Detail

ERROR

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

FORWARD

public static final int FORWARD

FORWARD_ERROR

public static final int FORWARD_ERROR

INCLUDE

public static final int INCLUDE

INCLUDE_ERROR

public static final int INCLUDE_ERROR

INCLUDE_ERROR_FORWARD

public static final int INCLUDE_ERROR_FORWARD

INCLUDE_FORWARD

public static final int INCLUDE_FORWARD

REQUEST

public static final int REQUEST

REQUEST_ERROR

public static final int REQUEST_ERROR

REQUEST_ERROR_FORWARD

public static final int REQUEST_ERROR_FORWARD

REQUEST_ERROR_FORWARD_INCLUDE

public static final int REQUEST_ERROR_FORWARD_INCLUDE

REQUEST_ERROR_INCLUDE

public static final int REQUEST_ERROR_INCLUDE

REQUEST_FORWARD

public static final int REQUEST_FORWARD

REQUEST_FORWARD_INCLUDE

public static final int REQUEST_FORWARD_INCLUDE

REQUEST_INCLUDE

public static final int REQUEST_INCLUDE

Method Detail

addServletName

public void addServletName(String servletName)

addURLPattern

public void addURLPattern(String urlPattern)

getDispatcherMapping

public int getDispatcherMapping()

getFilterName

public String getFilterName()

getMatchAllServletNames

public boolean getMatchAllServletNames()

getMatchAllUrlPatterns

public boolean getMatchAllUrlPatterns()

getServletNames

public String[] getServletNames()

getURLPatterns

public String[] getURLPatterns()

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)

toString

public String toString()
Render a String representation of this object.
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.