Package com.pushtechnology.diffusion.api.config

Interface GeoIpConfig

All Superinterfaces:
Config
public interface GeoIpConfig extends Config
Geo IP Configuration.

Values may not be changed after the server has started.

Since:
4.4

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFileName()
    Gets the file name.
    boolean
    isEnabled()
    Is Geo Ip enabled?
    void
    setEnabled(boolean enabled)
    Sets enabled flag.
    void
    setFileName(String fileName)
    Sets the name of the Maxmind GeoCityIP city file.

    Methods inherited from interface com.pushtechnology.diffusion.api.config.Config

    isLocked

  • Method Details

    • setEnabled

      void setEnabled(boolean enabled) throws ConfigException
      Sets enabled flag. Set to false to disable Geo IP lookup. By default GeoIp is enabled. This needs to enabled if you are going to use connection/subscription validation policies.
      Parameters:
      enabled - false to disable GeoIp
      Throws:
      ConfigException - if unable to set the property

    • isEnabled

      boolean isEnabled()
      Is Geo Ip enabled?
      Returns:
      true if enabled.

    • setFileName

      void setFileName(String fileName) throws ConfigException
      Sets the name of the Maxmind GeoCityIP city file.

      If not explicitly set, it is assumed that it is in the issued location ("data/GeoLite2-City.mmdb").

      Parameters:
      fileName - the file name
      Throws:
      ConfigException - if unable to set the property

    • getFileName

      String getFileName()
      Gets the file name.
      Returns:
      file name