com.crossingchannels.portal.websphere.specification.jee5.dom

Class FilterMappingType

java.lang.Object

com.crossingchannels.portal.websphere.specification.jee5.dom.FilterMappingType

public class FilterMappingType
extends java.lang.Object

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.

Java class for filter-mappingType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="filter-mappingType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="filter-name" type="{http://java.sun.com/xml/ns/javaee}filter-nameType"/>
         <choice maxOccurs="unbounded">
           <element name="url-pattern" type="{http://java.sun.com/xml/ns/javaee}url-patternType"/>
           <element name="servlet-name" type="{http://java.sun.com/xml/ns/javaee}servlet-nameType"/>
         </choice>
         <element name="dispatcher" type="{http://java.sun.com/xml/ns/javaee}dispatcherType" maxOccurs="4" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<DispatcherType>	dispatcher
protected FilterNameType	filterName
protected java.lang.String	id
protected java.util.List<java.lang.Object>	urlPatternOrServletName

Constructor Summary

Constructors

Constructor and Description
FilterMappingType()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<DispatcherType>	getDispatcher() Gets the value of the dispatcher property.
FilterNameType	getFilterName() Gets the value of the filterName property.
java.lang.String	getId() Gets the value of the id property.
java.util.List<java.lang.Object>	getUrlPatternOrServletName() Gets the value of the urlPatternOrServletName property.
void	setFilterName(FilterNameType value) Sets the value of the filterName property.
void	setId(java.lang.String value) Sets the value of the id property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

filterName

protected FilterNameType filterName

urlPatternOrServletName

protected java.util.List<java.lang.Object> urlPatternOrServletName

dispatcher

protected java.util.List<DispatcherType> dispatcher

id

protected java.lang.String id

Constructor Detail

FilterMappingType

public FilterMappingType()

Method Detail

getFilterName

public FilterNameType getFilterName()

Gets the value of the filterName property.

Returns:

possible object is FilterNameType

setFilterName

public void setFilterName(FilterNameType value)

Sets the value of the filterName property.

Parameters:

value - allowed object is FilterNameType

getUrlPatternOrServletName

public java.util.List<java.lang.Object> getUrlPatternOrServletName()

Gets the value of the urlPatternOrServletName property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the urlPatternOrServletName property.

For example, to add a new item, do as follows:

    getUrlPatternOrServletName().add(newItem);
 

Objects of the following type(s) are allowed in the list UrlPatternType ServletNameType

getDispatcher

public java.util.List<DispatcherType> getDispatcher()

Gets the value of the dispatcher property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the dispatcher property.

For example, to add a new item, do as follows:

    getDispatcher().add(newItem);
 

Objects of the following type(s) are allowed in the list DispatcherType

getId

public java.lang.String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(java.lang.String value)

Sets the value of the id property.

Parameters:

value - allowed object is String