com.novell.ecb.secretstore
Class SecretStoreException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.novell.ecb.CommandException
                    |
                    +--com.novell.ecb.secretstore.SecretStoreException

All Implemented Interfaces:

RootCause, java.io.Serializable

public class SecretStoreException

extends CommandException

Wraps the underlying exception object or error message along with error code.

Version:

1.0

See Also:

Serialized Form

Field Summary

static int	ACCESS_DENIED Access to the target SecretStore has been denied.
static int	ATTR_NOT_FOUND One of the optional service attributes is not instantiated.
static int	ATTR_VAL_NOT_FOUND Target attribute is not instantiated in Novell eDirectory.
static int	BETA_EXPIRED Product's BETA life has expired.
static int	BUFFER_LEN Size of the buffer is not in a nominal range between minimum and maximum.
static int	CONFIG_NOT_SUPPORTED No server to support the given override configuration is found.
static int	CONN_ACCESS_FAILURE Access to server connection failed.
static int	CORRUPTED_PACKET_DATA Protocol data corrupted on the wire.
static int	CORRUPTED_STORE SecretStore data on the server has been corrupted.
static int	CRYPTO_OP_FAILURE Cryptographic operation failed.
static int	ENUM_BUFF_TOO_LONG Size of the enumeration buffer exceeds the limit.
static int	ENUM_BUFF_TOO_SHORT Length of the Enumeration buffer too short.
static int	EP_ACCESS_DENIED Enhanced protection password validation failed.
static int	INCOMPATIBLE_VERSION Client and server components are not of the compatible versions.
static int	INVALID_PARAM API parameter is not initialized.
static int	INVALID_SECRET_ID Secret ID is not in the User Secret Store.
static int	INVALID_TARGET_OBJECT Target eDirectory User object not found.
static int	MIGRATION_NEEDED Server has been upgraded and user SecretStore should be updated.
static int	MP_PWORD_INVALID Master password could not be verified to read or unlock the secrets.
static int	MP_PWORD_NOT_ALLOWED Ability to use master password has been disabled.
static int	MP_PWORD_NOT_SET Master password has not been set on the SecretStore.
static int	NDS_INTERNAL_FAILURE Some internal eDirectory services have not been available.
static int	NDS_PWORD_CHANGED User eDirectory password has been changed by the administrator.
static int	NDS_PWORD_INVALID Typed in eDirectory password not valid.
static int	NEED_SECURE_CHANNEL Connection to SecretStore needs to be over SSL.
static int	NICI_FAILURE NICI operations have failed.
static int	NICI_OUTOF_SYNC Session keys of the client and server NICI are out of sync.
static int	NO_CODE No error code.
static int	NOT_AUTHENTICATED User not authenticated.
static int	NOT_IMPLEMENTED Feature not implemented yet.
static int	NOT_SUPPORTED Not supported operations.
static int	OBJECT_NOT_FOUND Can't find the target object DN in eDirectory.
static int	SCHEMA_NOT_EXTENDED Schema is not extended to support SecreStore on the target tree.
static int	SECRET_BUFF_TOO_LONG Size of the Secret buffer exceeds the limit.
static int	SECRET_ID_EXISTS Secret ID already exists in the Secret Store.
static int	SECRET_ID_TOO_LONG Length of the Secret ID buffer exceeds the limit.
static int	SECRET_ID_TOO_SHORT Length of the Secret ID should be greater than zero.
static int	SECRET_UNINITIALIZED Secret has not been initialized with a write.
static int	SERVER_CONN_FAILURE Opening a connection to the server failed.
static int	SERVICE_NOT_FOUND SecretStore not on the Network.
static int	SERVICE_NOT_SUPPORTED Requested service not supported yet.
static int	STORE_NOT_FOUND Target eDirectory User object does not have a SecretStore.
static int	STORE_NOT_LOCKED Attempt to unlock SecretStore failed because the store is not locked.
static int	SYSTEM_FAILURE Some internal operating system services have not been available.
static int	TOKEN_NOT_SUPPORTED NDS authentication type not supported.
static int	TRANSPORT_FAILURE Connection to server is lost.
static int	UNICODE_OP_FAILURE Unicode text conversion operation failed.
static int	WRONG_REPLICA_TYPE Not a writeable replica of eDirectory.

Constructor Summary

SecretStoreException(java.lang.String message)
Constructs a SecretStoreException object.

SecretStoreException(java.lang.String message, int errorCode)
Constructs a SecretStoreException object and sets the error description and error code.

SecretStoreException(java.lang.String message, java.lang.Throwable rootCause)
Constructs a SecretStoreException object and sets the cause of exception and error description.

SecretStoreException(java.lang.String message, java.lang.Throwable rootCause, int errorCode)
Constructs a SecretStoreException object and sets the cause of exception, error code and error description.

Method Summary

int	getErrorCode() Returns the error code returned by the server or local error code.

Methods inherited from class com.novell.ecb.CommandException

getRootCause, printCauseStackTrace, printCauseStackTrace, printCauseStackTrace, setRootCause

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_CODE

public static final int NO_CODE

No error code.

See Also:

Constant Field Values

ACCESS_DENIED

public static final int ACCESS_DENIED

Access to the target SecretStore has been denied.

See Also:

Constant Field Values

ATTR_NOT_FOUND

public static final int ATTR_NOT_FOUND

One of the optional service attributes is not instantiated.

See Also:

Constant Field Values

ATTR_VAL_NOT_FOUND

public static final int ATTR_VAL_NOT_FOUND

Target attribute is not instantiated in Novell eDirectory.

See Also:

Constant Field Values

BETA_EXPIRED

public static final int BETA_EXPIRED

Product's BETA life has expired.

See Also:

Constant Field Values

BUFFER_LEN

public static final int BUFFER_LEN

Size of the buffer is not in a nominal range between minimum and maximum.

See Also:

Constant Field Values

CONFIG_NOT_SUPPORTED

public static final int CONFIG_NOT_SUPPORTED

No server to support the given override configuration is found.

See Also:

Constant Field Values

CONN_ACCESS_FAILURE

public static final int CONN_ACCESS_FAILURE

Access to server connection failed.

See Also:

Constant Field Values

CORRUPTED_PACKET_DATA

public static final int CORRUPTED_PACKET_DATA

Protocol data corrupted on the wire.

See Also:

Constant Field Values

CORRUPTED_STORE

public static final int CORRUPTED_STORE

SecretStore data on the server has been corrupted.

See Also:

Constant Field Values

CRYPTO_OP_FAILURE

public static final int CRYPTO_OP_FAILURE

Cryptographic operation failed.

See Also:

Constant Field Values

ENUM_BUFF_TOO_LONG

public static final int ENUM_BUFF_TOO_LONG

Size of the enumeration buffer exceeds the limit.

See Also:

Constant Field Values

ENUM_BUFF_TOO_SHORT

public static final int ENUM_BUFF_TOO_SHORT

Length of the Enumeration buffer too short.

See Also:

Constant Field Values

EP_ACCESS_DENIED

public static final int EP_ACCESS_DENIED

Enhanced protection password validation failed. Access to the secret denied!

See Also:

Constant Field Values

INCOMPATIBLE_VERSION

public static final int INCOMPATIBLE_VERSION

Client and server components are not of the compatible versions.

See Also:

Constant Field Values

INVALID_PARAM

public static final int INVALID_PARAM

API parameter is not initialized.

See Also:

Constant Field Values

INVALID_SECRET_ID

public static final int INVALID_SECRET_ID

Secret ID is not in the User Secret Store.

See Also:

Constant Field Values

INVALID_TARGET_OBJECT

public static final int INVALID_TARGET_OBJECT

Target eDirectory User object not found.

See Also:

Constant Field Values

MIGRATION_NEEDED

public static final int MIGRATION_NEEDED

Server has been upgraded and user SecretStore should be updated.

See Also:

Constant Field Values

MP_PWORD_INVALID

public static final int MP_PWORD_INVALID

Master password could not be verified to read or unlock the secrets.

See Also:

Constant Field Values

MP_PWORD_NOT_ALLOWED

public static final int MP_PWORD_NOT_ALLOWED

Ability to use master password has been disabled.

See Also:

Constant Field Values

MP_PWORD_NOT_SET

public static final int MP_PWORD_NOT_SET

Master password has not been set on the SecretStore.

See Also:

Constant Field Values

NDS_INTERNAL_FAILURE

public static final int NDS_INTERNAL_FAILURE

Some internal eDirectory services have not been available.

See Also:

Constant Field Values

NDS_PWORD_CHANGED

public static final int NDS_PWORD_CHANGED

User eDirectory password has been changed by the administrator.

See Also:

Constant Field Values

NDS_PWORD_INVALID

public static final int NDS_PWORD_INVALID

Typed in eDirectory password not valid.

See Also:

Constant Field Values

NEED_SECURE_CHANNEL

public static final int NEED_SECURE_CHANNEL

Connection to SecretStore needs to be over SSL.

See Also:

Constant Field Values

NICI_FAILURE

public static final int NICI_FAILURE

NICI operations have failed.

See Also:

Constant Field Values

NICI_OUTOF_SYNC

public static final int NICI_OUTOF_SYNC

Session keys of the client and server NICI are out of sync.

See Also:

Constant Field Values

NOT_AUTHENTICATED

public static final int NOT_AUTHENTICATED

User not authenticated.

See Also:

Constant Field Values

NOT_IMPLEMENTED

public static final int NOT_IMPLEMENTED

Feature not implemented yet.

See Also:

Constant Field Values

NOT_SUPPORTED

public static final int NOT_SUPPORTED

Not supported operations.

See Also:

Constant Field Values

OBJECT_NOT_FOUND

public static final int OBJECT_NOT_FOUND

Can't find the target object DN in eDirectory.

See Also:

Constant Field Values

SCHEMA_NOT_EXTENDED

public static final int SCHEMA_NOT_EXTENDED

Schema is not extended to support SecreStore on the target tree.

See Also:

Constant Field Values

SECRET_BUFF_TOO_LONG

public static final int SECRET_BUFF_TOO_LONG

Size of the Secret buffer exceeds the limit.

See Also:

Constant Field Values

SECRET_ID_EXISTS

public static final int SECRET_ID_EXISTS

Secret ID already exists in the Secret Store.

See Also:

Constant Field Values

SECRET_ID_TOO_LONG

public static final int SECRET_ID_TOO_LONG

Length of the Secret ID buffer exceeds the limit.

See Also:

Constant Field Values

SECRET_ID_TOO_SHORT

public static final int SECRET_ID_TOO_SHORT

Length of the Secret ID should be greater than zero.

See Also:

Constant Field Values

SECRET_UNINITIALIZED

public static final int SECRET_UNINITIALIZED

Secret has not been initialized with a write.

See Also:

Constant Field Values

SERVER_CONN_FAILURE

public static final int SERVER_CONN_FAILURE

Opening a connection to the server failed.

See Also:

Constant Field Values

SERVICE_NOT_FOUND

public static final int SERVICE_NOT_FOUND

SecretStore not on the Network.

See Also:

Constant Field Values

SERVICE_NOT_SUPPORTED

public static final int SERVICE_NOT_SUPPORTED

Requested service not supported yet.

See Also:

Constant Field Values

STORE_NOT_FOUND

public static final int STORE_NOT_FOUND

Target eDirectory User object does not have a SecretStore.

See Also:

Constant Field Values

STORE_NOT_LOCKED

public static final int STORE_NOT_LOCKED

Attempt to unlock SecretStore failed because the store is not locked.

See Also:

Constant Field Values

SYSTEM_FAILURE

public static final int SYSTEM_FAILURE

Some internal operating system services have not been available.

See Also:

Constant Field Values

TOKEN_NOT_SUPPORTED

public static final int TOKEN_NOT_SUPPORTED

NDS authentication type not supported.

See Also:

Constant Field Values

TRANSPORT_FAILURE

public static final int TRANSPORT_FAILURE

Connection to server is lost.

See Also:

Constant Field Values

UNICODE_OP_FAILURE

public static final int UNICODE_OP_FAILURE

Unicode text conversion operation failed.

See Also:

Constant Field Values

WRONG_REPLICA_TYPE

public static final int WRONG_REPLICA_TYPE

Not a writeable replica of eDirectory.

See Also:

Constant Field Values

Constructor Detail

SecretStoreException

public SecretStoreException(java.lang.String message)

Constructs a SecretStoreException object.

Parameters:

message - A description of the exception.

SecretStoreException

public SecretStoreException(java.lang.String message,
                            int errorCode)

Constructs a SecretStoreException object and sets the error description and error code.

Parameters:

message - A description of the exception.

errorCode - An error code returned by the server.

SecretStoreException

public SecretStoreException(java.lang.String message,
                            java.lang.Throwable rootCause)

Constructs a SecretStoreException object and sets the cause of exception and error description.

Parameters:

message - A description of the exception.

rootCause - The underlying exception object.

SecretStoreException

public SecretStoreException(java.lang.String message,
                            java.lang.Throwable rootCause,
                            int errorCode)

Constructs a SecretStoreException object and sets the cause of exception, error code and error description.

Parameters:

message - A description of the exception.

rootCause - The underlying exception object.

errorCode - An error code returned by the server.

Method Detail

getErrorCode

public int getErrorCode()

Returns the error code returned by the server or local error code.

Returns:

int The error code.