net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee
Class FilterMappingType

java.lang.Object
  extended by net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterMappingType
All Implemented Interfaces:
Serializable, Cloneable

public class FilterMappingType
extends Object
implements Serializable, Cloneable

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>
 

See Also:
Serialized Form

Field Summary
protected  DispatcherType[] dispatcher
           
protected  FilterNameType filterName
           
protected  String id
           
protected  Object[] urlPatternOrServletName
           
 
Constructor Summary
FilterMappingType()
          Creates a new net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterMappingType instance.
FilterMappingType(FilterMappingType o)
          Creates a new net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterMappingType instance by copying a given instance.
 
Method Summary
 FilterMappingType clone()
          Creates and returns a copy of this object.
 DispatcherType[] getDispatcher()
           
 DispatcherType getDispatcher(int idx)
           
 int getDispatcherLength()
           
 FilterNameType getFilterName()
          Gets the value of the filterName property.
 String getId()
          Gets the value of the id property.
 Object[] getUrlPatternOrServletName()
           
 Object getUrlPatternOrServletName(int idx)
           
 int getUrlPatternOrServletNameLength()
           
 void setDispatcher(DispatcherType[] values)
           
 DispatcherType setDispatcher(int idx, DispatcherType value)
           
 void setFilterName(FilterNameType value)
          Sets the value of the filterName property.
 void setId(String value)
          Sets the value of the id property.
 Object setUrlPatternOrServletName(int idx, Object value)
           
 void setUrlPatternOrServletName(Object[] values)
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

filterName

protected FilterNameType filterName

urlPatternOrServletName

protected Object[] urlPatternOrServletName

dispatcher

protected DispatcherType[] dispatcher

id

protected String id
Constructor Detail

FilterMappingType

public FilterMappingType()
Creates a new net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterMappingType instance.


FilterMappingType

public FilterMappingType(FilterMappingType o)
Creates a new net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterMappingType instance by copying a given instance.

Parameters:
o - The instance to copy or null.
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 Object[] getUrlPatternOrServletName()
Returns:
array of UrlPatternType ServletNameType

getUrlPatternOrServletName

public Object getUrlPatternOrServletName(int idx)
Returns:
one of UrlPatternType ServletNameType

getUrlPatternOrServletNameLength

public int getUrlPatternOrServletNameLength()

setUrlPatternOrServletName

public void setUrlPatternOrServletName(Object[] values)
Parameters:
values - allowed objects are UrlPatternType ServletNameType

setUrlPatternOrServletName

public Object setUrlPatternOrServletName(int idx,
                                         Object value)
Parameters:
value - allowed object is UrlPatternType ServletNameType

getDispatcher

public DispatcherType[] getDispatcher()
Returns:
array of DispatcherType

getDispatcher

public DispatcherType getDispatcher(int idx)
Returns:
one of DispatcherType

getDispatcherLength

public int getDispatcherLength()

setDispatcher

public void setDispatcher(DispatcherType[] values)
Parameters:
values - allowed objects are DispatcherType

setDispatcher

public DispatcherType setDispatcher(int idx,
                                    DispatcherType value)
Parameters:
value - allowed object is DispatcherType

getId

public String getId()
Gets the value of the id property.

Returns:
possible object is String

setId

public void setId(String value)
Sets the value of the id property.

Parameters:
value - allowed object is String

clone

public FilterMappingType clone()
Creates and returns a copy of this object.

Overrides:
clone in class Object
Returns:
A clone of this instance.


Copyright © 2009 The CC-XJC Community. All Rights Reserved.