Package org.apache.tomcat.util.descriptor.web

Class FilterDef

  • All Implemented Interfaces:
    java.io.Serializable
    public class FilterDef
extends java.lang.Object
implements java.io.Serializable
    Representation of a filter definition for a web application, as represented in a <filter> element in the deployment descriptor.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      FilterDef()
      Default constructor for FilterDef.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addInitParameter​(java.lang.String name, java.lang.String value)
      Add an initialization parameter to the set of parameters associated with this filter.
      java.lang.String getAsyncSupported()
      Returns the async-supported setting for this filter.
      boolean getAsyncSupportedBoolean()
      Returns whether async processing is supported for this filter.
      java.lang.String getDescription()
      Returns the description of this filter.
      java.lang.String getDisplayName()
      Returns the display name of this filter.
      Filter getFilter()
      Returns the filter instance associated with this definition.
      java.lang.String getFilterClass()
      Returns the fully qualified name of the Java class that implements this filter.
      java.lang.String getFilterName()
      Returns the name of this filter.
      java.lang.String getLargeIcon()
      Returns the large icon associated with this filter.
      java.util.Map<java.lang.String,​java.lang.String> getParameterMap()
      Returns the set of initialization parameters for this filter, keyed by parameter name.
      java.lang.String getSmallIcon()
      Returns the small icon associated with this filter.
      void setAsyncSupported​(java.lang.String asyncSupported)
      Sets the async-supported setting for this filter.
      void setDescription​(java.lang.String description)
      Sets the description of this filter.
      void setDisplayName​(java.lang.String displayName)
      Sets the display name of this filter.
      void setFilter​(Filter filter)
      Sets the filter instance associated with this definition.
      void setFilterClass​(java.lang.String filterClass)
      Sets the fully qualified name of the Java class that implements this filter.
      void setFilterName​(java.lang.String filterName)
      Sets the name of this filter, which must be unique among the filters defined for a particular web application.
      void setLargeIcon​(java.lang.String largeIcon)
      Sets the large icon associated with this filter.
      void setSmallIcon​(java.lang.String smallIcon)
      Sets the small icon associated with this filter.
      java.lang.String toString()
      Render a String representation of this object.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FilterDef

        public FilterDef()
        Default constructor for FilterDef.

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Returns the description of this filter.
        Returns:
        The description

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the description of this filter.
        Parameters:
        description - The new description

      • getDisplayName

        public java.lang.String getDisplayName()
        Returns the display name of this filter.
        Returns:
        The display name

      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        Sets the display name of this filter.
        Parameters:
        displayName - The new display name

      • getFilter

        public Filter getFilter()
        Returns the filter instance associated with this definition.
        Returns:
        The filter instance

      • setFilter

        public void setFilter​(Filter filter)
        Sets the filter instance associated with this definition.
        Parameters:
        filter - The filter instance

      • getFilterClass

        public java.lang.String getFilterClass()
        Returns the fully qualified name of the Java class that implements this filter.
        Returns:
        The filter class name

      • setFilterClass

        public void setFilterClass​(java.lang.String filterClass)
        Sets the fully qualified name of the Java class that implements this filter.
        Parameters:
        filterClass - The filter class name

      • getFilterName

        public java.lang.String getFilterName()
        Returns the name of this filter.
        Returns:
        The filter name

      • setFilterName

        public void setFilterName​(java.lang.String filterName)
        Sets the name of this filter, which must be unique among the filters defined for a particular web application.
        Parameters:
        filterName - The new filter name

      • getLargeIcon

        public java.lang.String getLargeIcon()
        Returns the large icon associated with this filter.
        Returns:
        The large icon

      • setLargeIcon

        public void setLargeIcon​(java.lang.String largeIcon)
        Sets the large icon associated with this filter.
        Parameters:
        largeIcon - The new large icon

      • getParameterMap

        public java.util.Map<java.lang.String,​java.lang.String> getParameterMap()
        Returns the set of initialization parameters for this filter, keyed by parameter name.
        Returns:
        The initialization parameter map

      • getSmallIcon

        public java.lang.String getSmallIcon()
        Returns the small icon associated with this filter.
        Returns:
        The small icon

      • setSmallIcon

        public void setSmallIcon​(java.lang.String smallIcon)
        Sets the small icon associated with this filter.
        Parameters:
        smallIcon - The new small icon

      • getAsyncSupported

        public java.lang.String getAsyncSupported()
        Returns the async-supported setting for this filter.
        Returns:
        The async-supported value

      • setAsyncSupported

        public void setAsyncSupported​(java.lang.String asyncSupported)
        Sets the async-supported setting for this filter.
        Parameters:
        asyncSupported - The async-supported value

      • getAsyncSupportedBoolean

        public boolean getAsyncSupportedBoolean()
        Returns whether async processing is supported for this filter.
        Returns:
        True if async is supported, false otherwise

      • addInitParameter

        public void addInitParameter​(java.lang.String name,
                             java.lang.String value)
        Add an initialization parameter to the set of parameters associated with this filter.
        Parameters:
        name - The initialization parameter name
        value - The initialization parameter value

      • toString

        public java.lang.String toString()
        Render a String representation of this object.
        Overrides:
        toString in class java.lang.Object