SecretStore 3.2 Developer Kit for Java: Class SSException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.novell.security.sso
Class SSException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--com.novell.security.sso.SSException

All Implemented Interfaces:: Serializable

public class SSException
extends RuntimeException

Exception class used to indicate that an error concerning SecretStore has occurred. The getErrorCode method may be used to determine which SecretStore error occurred.

This class is the class for Exceptions that concern SecretStore. In order to provide a common interface for handling exceptions that may occur in different SecretStore implementations this class contains a root exception. The root exception contains the exception the SecretStore implementation must handle. For example, the JNDISecretStore must handle exceptions of type NamingException. When an exception of this type occurs, the JNDISecretStore class creates an object of this class and sets the root exception to be the NamingException that was origionally thrown. The error code is set to 0. This new SSException object is then thrown back to the application.

Since:: 2.1
Version:: 3.2
Author:: Steve Kinser
See Also:: Serialized Form

Field Summary

static short NSSO_E_ACCESS_DENIED
          Deprecated. Use NSSS_E_ACCESS_DENIED

static short NSSO_E_ATTR_NOT_FOUND
          Deprecated. Use NSSS_E_ATTR_NOT_FOUND

static short NSSO_E_ATTR_VAL_NOT_FOUND
          Deprecated. Use NSSS_E_ATTR_VAL_NOT_FOUND

static short NSSO_E_BETA_EXPIRED
          Deprecated. Use NSSS_E_BETA_EXPIRED

static short NSSO_E_BUFFER_LEN
          Deprecated. Use NSSS_E_BUFFER_LEN

static short NSSO_E_CONFIG_NOT_SUPPORTED
          Deprecated. Use NSSS_E_CONFIG_NOT_SUPPORTED

static short NSSO_E_CONN_ACCESS_FAILURE
          Deprecated. Use NSSS_E_CONN_ACCESS_FAILURE

static short NSSO_E_CORRUPTED_PACKET_DATA
          Deprecated. Use NSSS_E_CORRUPTED_PACKET_DATA

static short NSSO_E_CORRUPTED_STORE
          Deprecated. Use NSSS_E_CORRUPTED_STORE

static short NSSO_E_CRYPTO_OP_FAILURE
          Deprecated. Use NSSS_E_CRYPTO_OP_FAILURE

static short NSSO_E_DN_TOO_LONG
          Deprecated. Use NSSS_E_OBJECT_NOT_FOUND

static short NSSO_E_ENUM_BUFF_TOO_LONG
          Deprecated. Use NSSS_E_ENUM_BUFF_TOO_LONG

static short NSSO_E_ENUM_BUFF_TOO_SHORT
          Deprecated. Use NSSS_E_ENUM_BUFF_TOO_SHORT

static short NSSO_E_EP_ACCESS_DENIED
          Deprecated. Use NSSS_E_EP_ACCESS_DENIED

static short NSSO_E_INCOMPATIBLE_VERSION
          Deprecated. Use NSSS_E_INCOMPATIBLE_VERSION

static short NSSO_E_INVALID_PARAM
          Deprecated. Use NSSS_E_INVALID_PARAM

static short NSSO_E_INVALID_SECRET_ID
          Deprecated. Use NSSS_E_INVALID_SECRET_ID

static short NSSO_E_INVALID_TARGET_OBJECT
          Deprecated. Use NSSS_E_INVALID_TARGET_OBJECT

static short NSSO_E_MIGRATION_NEEDED
          Deprecated. Use NSSS_E_MIGRATION_NEEDED

static short NSSO_E_MP_PWORD_INVALID
          Deprecated. Use NSSS_E_MP_PWORD_INVALID

static short NSSO_E_MP_PWORD_NOT_ALLOWED
          Deprecated. Use NSSS_E_MP_PWORD_NOT_ALLOWED

static short NSSO_E_MP_PWORD_NOT_SET
          Deprecated. Use NSSS_E_MP_PWORD_NOT_SET

static short NSSO_E_NDS_INTERNAL_FAILURE
          Deprecated. Use NSSS_E_NDS_INTERNAL_FAILURE

static short NSSO_E_NDS_PWORD_CHANGED
          Deprecated. Use NSSS_E_NDS_PWORD_CHANGED

static short NSSO_E_NDS_PWORD_INVALID
          Deprecated. Use NSSS_E_NDS_PWORD_INVALID

static short NSSO_E_NEED_SECURE_CHANNEL
          Deprecated. Use NSSS_E_NEED_SECURE_CHANNEL

static short NSSO_E_NICI_FAILURE
          Deprecated. Use NSSS_E_NICI_FAILURE

static short NSSO_E_NICI_OUTOF_SYNC
          Deprecated. Use NSSS_E_NICI_OUTOF_SYNC

static short NSSO_E_NOT_AUTHENTICATED
          Deprecated. Use NSSS_E_NOT_AUTHENTICATED

static short NSSO_E_NOT_IMPLEMENTED
          Deprecated. Use NSSS_E_NOT_IMPLEMENTED

static short NSSO_E_NOT_SUPPORTED
          Deprecated. Use NSSS_E_NOT_SUPPORTED

static short NSSO_E_OBJECT_NOT_FOUND
          Deprecated. Use NSSS_E_OBJECT_NOT_FOUND

static short NSSO_E_SCHEMA_NOT_EXTENDED
          Deprecated. Use NSSS_E_SCHEMA_NOT_EXTENDED

static short NSSO_E_SECRET_BUFF_TOO_LONG
          Deprecated. Use NSSS_E_SECRET_BUFF_TOO_LONG

static short NSSO_E_SECRET_ID_EXISTS
          Deprecated. Use NSSS_E_SECRET_ID_EXISTS

static short NSSO_E_SECRET_ID_TOO_LONG
          Deprecated. Use NSSS_E_SECRET_ID_TOO_LONG

static short NSSO_E_SECRET_ID_TOO_SHORT
          Deprecated. Use NSSS_E_SECRET_ID_TOO_SHORT

static short NSSO_E_SECRET_UNINITIALIZED
          Deprecated. Use NSSS_E_SECRET_UNINITIALIZED

static short NSSO_E_SERVER_CONN_FAILURE
          Deprecated. Use NSSS_E_SERVER_CONN_FAILURE

static short NSSO_E_SERVICE_NOT_FOUND
          Deprecated. Use NSSS_E_SERVICE_NOT_FOUND

static short NSSO_E_SERVICE_NOT_SUPPORTED
          Deprecated. Use NSSS_E_SERVICE_NOT_SUPPORTED

static short NSSO_E_STORE_NOT_FOUND
          Deprecated. Use NSSS_E_STORE_NOT_FOUND

static short NSSO_E_STORE_NOT_LOCKED
          Deprecated. Use NSSS_E_STORE_NOT_LOCKED

static short NSSO_E_SYSTEM_FAILURE
          Deprecated. Use NSSS_E_SYSTEM_FAILURE

static short NSSO_E_TOKEN_NOT_SUPPORTED
          Deprecated. Use NSSS_E_TOKEN_NOT_SUPPORTED

static short NSSO_E_TRANSPORT_FAILURE
          Deprecated. Use NSSS_E_TRANSPORT_FAILURE

static short NSSO_E_UNICODE_OP_FAILURE
          Deprecated. Use NSSS_E_UNICODE_OP_FAILURE

static short NSSO_E_WRONG_REPLICA_TYPE
          Deprecated. Use NSSS_E_WRONG_REPLICA_TYPE

static short NSSS_E_ACCESS_DENIED
          Access to the target SecretStore has been denied.

static short NSSS_E_ATTR_NOT_FOUND
          One of the optional service attributes is not instantiated.

static short NSSS_E_ATTR_VAL_NOT_FOUND
          Target attribute is not instantiated in NDS.

static short NSSS_E_BETA_EXPIRED
          Product's BETA life has expired! Official release copy should be purchased.

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

static short NSSS_E_CONFIG_NOT_SUPPORTED
          No server to support the given override configuration is found.

static short NSSS_E_CONN_ACCESS_FAILURE
          Access to server connection failed.

static short NSSS_E_CORRUPTED_PACKET_DATA
          Protocol data corrupted on the wire.

static short NSSS_E_CORRUPTED_STORE
          SecretStore data on the server has been corrupted.

static short NSSS_E_CRYPTO_OP_FAILURE
          Cryptographic operation failed.

static short NSSS_E_CTX_LESS_CN_NOT_UNIQUE
          Contextless name for LDAP bind does not resolve to a unique DN.

static short NSSS_E_ENUM_BUFF_TOO_LONG
          Size of the enumeration buffer exceeds the limit.

static short NSSS_E_ENUM_BUFF_TOO_SHORT
          Length of the Enumeration buffer too short.

static short NSSS_E_EP_ACCESS_DENIED
          EP password validation failed.

static short NSSS_E_INCOMPATIBLE_VERSION
          Client and server components are not of the compatible versions.

static short NSSS_E_INVALID_PARAM
          API parameter is not initialized.

static short NSSS_E_INVALID_SECRET_ID
          Secret ID is not in the User Secret Store.

static short NSSS_E_INVALID_TARGET_OBJECT
          Target NDS User object not found.

static short NSSS_E_MIGRATION_NEEDED
          Server has been upgraded and user SecretStore should be updated.

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

static short NSSS_E_MP_PWORD_NOT_ALLOWED
          Ability to use master password has been disabled.

static short NSSS_E_MP_PWORD_NOT_SET
          Master password has not been set on the SecretStore.

static short NSSS_E_NDS_INTERNAL_FAILURE
          Some internal NDS services have not been available.

static short NSSS_E_NDS_PWORD_CHANGED
          User NDS password has been changed by the administrator.

static short NSSS_E_NDS_PWORD_INVALID
          Typed in NDS password not valid.

static short NSSS_E_NEED_SECURE_CHANNEL
          Connection to SecretStore needs to be over SSL.

static short NSSS_E_NICI_FAILURE
          NICI operations have failed.

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

static short NSSS_E_NOT_AUTHENTICATED
          User not authenticated.

static short NSSS_E_NOT_IMPLEMENTED
          Feature not implemented yet.

static short NSSS_E_NOT_SUPPORTED
          Not supported operations.

static short NSSS_E_OBJECT_NOT_FOUND
          Can't find the target object DN in NDS.

static short NSSS_E_PARSER_FAILURE
          Shared Secret parser operations failed.

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

static short NSSS_E_SECRET_BUFF_TOO_LONG
          Size of the Secret buffer exceeds the limit.

static short NSSS_E_SECRET_BUFF_TOO_SHORT
          Buffer supplied for the secret is too short.

static short NSSS_E_SECRET_ID_EXISTS
          Secret ID already exists in the Secret Store.

static short NSSS_E_SECRET_ID_TOO_LONG
          Length of the Secret ID buffer exceeds the limit.

static short NSSS_E_SECRET_ID_TOO_SHORT
          Length of the Secret ID should be greater than zero.

static short NSSS_E_SECRET_UNINITIALIZED
          Secret has not been initialized with a write.

static short NSSS_E_SERVER_CONN_FAILURE
          Opening a connection to the server failed.

static short NSSS_E_SERVICE_NOT_FOUND
          SecretStore not on the Network.

static short NSSS_E_SERVICE_NOT_SUPPORTED
          Requested service not supported yet.

static short NSSS_E_SH_SECRET_FAILURE
          Shared Secret processing and operations failed.

static short NSSS_E_STORE_NOT_FOUND
          Target NDS User object does not have a SecretStore.

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

static short NSSS_E_SYSTEM_FAILURE
          Some internal operating system services have not been available.

static short NSSS_E_TIME_OUT_OF_SYNC
          NDS Replica on the server that holds SecretStore is out of sync with the replica ring.

static short NSSS_E_TOKEN_NOT_SUPPORTED
          NDS authentication type not supported.

static short NSSS_E_TRANSPORT_FAILURE
          Connection to server is lost.

static short NSSS_E_UNICODE_OP_FAILURE
          Unicode text conversion operation failed.

static short NSSS_E_UTF8_OP_FAILURE
          Utf8 string operations failed.

static short NSSS_E_VERSION_MISMATCH
          Versions of the client dlls don't match.

static short NSSS_E_WRONG_REPLICA_TYPE
          Not a writeable replica of NDS.

Constructor Summary

SSException()
          Constructs an empty SSException object.

SSException(int errCode)
          Constructs a SSException according to the error code.

SSException(int errCode, String message)
          Generates a SSException with the specified message.

SSException(int errCode, Throwable root)
          Generates a SSException object that encapsulates the specified exception as its root.

SSException(Throwable root)
          Generates a SSException object that encapsulates the specified exception.

SSException(Throwable root, String message)
          Generates a SSException object that encapsulates the specified exception as its root.

Method Summary

static String generateMessage(int errCode)
          Returns the message associated with the error code.

int getErrorCode()
          Returns the error code.

String getLocalizedMessage()


Throwable getRoot()
          Returns the root exception of this object.

boolean hasRoot()
          Determines if this exception has a root exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getMessage, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

NSSS_E_OBJECT_NOT_FOUND

public static final short NSSS_E_OBJECT_NOT_FOUND

Can't find the target object DN in NDS.

Since:: 3.0

NSSS_E_NICI_FAILURE

public static final short NSSS_E_NICI_FAILURE

NICI operations have failed.

NSSS_E_INVALID_SECRET_ID

public static final short NSSS_E_INVALID_SECRET_ID

Secret ID is not in the User Secret Store.

NSSS_E_SYSTEM_FAILURE

public static final short NSSS_E_SYSTEM_FAILURE

Some internal operating system services have not been available.

NSSS_E_ACCESS_DENIED

public static final short NSSS_E_ACCESS_DENIED

Access to the target SecretStore has been denied.

NSSS_E_NDS_INTERNAL_FAILURE

public static final short NSSS_E_NDS_INTERNAL_FAILURE

Some internal NDS services have not been available.

NSSS_E_SECRET_UNINITIALIZED

public static final short NSSS_E_SECRET_UNINITIALIZED

Secret has not been initialized with a write.

NSSS_E_BUFFER_LEN

public static final short NSSS_E_BUFFER_LEN

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

NSSS_E_INCOMPATIBLE_VERSION

public static final short NSSS_E_INCOMPATIBLE_VERSION

Client and server components are not of the compatible versions.

NSSS_E_CORRUPTED_STORE

public static final short NSSS_E_CORRUPTED_STORE

SecretStore data on the server has been corrupted.

NSSS_E_SECRET_ID_EXISTS

public static final short NSSS_E_SECRET_ID_EXISTS

Secret ID already exists in the Secret Store.

NSSS_E_NDS_PWORD_CHANGED

public static final short NSSS_E_NDS_PWORD_CHANGED

User NDS password has been changed by the administrator.

NSSS_E_INVALID_TARGET_OBJECT

public static final short NSSS_E_INVALID_TARGET_OBJECT

Target NDS User object not found.

NSSS_E_STORE_NOT_FOUND

public static final short NSSS_E_STORE_NOT_FOUND

Target NDS User object does not have a SecretStore.

NSSS_E_SERVICE_NOT_FOUND

public static final short NSSS_E_SERVICE_NOT_FOUND

SecretStore not on the Network.

NSSS_E_SECRET_ID_TOO_LONG

public static final short NSSS_E_SECRET_ID_TOO_LONG

Length of the Secret ID buffer exceeds the limit.

NSSS_E_NOT_AUTHENTICATED

public static final short NSSS_E_NOT_AUTHENTICATED

User not authenticated.

NSSS_E_NOT_SUPPORTED

public static final short NSSS_E_NOT_SUPPORTED

Not supported operations.

NSSS_E_NDS_PWORD_INVALID

public static final short NSSS_E_NDS_PWORD_INVALID

Typed in NDS password not valid.

NSSS_E_ENUM_BUFF_TOO_SHORT

public static final short NSSS_E_ENUM_BUFF_TOO_SHORT

Length of the Enumeration buffer too short.

NSSS_E_NICI_OUTOF_SYNC

public static final short NSSS_E_NICI_OUTOF_SYNC

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

NSSS_E_SERVICE_NOT_SUPPORTED

public static final short NSSS_E_SERVICE_NOT_SUPPORTED

Requested service not supported yet.

NSSS_E_TOKEN_NOT_SUPPORTED

public static final short NSSS_E_TOKEN_NOT_SUPPORTED

NDS authentication type not supported.

NSSS_E_UNICODE_OP_FAILURE

public static final short NSSS_E_UNICODE_OP_FAILURE

Unicode text conversion operation failed.

NSSS_E_TRANSPORT_FAILURE

public static final short NSSS_E_TRANSPORT_FAILURE

Connection to server is lost.

NSSS_E_CRYPTO_OP_FAILURE

public static final short NSSS_E_CRYPTO_OP_FAILURE

Cryptographic operation failed.

NSSS_E_SERVER_CONN_FAILURE

public static final short NSSS_E_SERVER_CONN_FAILURE

Opening a connection to the server failed.

NSSS_E_CONN_ACCESS_FAILURE

public static final short NSSS_E_CONN_ACCESS_FAILURE

Access to server connection failed.

NSSS_E_ENUM_BUFF_TOO_LONG

public static final short NSSS_E_ENUM_BUFF_TOO_LONG

Size of the enumeration buffer exceeds the limit.

NSSS_E_SECRET_BUFF_TOO_LONG

public static final short NSSS_E_SECRET_BUFF_TOO_LONG

Size of the Secret buffer exceeds the limit.

NSSS_E_SECRET_ID_TOO_SHORT

public static final short NSSS_E_SECRET_ID_TOO_SHORT

Length of the Secret ID should be greater than zero.

NSSS_E_CORRUPTED_PACKET_DATA

public static final short NSSS_E_CORRUPTED_PACKET_DATA

Protocol data corrupted on the wire.

NSSS_E_EP_ACCESS_DENIED

public static final short NSSS_E_EP_ACCESS_DENIED

EP password validation failed. Access to the secret denied!

NSSS_E_SCHEMA_NOT_EXTENDED

public static final short NSSS_E_SCHEMA_NOT_EXTENDED

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

NSSS_E_ATTR_NOT_FOUND

public static final short NSSS_E_ATTR_NOT_FOUND

One of the optional service attributes is not instantiated.

NSSS_E_MIGRATION_NEEDED

public static final short NSSS_E_MIGRATION_NEEDED

Server has been upgraded and user SecretStore should be updated.

NSSS_E_MP_PWORD_INVALID

public static final short NSSS_E_MP_PWORD_INVALID

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

NSSS_E_MP_PWORD_NOT_SET

public static final short NSSS_E_MP_PWORD_NOT_SET

Master password has not been set on the SecretStore.

NSSS_E_MP_PWORD_NOT_ALLOWED

public static final short NSSS_E_MP_PWORD_NOT_ALLOWED

Ability to use master password has been disabled.

NSSS_E_WRONG_REPLICA_TYPE

public static final short NSSS_E_WRONG_REPLICA_TYPE

Not a writeable replica of NDS.

NSSS_E_ATTR_VAL_NOT_FOUND

public static final short NSSS_E_ATTR_VAL_NOT_FOUND

Target attribute is not instantiated in NDS.

Since:: 3.0

NSSS_E_INVALID_PARAM

public static final short NSSS_E_INVALID_PARAM

API parameter is not initialized.

Since:: 3.0

NSSS_E_NEED_SECURE_CHANNEL

public static final short NSSS_E_NEED_SECURE_CHANNEL

Connection to SecretStore needs to be over SSL.

Since:: 3.0

NSSS_E_CONFIG_NOT_SUPPORTED

public static final short NSSS_E_CONFIG_NOT_SUPPORTED

No server to support the given override configuration is found.

Since:: 3.02

NSSS_E_STORE_NOT_LOCKED

public static final short NSSS_E_STORE_NOT_LOCKED

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

Since:: 3.02

NSSS_E_TIME_OUT_OF_SYNC

public static final short NSSS_E_TIME_OUT_OF_SYNC

NDS Replica on the server that holds SecretStore is out of sync with the replica ring.

Since:: 3.2

NSSS_E_VERSION_MISMATCH

public static final short NSSS_E_VERSION_MISMATCH

Versions of the client dlls don't match.

Since:: 3.2

NSSS_E_SECRET_BUFF_TOO_SHORT

public static final short NSSS_E_SECRET_BUFF_TOO_SHORT

Buffer supplied for the secret is too short.

Since:: 3.2

NSSS_E_SH_SECRET_FAILURE

public static final short NSSS_E_SH_SECRET_FAILURE

Shared Secret processing and operations failed.

Since:: 3.2

NSSS_E_PARSER_FAILURE

public static final short NSSS_E_PARSER_FAILURE

Shared Secret parser operations failed.

Since:: 3.2

NSSS_E_UTF8_OP_FAILURE

public static final short NSSS_E_UTF8_OP_FAILURE

Utf8 string operations failed.

Since:: 3.2

NSSS_E_CTX_LESS_CN_NOT_UNIQUE

public static final short NSSS_E_CTX_LESS_CN_NOT_UNIQUE

Contextless name for LDAP bind does not resolve to a unique DN.

Since:: 3.2

NSSS_E_NOT_IMPLEMENTED

public static final short NSSS_E_NOT_IMPLEMENTED

Feature not implemented yet.

NSSS_E_BETA_EXPIRED

public static final short NSSS_E_BETA_EXPIRED

Product's BETA life has expired! Official release copy should be purchased.