Package icu.easyj.web.filter

Interface IFilterProperties

All Known Subinterfaces:
IParamCryptoFilterProperties
All Known Implementing Classes:
BaseFilterProperties, DefaultParamCryptoFilterPropertiesImpl
public interface IFilterProperties
过滤器配置基类
Author:
wangliang181230

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getExclusions()
    获取无需拦截的Url地址匹配列表
    Integer
    getOrder()
    获取过滤器执行顺序
    List<String>
    getUrlPatterns()
    获取需拦截的Url地址匹配列表
    default boolean
    isDisabled()
    过滤器使用状态
    用于判断该过滤器是否禁用，该状态在服务运行期间，可动态变更
    default boolean
    isEnabled()
    过滤器启用状态
    用于判断该过滤器是否启用，该状态一旦服务启动，就无法动态变更。
    void
    setDisabled(boolean disabled)
    设置过滤器使用状态
    void
    setEnabled(boolean enabled)
    设置过滤器启用状态
    void
    setExclusions(List<String> exclusions)
    设置无需拦截的Url地址匹配列表
    void
    setOrder(int order)
    设置执行顺序
    void
    setUrlPatterns(List<String> urlPatterns)
    设置需拦截的Url地址匹配列表

  • Method Details

    • isEnabled

      default boolean isEnabled()
      过滤器启用状态
      用于判断该过滤器是否启用，该状态一旦服务启动，就无法动态变更。
      Returns:
      过滤器启用状态

    • setEnabled

      void setEnabled(boolean enabled)
      设置过滤器启用状态
      Parameters:
      enabled - 启用状态

    • isDisabled

      default boolean isDisabled()
      过滤器使用状态
      用于判断该过滤器是否禁用，该状态在服务运行期间，可动态变更
      Returns:
      过滤器使用状态，true=禁用|false=启用(默认)

    • setDisabled

      void setDisabled(boolean disabled)
      设置过滤器使用状态
      Parameters:
      disabled - 使用状态

    • getOrder

      Integer getOrder()
      获取过滤器执行顺序
      Returns:
      过滤器执行顺序

    • setOrder

      void setOrder(int order)
      设置执行顺序
      Parameters:
      order - 执行顺序

    • getUrlPatterns

      List<String> getUrlPatterns()
      获取需拦截的Url地址匹配列表
      Returns:
      需拦截的Url地址匹配列表

    • setUrlPatterns

      void setUrlPatterns(List<String> urlPatterns)
      设置需拦截的Url地址匹配列表
      Parameters:
      urlPatterns - 需拦截的Url地址匹配列表

    • getExclusions

      List<String> getExclusions()
      获取无需拦截的Url地址匹配列表
      Returns:
      无需拦截的Url地址匹配列表

    • setExclusions

      void setExclusions(List<String> exclusions)
      设置无需拦截的Url地址匹配列表
      Parameters:
      exclusions - 无需拦截的Url地址匹配列表