org.eclipse.modisco.jee.webapp.webapp24
Interface FilterMappingType


public interface FilterMappingType

A representation of the model object 'Filter Mapping Type'. Declaration of the filter mappings in this web application is done by using filter-mappingType. 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 filter-name sub-elements of one of the filter declarations in the deployment descriptor.

The following features are supported:

See Also:
Webapp24Package.getFilterMappingType()
Generated:
Model:
extendedMetaData="name='filter-mappingType' kind='elementOnly'"

Method Summary
  getDispatcher()
          Returns the value of the 'Dispatcher' containment reference list.
 FilterNameType getFilterName()
          Returns the value of the 'Filter Name' containment reference.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
 ServletNameType getServletName()
          Returns the value of the 'Servlet Name' containment reference.
 UrlPatternType getUrlPattern()
          Returns the value of the 'Url Pattern' containment reference.
 void setFilterName(FilterNameType value)
          Sets the value of the 'Filter Name' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setServletName(ServletNameType value)
          Sets the value of the 'Servlet Name' containment reference.
 void setUrlPattern(UrlPatternType value)
          Sets the value of the 'Url Pattern' containment reference.
 

Method Detail

getFilterName

FilterNameType getFilterName()
Returns the value of the 'Filter Name' containment reference.

If the meaning of the 'Filter Name' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Filter Name' containment reference.
See Also:
setFilterName(FilterNameType), Webapp24Package.getFilterMappingType_FilterName()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='filter-name' namespace='http://java.sun.com/xml/ns/j2ee'"

setFilterName

void setFilterName(FilterNameType value)
Sets the value of the 'Filter Name' containment reference.

Parameters:
value - the new value of the 'Filter Name' containment reference.
See Also:
getFilterName()
Generated:

getUrlPattern

UrlPatternType getUrlPattern()
Returns the value of the 'Url Pattern' containment reference.

If the meaning of the 'Url Pattern' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Url Pattern' containment reference.
See Also:
setUrlPattern(UrlPatternType), Webapp24Package.getFilterMappingType_UrlPattern()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='url-pattern' namespace='http://java.sun.com/xml/ns/j2ee'"

setUrlPattern

void setUrlPattern(UrlPatternType value)
Sets the value of the 'Url Pattern' containment reference.

Parameters:
value - the new value of the 'Url Pattern' containment reference.
See Also:
getUrlPattern()
Generated:

getServletName

ServletNameType getServletName()
Returns the value of the 'Servlet Name' containment reference.

If the meaning of the 'Servlet Name' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Servlet Name' containment reference.
See Also:
setServletName(ServletNameType), Webapp24Package.getFilterMappingType_ServletName()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='servlet-name' namespace='http://java.sun.com/xml/ns/j2ee'"

setServletName

void setServletName(ServletNameType value)
Sets the value of the 'Servlet Name' containment reference.

Parameters:
value - the new value of the 'Servlet Name' containment reference.
See Also:
getServletName()
Generated:

getDispatcher

 getDispatcher()
Returns the value of the 'Dispatcher' containment reference list. The list contents are of type DispatcherType.

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

Returns:
the value of the 'Dispatcher' containment reference list.
See Also:
Webapp24Package.getFilterMappingType_Dispatcher()
Generated:
Model:
containment="true" upper="4" extendedMetaData="kind='element' name='dispatcher' namespace='http://java.sun.com/xml/ns/j2ee'"

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

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

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), Webapp24Package.getFilterMappingType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: