Package org.opendaylight.aaa.web

Interface FilterDetails

public interface FilterDetails
Details about a Filter.
Author:
Michael Vorburger.ch

  • Method Details

    • filter

      @NonNull javax.servlet.Filter filter()
      Get a Filter instance.
      Returns:
      Filter instance

    • name

      @NonNull String name()
      Get Filter's name.
      Returns:
      String

    • urlPatterns

      @NonNull List<String> urlPatterns()
      Get list of Filter URL patterns. These patterns control where filter is applied.

      Restrictions to URLs and how it should look like are next:

      • A string beginning with a ‘ / ’ character and ending with a ‘ /*’ suffix is used for path mapping.
      • A string beginning with a ‘ *. ’ prefix is used as an extension mapping.
      • The empty string ("") is a special URL pattern that exactly maps to the application's context root, i.e., requests of the form http://host:port/context-root/. In this case the path info is ’ / ’ and the servlet path and context path is empty string (““).
      • A string containing only the ’ / ’ character indicates the "default" servlet of the application. In this case the servlet path is the request URI minus the context path and the path info is null.
      • All other strings are used for exact matches only.
      Returns:
      List of Filter URL patterns
      See Also:
      • "Java Servlet Specification Version 3.1, Section 12.2 Specification of Mappings"

    • initParams

      @NonNull Map<String,String> initParams()
      Get Filter initial parameters.
      Returns:
      Map that contains initial parameters

    • asyncSupported

      boolean asyncSupported()
      Get indication whether filter() supports asynchronous processing.
      Returns:
      true if the filter supports asynchronous processing
      See Also:
      • "Java Servlet Specification Version 3.1, Section 2.3.3.3 Asynchronous Processing"

    • builder

      static @NonNull FilterDetails.Builder builder()
      Create a builder for FilterDetails.
      Returns:
      FilterDetails.Builder builder instance