Interface IPFilter

All Known Implementing Classes:
IPFilterImpl, RPIPFilter
public interface IPFilter

  • Method Details

    • getFile

      File getFile()
      Gets the file name used for persistent ranges
      Returns:

    • createRange

      IPRange createRange(int address_type, boolean this_session_only)
      creates a new range but *doesn't* add it to the list. Use the add method to add it
      Parameters:
      address_type - - 1= ipv4, 2=ipv6
      this_session_only - // not persisted if "this_session_only" is true
      Returns:

    • addRange

      void addRange(IPRange range)
      Adds a range. Only ranges created with "create" above can be added
      Parameters:
      range -

    • createAndAddRange

      IPRange createAndAddRange(String description, String start_ip, String end_ip, boolean this_session_only)
      Creates, validates and adds a range
      Parameters:
      description -
      start_ip -
      end_ip -
      this_session_only - not persisted if true
      Returns:
      new range or null if invalid

    • removeRange

      void removeRange(IPRange range)
      Remove a range
      Parameters:
      range -

    • reload

      void reload() throws IPFilterException
      Reloads the ip filter from the config file (obtainable using "getFile")
      Throws:
      IPFilterException

    • getRanges

      IPRange[] getRanges()
      Gets the current set of defined IP ranges
      Returns:

    • getNumberOfRanges

      int getNumberOfRanges()
      returns length of ranges list
      Returns:

    • isInRange

      boolean isInRange(String IPAddress)
      Checks an address to see if its in an allowed range
      Parameters:
      IPAddress -
      Returns:

    • getBlockedIPs

      IPBlocked[] getBlockedIPs()
      Gets the current list of blocked addresses
      Returns:

    • getNumberOfBlockedIPs

      int getNumberOfBlockedIPs()
      returns length of blocked ip list
      Returns:

    • block

      void block(String IPAddress)
      Explicitly blocks an address
      Parameters:
      IPAddress -

    • getBannedIPs

      IPBanned[] getBannedIPs()
      Gets the current list of b addresses
      Returns:
      Since:
      2.5.0.2

    • getNumberOfBannedIPs

      int getNumberOfBannedIPs()
      returns length of banned ip list
      Returns:
      Since:
      2.5.0.2

    • ban

      void ban(String IPAddress, String text)
      Explicitly bans an address
      Parameters:
      IPAddress -
      Since:
      2.5.0.2

    • unban

      void unban(String IPAddress)
      Removes a ban on an address
      Parameters:
      IPAddress -
      Since:
      2.5.0.2

    • getInRangeAddressesAreAllowed

      boolean getInRangeAddressesAreAllowed()
      The filter either allows defined ranges to be allowed or denied access
      Returns:

    • setInRangeAddressesAreAllowed

      void setInRangeAddressesAreAllowed(boolean b)
      Set the behaviour of the filter to either allow or deny access for defined ranges
      Parameters:
      b -

    • isEnabled

      boolean isEnabled()
      Test if ipfilter is enabled or not
      Returns:

    • setEnabled

      void setEnabled(boolean enabled)
      change the enabled status
      Parameters:
      enabled -

    • save

      void save() throws IPFilterException
      saves current setting to file given by getFile
      Throws:
      IPFilterException

    • getLastUpdateTime

      long getLastUpdateTime()
      Gets the last time the filter set was updated or marked as up to date
      Returns: