org.opends.server.admin.client.cli
Enum DsFrameworkCliReturnCode

java.lang.Object
  extended by java.lang.Enum<DsFrameworkCliReturnCode>
      extended by org.opends.server.admin.client.cli.DsFrameworkCliReturnCode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DsFrameworkCliReturnCode>

public enum DsFrameworkCliReturnCode
extends java.lang.Enum<DsFrameworkCliReturnCode>

The enumeration which defines the return code.


Enum Constant Summary
ACCESS_PERMISSION
          An access permission error.
ALREADY_REGISTERED
          The entity is already registered.
BROKEN_INSTALL
          The installation is broken.
CANNOT_CONNECT_TO_ADS
          Return code: Cannot get the connection to the ADS.
CANNOT_INITIALIZE_ARGS
          Unable to initialize arguments.
CONFLICTING_ARGS
          Unexpected error (potential bug).
ERROR_PARSING_ARGS
          Cannot parse arguments.
ERROR_UNEXPECTED
          Unexpected error (potential bug).
MISSING_ADMIN_PASSWORD
          The administrator password is missing.
MISSING_ADMIN_UID
          The administration UID is missing.
MISSING_HOSTNAME
          The host name is missing.
MISSING_IPATH
          The installation path is missing.
MISSING_NAME
          The name is missing.
MISSING_PORT
          The port is missing.
NOT_YET_REGISTERED
          The entity is not yet registered.
NOVALID_HOSTNAME
          The host name is not valid.
NOVALID_IPATH
          The installation path is not valid.
NOVALID_PORT
          The port is not valid.
SERVER_NOT_REGISTERED
          The server entity is not yet registered.
SUCCESSFUL
          successful.
SUCCESSFUL_NOP
          successful but no operation was performed.
 
Method Summary
 Message getMessage()
          Get the corresponding message.
 int getReturnCode()
          Get the corresponding return code value.
static DsFrameworkCliReturnCode getReturncodeFromAdsError(ADSContextException.ErrorType error)
          Get ReturnCode from an ADS error.
static DsFrameworkCliReturnCode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DsFrameworkCliReturnCode[] 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

SUCCESSFUL

public static final DsFrameworkCliReturnCode SUCCESSFUL
successful.


SUCCESSFUL_NOP

public static final DsFrameworkCliReturnCode SUCCESSFUL_NOP
successful but no operation was performed.


CANNOT_INITIALIZE_ARGS

public static final DsFrameworkCliReturnCode CANNOT_INITIALIZE_ARGS
Unable to initialize arguments.


ERROR_PARSING_ARGS

public static final DsFrameworkCliReturnCode ERROR_PARSING_ARGS
Cannot parse arguments.


CANNOT_CONNECT_TO_ADS

public static final DsFrameworkCliReturnCode CANNOT_CONNECT_TO_ADS
Return code: Cannot get the connection to the ADS.


MISSING_HOSTNAME

public static final DsFrameworkCliReturnCode MISSING_HOSTNAME
The host name is missing.


NOVALID_HOSTNAME

public static final DsFrameworkCliReturnCode NOVALID_HOSTNAME
The host name is not valid.


MISSING_IPATH

public static final DsFrameworkCliReturnCode MISSING_IPATH
The installation path is missing.


NOVALID_IPATH

public static final DsFrameworkCliReturnCode NOVALID_IPATH
The installation path is not valid.


ACCESS_PERMISSION

public static final DsFrameworkCliReturnCode ACCESS_PERMISSION
An access permission error.


ALREADY_REGISTERED

public static final DsFrameworkCliReturnCode ALREADY_REGISTERED
The entity is already registered.


BROKEN_INSTALL

public static final DsFrameworkCliReturnCode BROKEN_INSTALL
The installation is broken.


NOT_YET_REGISTERED

public static final DsFrameworkCliReturnCode NOT_YET_REGISTERED
The entity is not yet registered.


MISSING_PORT

public static final DsFrameworkCliReturnCode MISSING_PORT
The port is missing.


NOVALID_PORT

public static final DsFrameworkCliReturnCode NOVALID_PORT
The port is not valid.


MISSING_NAME

public static final DsFrameworkCliReturnCode MISSING_NAME
The name is missing.


MISSING_ADMIN_UID

public static final DsFrameworkCliReturnCode MISSING_ADMIN_UID
The administration UID is missing.


MISSING_ADMIN_PASSWORD

public static final DsFrameworkCliReturnCode MISSING_ADMIN_PASSWORD
The administrator password is missing.


ERROR_UNEXPECTED

public static final DsFrameworkCliReturnCode ERROR_UNEXPECTED
Unexpected error (potential bug).


CONFLICTING_ARGS

public static final DsFrameworkCliReturnCode CONFLICTING_ARGS
Unexpected error (potential bug).


SERVER_NOT_REGISTERED

public static final DsFrameworkCliReturnCode SERVER_NOT_REGISTERED
The server entity is not yet registered.

Method Detail

values

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

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

valueOf

public static DsFrameworkCliReturnCode 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

getMessage

public Message getMessage()
Get the corresponding message.

Returns:
The corresponding message.

getReturnCode

public int getReturnCode()
Get the corresponding return code value.

Returns:
The corresponding return code value.

getReturncodeFromAdsError

public static DsFrameworkCliReturnCode getReturncodeFromAdsError(ADSContextException.ErrorType error)
Get ReturnCode from an ADS error.

Parameters:
error - The ADS error
Returns:
the ReturnCode associated to the ADS error.