Class CmsRepositoryFilter

java.lang.Object
org.opencms.repository.CmsRepositoryFilter

public class CmsRepositoryFilter extends Object
This class is a filter for the repositories.

It filters path names, depending on the configuration made.

Since:
6.2.4
  • Constructor Details

    • CmsRepositoryFilter

      Default constructor initializing member variables.
  • Method Details

    • addFilterRule

      public void addFilterRule(String rule)
      Adds a new filter rule (regex) to the filter.

      Parameters:
      rule - the rule (regex) to add
    • getFilterRules

      Returns the filterRules.

      Returns:
      the filterRules
    • getType

      public String getType()
      Returns the type.

      Returns:
      the type
    • initConfiguration

      Initializes a configuration after all parameters have been added.

      Throws:
      CmsConfigurationException - if something goes wrong
    • isFiltered

      public boolean isFiltered(String path)
      Checks if a path is filtered out of the filter or not.

      Parameters:
      path - the path of a resource to check
      Returns:
      true if the name matches one of the given filter patterns
    • setFilterRules

      public void setFilterRules(List<Pattern> filterRules)
      Sets the filterRules.

      Parameters:
      filterRules - the filterRules to set
    • setType

      public void setType(String type)
      Sets the type.

      Parameters:
      type - the type to set