org.opends.server.util
Enum VersionCompatibilityIssue.Effect

java.lang.Object
  extended by java.lang.Enum<VersionCompatibilityIssue.Effect>
      extended by org.opends.server.util.VersionCompatibilityIssue.Effect
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<VersionCompatibilityIssue.Effect>
Enclosing class:
VersionCompatibilityIssue

public static enum VersionCompatibilityIssue.Effect
extends java.lang.Enum<VersionCompatibilityIssue.Effect>

Effects cause the upgrade and revision tools to behave in specific ways in response to compatibility issues.


Enum Constant Summary
NO_SERVER_RESTART_FOLLOWING_REVERSION
          Indicates that for some reason the server should not be restarted following a reversion.
REVERSION_DATA_EXPORT_AND_REIMPORT_REQUIRED
          Before a reversion can take place there must be a complete data export to LDIF followed by a complete data import after the operation has completed.
REVERSION_MANUAL_ACTION_REQUIRED
          Indicates that the user needs to perform some manual action (for which there is not effect currently defined such as REVERSION_DATA_EXPORT_AND_REIMPORT_REQUIRED) in order for the operation to be successful.
REVERSION_NOT_POSSIBLE
          Indicates that it is not possible to revert between to builds between which lies a flag day.
REVERSION_SHOW_INFO_MESSAGE
          Indicates that the reverter tool will show a message to the administrator.
REVERSION_SHOW_WARNING_MESSAGE
          Indicates that the reverter tool will show a message to the administrator.
UPGRADE_DATA_EXPORT_AND_REIMPORT_REQUIRED
          Before an upgrade can take place there must be a complete data export to LDIF followed by a complete data import after the operation has completed.
UPGRADE_MANUAL_ACTION_REQUIRED
          Indicates that the user needs to perform some manual action (for which there is not effect currently defined such as UPGRADE_DATA_EXPORT_AND_REIMPORT_REQUIRED) in order for the operation to be successful.
UPGRADE_NOT_POSSIBLE
          Indicates that it is not possible to upgrade between to builds between which lies a flag day.
UPGRADE_SHOW_INFO_MESSAGE
          Indicates that the upgrader will show an informational message to the administrator.
UPGRADE_SHOW_WARNING_MESSAGE
          Indicates that the upgrader will show a message to the administrator.
 
Method Summary
static VersionCompatibilityIssue.Effect valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static VersionCompatibilityIssue.Effect[] 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

REVERSION_DATA_EXPORT_AND_REIMPORT_REQUIRED

public static final VersionCompatibilityIssue.Effect REVERSION_DATA_EXPORT_AND_REIMPORT_REQUIRED
Before a reversion can take place there must be a complete data export to LDIF followed by a complete data import after the operation has completed. Assigning this effect to an issue will cause a detailed set of instructions to appear in the reversion tool explaining how to perform the task.


UPGRADE_DATA_EXPORT_AND_REIMPORT_REQUIRED

public static final VersionCompatibilityIssue.Effect UPGRADE_DATA_EXPORT_AND_REIMPORT_REQUIRED
Before an upgrade can take place there must be a complete data export to LDIF followed by a complete data import after the operation has completed. Assigning this effect to an issue will cause a detailed set of instructions to appear in the upgrade tool explaining how to perform the task.


UPGRADE_SHOW_INFO_MESSAGE

public static final VersionCompatibilityIssue.Effect UPGRADE_SHOW_INFO_MESSAGE
Indicates that the upgrader will show an informational message to the administrator. Use this effect when you want to have the upgrader show the user an informational message during upgrade but the message does not dictate that an action be performed. For instance you might want to let the user know that due to a data format incompatibility, it will be more difficult to revert this build to its previous version following this upgrade. If you want the message to be scarier, use UPGRADE_SHOW_WARNING_MESSAGE instead.


REVERSION_SHOW_INFO_MESSAGE

public static final VersionCompatibilityIssue.Effect REVERSION_SHOW_INFO_MESSAGE
Indicates that the reverter tool will show a message to the administrator. Use this effect when you want to have the reverter show the user an informational message during upgrade but the message does not dictate that an action be performed. If you want the message to be scarier, use REVERSION_SHOW_WARNING_MESSAGE instead.


UPGRADE_SHOW_WARNING_MESSAGE

public static final VersionCompatibilityIssue.Effect UPGRADE_SHOW_WARNING_MESSAGE
Indicates that the upgrader will show a message to the administrator. Use this effect when you want to have the upgrader show the user an informational message during upgrade but the message does not dictate that an action be performed. For instance you might want to let the user know that due to a data format incompatibility, it will be more difficult to revert this build to its previous version following this upgrade. If you want the message to be less scary, use UPGRADE_SHOW_INFO_MESSAGE instead.


REVERSION_SHOW_WARNING_MESSAGE

public static final VersionCompatibilityIssue.Effect REVERSION_SHOW_WARNING_MESSAGE
Indicates that the reverter tool will show a message to the administrator. Use this effect when you want to have the reverter show the user an informational message during upgrade but the message does not dictate that an action be performed. If you want the message to be less scary, use REVERSION_SHOW_INFO_MESSAGE instead.


UPGRADE_MANUAL_ACTION_REQUIRED

public static final VersionCompatibilityIssue.Effect UPGRADE_MANUAL_ACTION_REQUIRED
Indicates that the user needs to perform some manual action (for which there is not effect currently defined such as UPGRADE_DATA_EXPORT_AND_REIMPORT_REQUIRED) in order for the operation to be successful. The action itself should be described in detail in the upgrade message.


REVERSION_MANUAL_ACTION_REQUIRED

public static final VersionCompatibilityIssue.Effect REVERSION_MANUAL_ACTION_REQUIRED
Indicates that the user needs to perform some manual action (for which there is not effect currently defined such as REVERSION_DATA_EXPORT_AND_REIMPORT_REQUIRED) in order for the operation to be successful. The action itself should be described in detail in the reversion message.


UPGRADE_NOT_POSSIBLE

public static final VersionCompatibilityIssue.Effect UPGRADE_NOT_POSSIBLE
Indicates that it is not possible to upgrade between to builds between which lies a flag day. The upgrader will refuse to operate in this case.


REVERSION_NOT_POSSIBLE

public static final VersionCompatibilityIssue.Effect REVERSION_NOT_POSSIBLE
Indicates that it is not possible to revert between to builds between which lies a flag day. The reverter will refuse to run in this case.


NO_SERVER_RESTART_FOLLOWING_REVERSION

public static final VersionCompatibilityIssue.Effect NO_SERVER_RESTART_FOLLOWING_REVERSION
Indicates that for some reason the server should not be restarted following a reversion. There might be situations where the admin needs to perform some actions before the server restarts (such as the database format being incompatible and the data needing an export followed by a re-import). This effect need not be included with UPGRADE_DATA_EXPORT_AND_REIMPORT_REQUIRED and REVERSION_DATA_EXPORT_AND_REIMPORT_REQUIRED as this is assumed.

Method Detail

values

public static VersionCompatibilityIssue.Effect[] 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 (VersionCompatibilityIssue.Effect c : VersionCompatibilityIssue.Effect.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static VersionCompatibilityIssue.Effect valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null