org.opends.server.util
Enum VersionCompatibilityIssue.Cause

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

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

Unique descriptor of an event that created a flag day for one or more versions of the OpenDS codebase.


Enum Constant Summary
BACKEND_CONFIGURATION_CHANGE_1
          Incompatible changes in the backend configuration (the db directory attribute has been modified).
BERKLEY_UPGRADE_1
          Upgrade of Berkley DB library to 3.2.13 on 12/17/2006.
DB_FORMAT_CHANGE_1
          Database format change committed on 4/6/2007 and described in the SVN log for rev 1582.
DB_FORMAT_CHANGE_2
          Database format change committed on 6/7/2007 and described in the SVN log for rev 2049.
DN_NORMALIZATION_CHANGE_1
          Incompatible changes in DN normalization.
PROPERTY_CHANGE_1
          Incompatible property name change committed on 09/05/2007 and described in the SVN log for rev 2974.
REPLICATION_SECURITY_CHANGE_1
          Incompatible changes in the cryptomanager and specially in the way replication works.
 
Method Summary
 java.util.Set<VersionCompatibilityIssue.Effect> getEffects()
          Gets the set of effects that cause the upgrade/reversion tools to behave in particular ways.
 int getId()
          Gets the ID of this cause.
 Message getLocalizedReversionMessage()
          Gets a localized message to be shown to the user during the reversion process.
 Message getLocalizedUpgradeMessage()
          Gets a localized message to be shown to the user during the upgrade process.
static VersionCompatibilityIssue.Cause valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static VersionCompatibilityIssue.Cause[] 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

DN_NORMALIZATION_CHANGE_1

public static final VersionCompatibilityIssue.Cause DN_NORMALIZATION_CHANGE_1
Incompatible changes in DN normalization. This causes dn2id and RDN / DN syntax based attribute indexes to be invalidated.


BACKEND_CONFIGURATION_CHANGE_1

public static final VersionCompatibilityIssue.Cause BACKEND_CONFIGURATION_CHANGE_1
Incompatible changes in the backend configuration (the db directory attribute has been modified).


REPLICATION_SECURITY_CHANGE_1

public static final VersionCompatibilityIssue.Cause REPLICATION_SECURITY_CHANGE_1
Incompatible changes in the cryptomanager and specially in the way replication works. These changes were committed on several revisions and the flagday that has been chosen corresponds to revision 3294 (opends 1.0.0 build 6 of 16/10/2007)


PROPERTY_CHANGE_1

public static final VersionCompatibilityIssue.Cause PROPERTY_CHANGE_1
Incompatible property name change committed on 09/05/2007 and described in the SVN log for rev 2974.


DB_FORMAT_CHANGE_2

public static final VersionCompatibilityIssue.Cause DB_FORMAT_CHANGE_2
Database format change committed on 6/7/2007 and described in the SVN log for rev 2049.


DB_FORMAT_CHANGE_1

public static final VersionCompatibilityIssue.Cause DB_FORMAT_CHANGE_1
Database format change committed on 4/6/2007 and described in the SVN log for rev 1582.


BERKLEY_UPGRADE_1

public static final VersionCompatibilityIssue.Cause BERKLEY_UPGRADE_1
Upgrade of Berkley DB library to 3.2.13 on 12/17/2006.

Method Detail

values

public static VersionCompatibilityIssue.Cause[] 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.Cause c : VersionCompatibilityIssue.Cause.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.Cause 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

getId

public int getId()
Gets the ID of this cause.

Returns:
id of this cause

getEffects

public java.util.Set<VersionCompatibilityIssue.Effect> getEffects()
Gets the set of effects that cause the upgrade/reversion tools to behave in particular ways.

Returns:
set of effects

getLocalizedUpgradeMessage

public Message getLocalizedUpgradeMessage()
Gets a localized message to be shown to the user during the upgrade process.

Returns:
a message to be shown to the user during an upgrade between two different version between which this issue lies. This message might detail instructions for manual actions that must be performed (when used with the UPGRADE_MANUAL_ACTION_REQUIRED) or just give the user useful information (when used with UPGRADE_SHOW_INFO_MESSAGE)

getLocalizedReversionMessage

public Message getLocalizedReversionMessage()
Gets a localized message to be shown to the user during the reversion process.

Returns:
a message to be shown to the user during an upgrade between two different version between which this issue lies. This message might detail instructions for manual actions that must be performed (when used with the REVERSION_MANUAL_ACTION_REQUIRED) or just give the user useful information (when used with REVERSION_SHOW_INFO_MESSAGE)