IP2LocationConfig (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- co.mindus.ip2location.ui.IP2LocationConfig

```
public final class IP2LocationConfig
extends Object
```
Immutable configuration data model for the IP2Location service. <p>This class encapsulates all user-configurable settings for the IP2Location service, providing a clean separation between UI state and service configuration. Instances are immutable and created via the fluent IP2LocationConfig.Builder.</p> <h2>Configuration Properties</h2> <table border="1"> <tr><th>Property</th><th>Default</th><th>Description</th></tr> <tr><td>enabled</td><td>false</td><td>Whether the service is enabled</td></tr> <tr><td>token</td><td>""</td><td>IP2Location API download token</td></tr> <tr><td>databasePath</td><td>"IP2Location"</td><td>Path relative to server installation</td></tr> <tr><td>database</td><td>DB11_LITE</td><td>Database type to use</td></tr> <tr><td>includeIPv6</td><td>false</td><td>Whether to enable IPv6 support</td></tr> <tr><td>useMemoryMappedFile</td><td>true</td><td>Whether to use memory-mapped file access</td></tr> </table> <h2>Usage Example</h2> <pre>// Create a configuration IP2LocationConfig config = IP2LocationConfig.builder() .enabled(true) .token("your-token-here") .database(Database.DB11_LITE) .includeIPv6(true) .useMemoryMappedFile(true) .build(); // Create from existing config with modifications IP2LocationConfig modified = config.toBuilder() .includeIPv6(false) .build();</pre> <h2>Persistence</h2> <p>This class provides methods to load from and save to IniFile for configuration persistence.</p> <h2>Thread Safety</h2> <p>This class is immutable and therefore inherently thread-safe.</p>

Author:

Christopher Mindus

See Also:

AdminIP2LocationPanel, IniFile

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IP2LocationConfig.Builder
Builder for creating IP2LocationConfig instances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`IP2LocationConfig.Builder` Builder for creating `IP2LocationConfig` instances.

Field Summary

Fields
Modifier and Type	Field and Description
`static Database`	`DEFAULT_DATABASE` Default database type.
`static String`	`DEFAULT_DB_PATH` Default database path relative to server installation.
`static String`	`KEY_DB_NAME` Key for the database type name.
`static String`	`KEY_DB_PATH` Key for the database path.
`static String`	`KEY_ENABLE_IPV6` Key for IPv6 support flag.
`static String`	`KEY_ENABLED` Key for the enabled flag.
`static String`	`KEY_INIT_FAILURE_THRESHOLD` Key for init failure threshold.
`static String`	`KEY_LOOKUP_ERROR_THRESHOLD` Key for lookup error threshold.
`static String`	`KEY_MAX_RECOVERY_ATTEMPTS` Key for max auto-recovery attempts.
`static String`	`KEY_MEMORY_MAPPED` Key for memory-mapped file flag.
`static String`	`KEY_NOTIFY_TRANSIENT` Key for notify on transient errors flag.
`static String`	`KEY_RECOVER_ON_CORRUPTION` Key for recover on corruption flag.
`static String`	`KEY_RECOVER_ON_DOWNLOAD` Key for recover on download failure flag.
`static String`	`KEY_RECOVERY_ACTION` Key for recovery action.
`static String`	`KEY_RECOVERY_COOLDOWN` Key for recovery cooldown minutes.
`static String`	`KEY_TOKEN` Key for the download token.
`static String`	`SECTION` INI file section name for IP2Location settings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static IP2LocationConfig.Builder`	`builder()` Creates a new builder with default values.
`boolean`	`equals(Object o)`
`Database`	`getDatabase()` Returns the database type to use.
`String`	`getDatabasePath()` Returns the database path relative to server installation.
`Path`	`getDatabasePathAsPath()` Returns the database path as a `Path` object.
`int`	`getInitFailureThreshold()` Returns the threshold for consecutive init failures.
`int`	`getLookupErrorThreshold()` Returns the threshold for consecutive lookup errors.
`int`	`getMaxAutoRecoveryAttempts()` Returns the maximum auto-recovery attempts.
`RecoveryConfig.RecoveryAction`	`getRecoveryAction()` Returns the recovery action when thresholds are exceeded.
`int`	`getRecoveryCooldownMinutes()` Returns the recovery cooldown in minutes.
`String`	`getToken()` Returns the IP2Location download token.
`int`	`hashCode()`
`boolean`	`isEnabled()` Returns whether the IP2Location service is enabled.
`boolean`	`isIncludeIPv6()` Returns whether IPv6 support is enabled.
`boolean`	`isNotifyOnTransientErrors()` Returns whether to notify on transient errors.
`boolean`	`isRecoverOnCorruption()` Returns whether to recover on database corruption.
`boolean`	`isRecoverOnDownloadFailure()` Returns whether to recover on download failure.
`boolean`	`isUseMemoryMappedFile()` Returns whether memory-mapped file access is enabled.
`static IP2LocationConfig`	`loadFrom(IniFile ini)` Loads configuration from the server.ini file.
`void`	`saveTo(IniFile ini)` Saves this configuration to the server.ini file.
`IP2LocationConfig.Builder`	`toBuilder()` Creates a builder initialized with this configuration's values.
`RecoveryConfig`	`toRecoveryConfig()` Creates a RecoveryConfig from this configuration.
`String`	`toString()`
`ValidationResult`	`validate()` Validates this configuration.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SECTION
```
public static final String SECTION
```
    INI file section name for IP2Location settings.
    
    See Also:
    
    Constant Field Values
  - KEY_ENABLED
```
public static final String KEY_ENABLED
```
    Key for the enabled flag.
    
    See Also:
    
    Constant Field Values
  - KEY_TOKEN
```
public static final String KEY_TOKEN
```
    Key for the download token.
    
    See Also:
    
    Constant Field Values
  - KEY_DB_PATH
```
public static final String KEY_DB_PATH
```
    Key for the database path.
    
    See Also:
    
    Constant Field Values
  - KEY_DB_NAME
```
public static final String KEY_DB_NAME
```
    Key for the database type name.
    
    See Also:
    
    Constant Field Values
  - KEY_ENABLE_IPV6
```
public static final String KEY_ENABLE_IPV6
```
    Key for IPv6 support flag.
    
    See Also:
    
    Constant Field Values
  - KEY_MEMORY_MAPPED
```
public static final String KEY_MEMORY_MAPPED
```
    Key for memory-mapped file flag.
    
    See Also:
    
    Constant Field Values
  - KEY_RECOVERY_ACTION
```
public static final String KEY_RECOVERY_ACTION
```
    Key for recovery action.
    
    See Also:
    
    Constant Field Values
  - KEY_INIT_FAILURE_THRESHOLD
```
public static final String KEY_INIT_FAILURE_THRESHOLD
```
    Key for init failure threshold.
    
    See Also:
    
    Constant Field Values
  - KEY_LOOKUP_ERROR_THRESHOLD
```
public static final String KEY_LOOKUP_ERROR_THRESHOLD
```
    Key for lookup error threshold.
    
    See Also:
    
    Constant Field Values
  - KEY_MAX_RECOVERY_ATTEMPTS
```
public static final String KEY_MAX_RECOVERY_ATTEMPTS
```
    Key for max auto-recovery attempts.
    
    See Also:
    
    Constant Field Values
  - KEY_RECOVERY_COOLDOWN
```
public static final String KEY_RECOVERY_COOLDOWN
```
    Key for recovery cooldown minutes.
    
    See Also:
    
    Constant Field Values
  - KEY_RECOVER_ON_DOWNLOAD
```
public static final String KEY_RECOVER_ON_DOWNLOAD
```
    Key for recover on download failure flag.
    
    See Also:
    
    Constant Field Values
  - KEY_RECOVER_ON_CORRUPTION
```
public static final String KEY_RECOVER_ON_CORRUPTION
```
    Key for recover on corruption flag.
    
    See Also:
    
    Constant Field Values
  - KEY_NOTIFY_TRANSIENT
```
public static final String KEY_NOTIFY_TRANSIENT
```
    Key for notify on transient errors flag.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DB_PATH
```
public static final String DEFAULT_DB_PATH
```
    Default database path relative to server installation.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DATABASE
```
public static final Database DEFAULT_DATABASE
```
    Default database type.
- Method Detail
  - isEnabled
```
public boolean isEnabled()
```
    Returns whether the IP2Location service is enabled.
    
    Returns:
    
    true if the service should be started
  - getToken
```
public String getToken()
```
    Returns the IP2Location download token.
    
    Returns:
    
    The token, never null (may be empty)
  - getDatabasePath
```
public String getDatabasePath()
```
    Returns the database path relative to server installation.
    
    Returns:
    
    The relative path, never null
  - getDatabasePathAsPath
```
public Path getDatabasePathAsPath()
```
    Returns the database path as a Path object.
    
    Returns:
    
    The database path
  - getDatabase
```
public Database getDatabase()
```
    Returns the database type to use.
    
    Returns:
    
    The database type, never null
  - isIncludeIPv6
```
public boolean isIncludeIPv6()
```
    Returns whether IPv6 support is enabled.
    
    Returns:
    
    true if both IPv4 and IPv6 databases should be downloaded
  - isUseMemoryMappedFile
```
public boolean isUseMemoryMappedFile()
```
    Returns whether memory-mapped file access is enabled.
    
    Returns:
    
    true if memory-mapped files should be used
  - getRecoveryAction
```
public RecoveryConfig.RecoveryAction getRecoveryAction()
```
    Returns the recovery action when thresholds are exceeded.
    
    Returns:
    
    The recovery action
  - getInitFailureThreshold
```
public int getInitFailureThreshold()
```
    Returns the threshold for consecutive init failures.
    
    Returns:
    
    The init failure threshold
  - getLookupErrorThreshold
```
public int getLookupErrorThreshold()
```
    Returns the threshold for consecutive lookup errors.
    
    Returns:
    
    The lookup error threshold
  - getMaxAutoRecoveryAttempts
```
public int getMaxAutoRecoveryAttempts()
```
    Returns the maximum auto-recovery attempts.
    
    Returns:
    
    Max recovery attempts
  - getRecoveryCooldownMinutes
```
public int getRecoveryCooldownMinutes()
```
    Returns the recovery cooldown in minutes.
    
    Returns:
    
    Cooldown minutes
  - isRecoverOnDownloadFailure
```
public boolean isRecoverOnDownloadFailure()
```
    Returns whether to recover on download failure.
    
    Returns:
    
    true if recovery on download failure is enabled
  - isRecoverOnCorruption
```
public boolean isRecoverOnCorruption()
```
    Returns whether to recover on database corruption.
    
    Returns:
    
    true if recovery on corruption is enabled
  - isNotifyOnTransientErrors
```
public boolean isNotifyOnTransientErrors()
```
    Returns whether to notify on transient errors.
    
    Returns:
    
    true if transient error notifications are enabled
  - toRecoveryConfig
```
public RecoveryConfig toRecoveryConfig()
```
    Creates a RecoveryConfig from this configuration.
    
    Returns:
    
    A RecoveryConfig with settings from this configuration
  - validate
```
public ValidationResult validate()
```
    Validates this configuration.
    
    Returns:
    
    A validation result indicating success or listing errors
  - loadFrom
```
public static IP2LocationConfig loadFrom(IniFile ini)
```
    Loads configuration from the server.ini file.
    
    Parameters:
    
    ini - The Ini file to load from
    
    Returns:
    
    A new configuration loaded from the store
  - saveTo
```
public void saveTo(IniFile ini)
```
    Saves this configuration to the server.ini file.
    
    Parameters:
    
    ini - The INI file to save to
  - builder
```
public static IP2LocationConfig.Builder builder()
```
    Creates a new builder with default values.
    
    Returns:
    
    A new Builder instance
  - toBuilder
```
public IP2LocationConfig.Builder toBuilder()
```
    Creates a builder initialized with this configuration's values.
    
    Returns:
    
    A Builder pre-populated with current values
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class IP2LocationConfig

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SECTION

KEY_ENABLED

KEY_TOKEN

KEY_DB_PATH

KEY_DB_NAME

KEY_ENABLE_IPV6

KEY_MEMORY_MAPPED

KEY_RECOVERY_ACTION

KEY_INIT_FAILURE_THRESHOLD

KEY_LOOKUP_ERROR_THRESHOLD

KEY_MAX_RECOVERY_ATTEMPTS

KEY_RECOVERY_COOLDOWN

KEY_RECOVER_ON_DOWNLOAD

KEY_RECOVER_ON_CORRUPTION

KEY_NOTIFY_TRANSIENT

DEFAULT_DB_PATH

DEFAULT_DATABASE

Method Detail

isEnabled

getToken

getDatabasePath

getDatabasePathAsPath

getDatabase

isIncludeIPv6

isUseMemoryMappedFile

getRecoveryAction

getInitFailureThreshold

getLookupErrorThreshold

getMaxAutoRecoveryAttempts

getRecoveryCooldownMinutes

isRecoverOnDownloadFailure

isRecoverOnCorruption

isNotifyOnTransientErrors

toRecoveryConfig

validate

loadFrom

saveTo

builder

toBuilder

equals

hashCode

toString