com.sun.grizzly.http.webxml.schema.version_3_0
Class FilterType

java.lang.Object
  extended by com.sun.grizzly.http.webxml.schema.version_3_0.FilterType

public class FilterType
extends Object

The filterType is used to declare a filter in the web application. The filter is mapped to either a servlet or a URL pattern in the filter-mapping element, using the filter-name value to reference. Filters can access the initialization parameters declared in the deployment descriptor at runtime via the FilterConfig interface. Used in: web-app

Java class for filterType complex type.

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

 <complexType name="filterType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
         <element name="filter-name" type="{http://java.sun.com/xml/ns/javaee}filter-nameType"/>
         <element name="filter-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"/>
         <element name="async-supported" type="{http://java.sun.com/xml/ns/javaee}true-falseType" minOccurs="0"/>
         <element name="async-timeout" type="{http://java.sun.com/xml/ns/javaee}xsdIntegerType" minOccurs="0"/>
         <element name="init-param" type="{http://java.sun.com/xml/ns/javaee}param-valueType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  TrueFalseType asyncSupported
           
protected  XsdIntegerType asyncTimeout
           
protected  List<DescriptionType> description
           
protected  List<DisplayNameType> displayName
           
protected  FullyQualifiedClassType filterClass
           
protected  FilterNameType filterName
           
protected  List<IconType> icon
           
protected  String id
           
protected  List<ParamValueType> initParam
           
 
Constructor Summary
FilterType()
           
 
Method Summary
 TrueFalseType getAsyncSupported()
          Gets the value of the asyncSupported property.
 XsdIntegerType getAsyncTimeout()
          Gets the value of the asyncTimeout property.
 List<DescriptionType> getDescription()
          Gets the value of the description property.
 List<DisplayNameType> getDisplayName()
          Gets the value of the displayName property.
 FullyQualifiedClassType getFilterClass()
          Gets the value of the filterClass property.
 FilterNameType getFilterName()
          Gets the value of the filterName property.
 List<IconType> getIcon()
          Gets the value of the icon property.
 String getId()
          Gets the value of the id property.
 List<ParamValueType> getInitParam()
          Gets the value of the initParam property.
 void setAsyncSupported(TrueFalseType value)
          Sets the value of the asyncSupported property.
 void setAsyncTimeout(XsdIntegerType value)
          Sets the value of the asyncTimeout property.
 void setFilterClass(FullyQualifiedClassType value)
          Sets the value of the filterClass property.
 void setFilterName(FilterNameType value)
          Sets the value of the filterName property.
 void setId(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

description

protected List<DescriptionType> description

displayName

protected List<DisplayNameType> displayName

icon

protected List<IconType> icon

filterName

protected FilterNameType filterName

filterClass

protected FullyQualifiedClassType filterClass

asyncSupported

protected TrueFalseType asyncSupported

asyncTimeout

protected XsdIntegerType asyncTimeout

initParam

protected List<ParamValueType> initParam

id

protected String id
Constructor Detail

FilterType

public FilterType()
Method Detail

getDescription

public List<DescriptionType> getDescription()
Gets the value of the description 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 description property.

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

    getDescription().add(newItem);
 

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


getDisplayName

public List<DisplayNameType> getDisplayName()
Gets the value of the displayName 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 displayName property.

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

    getDisplayName().add(newItem);
 

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


getIcon

public List<IconType> getIcon()
Gets the value of the icon 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 icon property.

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

    getIcon().add(newItem);
 

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


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

getFilterClass

public FullyQualifiedClassType getFilterClass()
Gets the value of the filterClass property.

Returns:
possible object is FullyQualifiedClassType

setFilterClass

public void setFilterClass(FullyQualifiedClassType value)
Sets the value of the filterClass property.

Parameters:
value - allowed object is FullyQualifiedClassType

getAsyncSupported

public TrueFalseType getAsyncSupported()
Gets the value of the asyncSupported property.

Returns:
possible object is TrueFalseType

setAsyncSupported

public void setAsyncSupported(TrueFalseType value)
Sets the value of the asyncSupported property.

Parameters:
value - allowed object is TrueFalseType

getAsyncTimeout

public XsdIntegerType getAsyncTimeout()
Gets the value of the asyncTimeout property.

Returns:
possible object is XsdIntegerType

setAsyncTimeout

public void setAsyncTimeout(XsdIntegerType value)
Sets the value of the asyncTimeout property.

Parameters:
value - allowed object is XsdIntegerType

getInitParam

public List<ParamValueType> getInitParam()
Gets the value of the initParam 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 initParam property.

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

    getInitParam().add(newItem);
 

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


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


Copyright © 2012 Oracle Corporation. All Rights Reserved.