ConfigRequired (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- java.lang.Enum<ConfigRequired>
- - se.entra.phantom.server.ConfigRequired

All Implemented Interfaces:
Serializable, Comparable<ConfigRequired>
```
public enum ConfigRequired
extends Enum<ConfigRequired>
```
The reasons why a Server may be placed in "configuration required" mode.
Configuration-required mode used to be a single boolean with a single message string, set from around thirty unrelated places. Once it was raised, nothing could tell what had raised it, so no condition could ever safely clear it: clearing on behalf of one problem would have silently cleared somebody else's. The state is therefore keyed by reason, and each reason is cleared only by whatever set it.
Reasons are either recoverable or not:
- Recoverable – the condition can be corrected while the Server is running, and the Server returns to service without a restart once it is. Only the Activation Code and the Run Code qualify: both are entered through the licensing panel, which is reachable precisely because the Server keeps running.
- Not recoverable – the Server must be restarted by an administrator. This covers everything to do with server.ini (codepages, country settings, host and application defaults) and any change to the License Code, since a License Code change means the hardware or the user limits moved and there must be no ambiguity about what is in force.
The Server is in configuration-required mode while any reason is present, and may resume in place only when every remaining reason is recoverable.
(C) Copyright 2026 Mindus SARL. All rights reserved.
Author:
Christopher Mindus

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACTIVATION_CODE` The Activation Code is missing or does not match.
`CONFIG_ERR_NON_RECOVERABLE` A configuration error that requires an administrator and a Server restart: `server.ini` problems such as a missing or invalid codepage, invalid country settings, an invalid default host session or application, and anything else that cannot be corrected from a running Server.
`LICENSE_CODE` The License Code is missing, invalid or inactive.
`LICENSE_MANAGERS` The License Manager list is missing or no properly configured License Manager was found.
`LICENSING_ERROR` The licensing system failed to initialize.
`RUN_CODE` The Run Code is missing, expired, not yet valid or marked not valid.
`SERVER_ID` The server ID is invalid, or the cluster configuration is inconsistent.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`isRecoverable` Whether resolving this reason alone can return the Server to service without a restart.
`String`	`text` Short description, used in the event log and in ServerAdmin.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ConfigRequired`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ConfigRequired[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - CONFIG_ERR_NON_RECOVERABLE
```
public static final ConfigRequired CONFIG_ERR_NON_RECOVERABLE
```
    A configuration error that requires an administrator and a Server restart: server.ini problems such as a missing or invalid codepage, invalid country settings, an invalid default host session or application, and anything else that cannot be corrected from a running Server. This is the default reason for the legacy single-argument ClientSessionManager.setServerConfigRequired(String).
  - LICENSE_CODE
```
public static final ConfigRequired LICENSE_CODE
```
    The License Code is missing, invalid or inactive. Not recoverable: a License Code change means the hardware or the concurrent user limits changed.
  - SERVER_ID
```
public static final ConfigRequired SERVER_ID
```
    The server ID is invalid, or the cluster configuration is inconsistent.
  - LICENSE_MANAGERS
```
public static final ConfigRequired LICENSE_MANAGERS
```
    The License Manager list is missing or no properly configured License Manager was found.
  - LICENSING_ERROR
```
public static final ConfigRequired LICENSING_ERROR
```
    The licensing system failed to initialize.
  - ACTIVATION_CODE
```
public static final ConfigRequired ACTIVATION_CODE
```
    The Activation Code is missing or does not match. Recoverable: this is the normal state after the Server has been patched, and a new Activation Code is entered in the licensing panel of a running Server.
  - RUN_CODE
```
public static final ConfigRequired RUN_CODE
```
    The Run Code is missing, expired, not yet valid or marked not valid. Recoverable: a replacement Run Code is entered in the licensing panel of a running Server.
- Field Detail
  - isRecoverable
```
public final boolean isRecoverable
```
    Whether resolving this reason alone can return the Server to service without a restart.
  - text
```
public final String text
```
    Short description, used in the event log and in ServerAdmin.
- Method Detail
  - values
```
public static ConfigRequired[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ConfigRequired c : ConfigRequired.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ConfigRequired valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
    NullPointerException - if the argument is null

Enum ConfigRequired

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CONFIG_ERR_NON_RECOVERABLE

LICENSE_CODE

SERVER_ID

LICENSE_MANAGERS

LICENSING_ERROR

ACTIVATION_CODE

RUN_CODE

Field Detail

isRecoverable

text

Method Detail

values

valueOf