org.eclipse.jst.j2ee.webapplication
Interface FilterMapping

All Superinterfaces:
J2EEEObject

public interface FilterMapping
extends J2EEEObject

Declaration of the filter mappings in this web application. The container uses the filter-mapping declarations to decide which filters to apply to a request, and in what order. The container matches the request URI to a Servlet in the normal way. To determine which filters to apply it matches filter-mapping declarations either on servlet-name, or on url-pattern for each filter-mapping element, depending on which style is used. The order in which filters are invoked is the order in which filter-mapping declarations that match a request URI for a servlet appear in the list of filter-mapping elements.The filter-name value must be the value of the sub-elements of one of the declarations in the deployment descriptor.


Method Summary
 EList getDispatcherType()
          Returns the value of the 'Dispatcher Type' attribute list.
 Filter getFilter()
           
 Servlet getServlet()
           
 java.lang.String getServletName()
          Returns the name of the servlet that this mapping applies to.
 java.lang.String getUrlPattern()
           
 void setFilter(Filter value)
           
 void setServlet(Servlet value)
           
 void setServletName(java.lang.String servletName)
          Sets the name of the servlet that this mapping applies to.
 void setUrlPattern(java.lang.String value)
           
 

Method Detail

getServletName

public java.lang.String getServletName()
Returns the name of the servlet that this mapping applies to.


setServletName

public void setServletName(java.lang.String servletName)
Sets the name of the servlet that this mapping applies to.


getUrlPattern

public java.lang.String getUrlPattern()
Returns:
The value of the UrlPattern attribute The url-pattern element contains the url pattern of the mapping. Must follow the rules specified in Section 10 of the Servlet API Specification.

setUrlPattern

public void setUrlPattern(java.lang.String value)
Parameters:
value - The new value of the UrlPattern attribute

getDispatcherType

public EList getDispatcherType()
Returns the value of the 'Dispatcher Type' attribute list. The list contents are of type DispatcherType. The literals are from the enumeration DispatcherType.

If the meaning of the 'Dispatcher Type' attribute list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Dispatcher Type' attribute list.
See Also:
DispatcherType, WebapplicationPackage.getFilterMapping_DispatcherType()

getFilter

public Filter getFilter()
Returns:
The Filter reference The filter being mapped

setFilter

public void setFilter(Filter value)

getServlet

public Servlet getServlet()
Returns:
The Servlet reference An optional servlet that is mapped by a filter mapping. servletName is used to resolve the servlet reference.

setServlet

public void setServlet(Servlet value)