Enum Class DomainFilterPolicy

java.lang.Object
java.lang.Enum<DomainFilterPolicy>
tigase.vhosts.filter.DomainFilterPolicy
All Implemented Interfaces:
Serializable, Comparable<DomainFilterPolicy>, Constable

public enum DomainFilterPolicy extends Enum<DomainFilterPolicy>
Enumeration of all possible filtering modes
  • Enum Constant Details

    • ALL

      public static final DomainFilterPolicy ALL
      user can communicate with anyone
    • LOCAL

      public static final DomainFilterPolicy LOCAL
      user can communicate with other local users (i.e. of the domains hosted on the same Tigase instance)
    • OWN

      public static final DomainFilterPolicy OWN
      user can communicate with other users of the same domain
    • LIST

      public static final DomainFilterPolicy LIST
      user can communicate with users of the domains within listen domains
    • BLACKLIST

      public static final DomainFilterPolicy BLACKLIST
      user can communicate with anyone except of the users within listed domains
    • CUSTOM

      public static final DomainFilterPolicy CUSTOM
      Custom rules defining communication policies in CSV (using semicolon) in the format of rule_number;(allow|deny);[type_of_value];[value] where type_of_value::(jid)
       1|allow|self;
       2|allow|jid|admin@test2.com;
       3|allow|jid|pubsub@test.com;
       4|deny|all;
       
    • BLOCK

      public static final DomainFilterPolicy BLOCK
      user can not communicate with anyone, account virtually disabled
  • Method Details

    • values

      public static DomainFilterPolicy[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static DomainFilterPolicy valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • valuePoliciesWithDomainListStr

      public static HashSet<String> valuePoliciesWithDomainListStr()
    • valueof

      public static DomainFilterPolicy valueof(String domainFilteringPolicy)
      Helper method returning proper defaults in case parsed value doesn't correspond to any of the available modes.
      Parameters:
      domainFilteringPolicy - policy name as string
      Returns:
      enum value of corresponding mode, ALL if value doesn't match any mode or null for null parameter.
    • valuesStr

      public static String[] valuesStr()
      Helper method to generate string array with mode values
      Returns:
      String array with mode values
    • isDomainListRequired

      public boolean isDomainListRequired()