Package com.isode.dsapi

Class DSAPIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.isode.dsapi.DSAPIException

All Implemented Interfaces:

SWIG_DSAPIConstants, java.io.Serializable

Direct Known Subclasses:

BadAddressException, BadAttributeTypeException, BadDNException, BadEntryException, BadFilterException, BadSyntaxException, BadValueException, DeleteAttributeException, DirectoryOperationFailedException, IndicationException, NoMorePagedResultsException, NoSuchAttributeException, NoSuchOperationException, NotBoundException, NotImplementedException, OperationFailedException, SignedOpFailedException

public class DSAPIException
extends java.lang.Exception
implements SWIG_DSAPIConstants

Base class representing exception conditions that can be thrown by Java DSAPI classes.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.isode.dsapi.SWIG_DSAPIConstants

DS_BOOL_TYPE, DS_BYTES_TYPE, DS_E_AB_CANNOTABANDON, DS_E_AB_NOSUCHOPERATION, DS_E_AB_TOOLATE, DS_E_ABANDONED, DS_E_ABANDONFAILED, DS_E_ABORTED, DS_E_AT_CONSTRAINTVIOLATION, DS_E_AT_INAPPROPRIATEMATCHING, DS_E_AT_INVALIDATTRIBUTESYNTAX, DS_E_AT_NOSUCHATTRIBUTE, DS_E_AT_TYPEORVALUEEXISTS, DS_E_AT_UNDEFINEDATTRIBUTETYPE, DS_E_ATTRIBUTE, DS_E_BADADDR, DS_E_BADATTRSYNTAX, DS_E_BADATTRTYPE, DS_E_BADATTRVALUE, DS_E_BADDN, DS_E_BADENTRY, DS_E_BADFILTER, DS_E_BADPARAM, DS_E_CONNECTIONLOST, DS_E_DSAREFERRAL, DS_E_DSOPFAILED, DS_E_INTERNAL, DS_E_LOCAL, DS_E_NAME, DS_E_NAME_ALIASDEREFERENCE, DS_E_NAME_ALIASPROBLEM, DS_E_NAME_INVALIDATTRIBUTESYNTAX, DS_E_NAME_NOSUCHOBJECT, DS_E_NOERROR, DS_E_NOINFO, DS_E_NOMEMORY, DS_E_NOSPACE, DS_E_NOTBOUND, DS_E_NOTFOUND, DS_E_NOTIMPLEMENTED, DS_E_OPFAILED, DS_E_REFERRAL, DS_E_REMOTE, DS_E_SEC_ACCESSRIGHTS, DS_E_SEC_AUTHENTICATION, DS_E_SEC_INVALIDCREDENTIALS, DS_E_SEC_INVALIDSIGNATURE, DS_E_SEC_NOINFORMATION, DS_E_SEC_PROTECTIONREQUIRED, DS_E_SECURITY, DS_E_SERVICE, DS_E_SIGNEDOPFAILED, DS_E_SUCCESS, DS_E_SVC_ADMINISTRATIVELIMITEXCEEDED, DS_E_SVC_BUSY, DS_E_SVC_CHAININGREQUIRED, DS_E_SVC_DITERROR, DS_E_SVC_INVALIDQUERYREFERENCE, DS_E_SVC_INVALIDREFERENCE, DS_E_SVC_LOOPDETECTED, DS_E_SVC_OUTOFSCOPE, DS_E_SVC_TIMELIMITEXCEEDED, DS_E_SVC_UNABLETOPROCEED, DS_E_SVC_UNAVAILABLE, DS_E_SVC_UNAVAILABLECRITICALEXTENSION, DS_E_SVC_UNWILLINGTOPERFORM, DS_E_UNKNOWN, DS_E_UPD_AFFECTSMULTIPLEDSAS, DS_E_UPD_ALREADYEXISTS, DS_E_UPD_NAMINGVIOLATION, DS_E_UPD_NOOBJECTCLASSMODS, DS_E_UPD_NOTONNONLEAF, DS_E_UPD_NOTONRDN, DS_E_UPD_OBJECTCLASSVIOLATION, DS_E_UPDATE, DS_E_X509, DS_E_X509_RESULTSDISCARDED, DS_EXT_OPT_MANAGEDSAIT, DS_EXT_OPT_USEALIASONUPDATE, DS_INT_TYPE, DS_PARAM_TYPE_MASK, DS_PP_ACCOUNT_LOCKED, DS_PP_CHANGE_AFTER_RESET, DS_PP_INSUFFICIENT_PASSWORD_QUALITY, DS_PP_MUST_SUPPLY_OLD_PASSWORD, DS_PP_NO_ERROR, DS_PP_PASSWORD_EXPIRED, DS_PP_PASSWORD_IN_HISTORY, DS_PP_PASSWORD_MOD_NOT_ALLOWED, DS_PP_PASSWORD_TOO_SHORT, DS_PP_PASSWORD_TOO_YOUNG, DS_SASL_BEST_SSF, DS_SEC_DISABLEVERIFICATION, DS_SEC_ENCRYPTED, DS_SEC_SIGNED, DS_STR_TYPE, DS_SVC_OPT_ATTRSONLY, DS_SVC_OPT_CHAININGPROHIBIT, DS_SVC_OPT_COPYSHALLDO, DS_SVC_OPT_DONTDEREFALIAS, DS_SVC_OPT_DONTUSECOPY, DS_SVC_OPT_LOCALSCOPE, DS_SVC_OPT_PAGESIZE, DS_SVC_OPT_PREFERCHAIN, DS_SVC_OPT_SEARCHALIASES, DS_SVC_OPT_SUBENTRIES, DS_SVC_OPT_TXNID, DS_SVC_PASSWORDPOLICY, DS_SVC_PRIORITY, DS_SVC_SIZELIMIT, DS_SVC_TIMELIMIT, DSActionAbort, DSActionContinue, DSAnonymous, DSAPI_VERSION, DSConnectionAnonymous, DSConnectionBound, DSConnectionLost, DSConnectionSasl, DSConnectionSimple, DSConnectionStrong, DSEntryAdd, DSEntryDelete, DSEntryModify, DSEntryNormal, DSEntryRename, DSLimitAdminLimitExceeded, DSLimitNoProblem, DSLimitSizeExceeded, DSLimitTimeExceeded, DSModAdd, DSModDelete, DSModReplace, DSNotYetConnected, DSSASL, DSScopeBaseObject, DSScopeOneLevel, DSScopeSubtree, DSSimple, DSStrong, DSUnbound, DSVerificationFailed, JAVADSAPI_VERSION

Constructor Summary

Constructors

Constructor	Description
DSAPIException(java.lang.String message)	Constructs a new DSAPIException with the specified message.
DSAPIException(java.lang.String message, int nativeErrorCode)	Constructs a new DSAPIException with the specified message and error code
DSAPIException(java.lang.String message, java.lang.Throwable cause)	Constructs a new DSAPIException with the specified message and cause.

Method Summary

Modifier and Type	Method	Description
int	getNativeErrorCode()	Determine the native error code (if any) associated with this exception.
java.lang.String	getNativeErrorString()	Return the name of a native error code in String format, for example "DS_E_BADDN".
static java.lang.String	nativeErrorToString(int ds_status_code)	Translate native DS_Status error code value into a String, for example "DS_E_BADDN".

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DSAPIException

public DSAPIException(java.lang.String message,
                      int nativeErrorCode)

Constructs a new DSAPIException with the specified message and error code

Parameters:

message - gives extra detail about the specific exception.

nativeErrorCode - a value as returned from underlying native code which may be useful in determining the cause of the problem.

DSAPIException

public DSAPIException(java.lang.String message)

Constructs a new DSAPIException with the specified message.

Parameters:

message - gives extra detail about the specific exception.

DSAPIException

public DSAPIException(java.lang.String message,
                      java.lang.Throwable cause)

Constructs a new DSAPIException with the specified message and cause.

Parameters:

message - gives extra detail about the specific exception.

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Since:

15.0

Method Detail

getNativeErrorCode

public int getNativeErrorCode()

Determine the native error code (if any) associated with this exception.

Returns:

the native error code, which will be zero if no code is associated with this exception.

getNativeErrorString

public java.lang.String getNativeErrorString()

Return the name of a native error code in String format, for example "DS_E_BADDN".

Returns:

a String containing the symbolic name of the error code.

See Also:

nativeErrorToString(int)

nativeErrorToString

public static java.lang.String nativeErrorToString(int ds_status_code)

Translate native DS_Status error code value into a String, for example "DS_E_BADDN".

The native layer will typically not throw "DSAPIException" objects, but an exception appropriate to the error type, e.g. BadDNException. Therefore, the Strings returned by this method are primarily of interest for debugging purposes, rather than intended for displaying to a user of an application.

Parameters:

ds_status_code - a DSAPI error code, which should be one of the DS_Status constants

Returns:

a String containing the symbolic name of the error code. In the case of an unknown error, a String of the form "unknown DS_Status (x)" will be returned.