Class FilterDetails.Builder

java.lang.Object
org.opendaylight.aaa.web.FilterDetails.Builder
Enclosing interface:
FilterDetails

public static final class FilterDetails.Builder extends Object
Builds instances of type FilterDetails. Initialize attributes and then invoke the build() method to create an immutable instance.

FilterDetails.Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

  • Method Details

    • filter

      public @NonNull FilterDetails.Builder filter(javax.servlet.Filter filter)
      Initializes the value for the filter attribute.
      Parameters:
      filter - The value for filter
      Returns:
      this builder for use in a chained invocation
    • name

      public @NonNull FilterDetails.Builder name(String name)
      Initializes the value for the name attribute.

      If not set, this attribute will have a value corresponding to filter().getClass().getName().

      Parameters:
      name - The value for name
      Returns:
      this builder for use in a chained invocation
      Throws:
      NullPointerException - if {code name} is null
    • addUrlPattern

      public @NonNull FilterDetails.Builder addUrlPattern(String urlPattern)
      Adds one element to urlPatterns list.
      Parameters:
      urlPattern - A urlPatterns element
      Returns:
      this builder for use in a chained invocation
      Throws:
      NullPointerException - if {code urlPattern} is null
      IllegalArgumentException - if urlPattern does not meet specification criteria
    • putInitParam

      public @NonNull FilterDetails.Builder putInitParam(String key, String value)
      Put one entry to the initParams map.
      Parameters:
      key - The key in the initParams map
      value - The associated value in the initParams map
      Returns:
      this builder for use in a chained invocation
      Throws:
      NullPointerException - if any argument is null
    • asyncSupported

      public @NonNull FilterDetails.Builder asyncSupported(boolean asyncSupported)
      Initializes the value for the asyncSupported attribute.

      If not set, this attribute will have a default value of false.

      Parameters:
      asyncSupported - The value for asyncSupported
      Returns:
      this builder for use in a chained invocation
    • build

      public @NonNull FilterDetails build()
      Builds a new FilterDetails.
      Returns:
      An immutable instance of FilterDetails
      Throws:
      IllegalStateException - if any required attributes are missing