com.isode.dsapi
Class IndicationException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.isode.dsapi.DSAPIException
              com.isode.dsapi.IndicationException

All Implemented Interfaces:

SWIG_DSAPIConstants, Serializable

Direct Known Subclasses:

IncompleteReadException, NoSuchEntryException, ReferralException, UnavailableCriticalExtensionException

public class IndicationException
extends DSAPIException

Represents an error that is derived from a DS_Indication in the underlying DSAPI code. In addition to the nativeErrorCode common to all DSAPIExceptions, an IndicationExeception contains two other fields which describe the error in more detail: errorType and errorValue. These fields are maintained as numeric values, which will be set to values defined in the SWIG_DSAPI class, but convenience methods are available to return String representations of them.

Author:

nh

See Also:

Constant values, Serialized Form

Field Summary

protected Indication

ind

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_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_PASSWORDPOLICY, DS_SVC_PRIORITY, DS_SVC_SIZELIMIT, DS_SVC_TIMELIMIT, DSActionAbort, DSActionContinue, DSAPI_VERSION, DSConnectionAnonymous, DSConnectionBound, DSConnectionLost, DSConnectionSasl, DSConnectionSimple, DSConnectionStrong, DSEntryAdd, DSEntryDelete, DSEntryModify, DSEntryNormal, DSEntryRename, DSLimitAdminLimitExceeded, DSLimitNoProblem, DSLimitSizeExceeded, DSLimitTimeExceeded, DSModAdd, DSModDelete, DSModReplace, DSNotYetConnected, DSScopeBaseObject, DSScopeOneLevel, DSScopeSubtree, DSUnbound, DSVerificationFailed, JAVADSAPI_VERSION

Constructor Summary

protected	IndicationException(Indication ind, int nativeErrorCode) This constructor is used by JNI and subclasses to create a new object that refers to an Indication object.
protected	IndicationException(String message) Constructor provided to let subclasses instantiate themselves without needing a native Indication object

Method Summary

DN	getDN() Return the DN which was involved in the failing operation (if known)
int	getErrorType() Determine the error type associated with this IndicationException.
static String	getErrorTypeString(int errorType) Return a user-friendly String representation of the errorType for this exception.
int	getErrorValue() Determine the error value associated with this IndicationException.
static String	getErrorValueString(int errorValue) Return a user-friendly String representation of the errorValue for this exception.
Indication	getIndication() Returns the Indication object that is associated with this exception, if one exists.
String	getMessage() Returns a String containing information about the operation which caused the exception, the DN if available, and details of the indication error type and value.
String	getOperation() Returns a String containing information about the operation which resulted in the exception being thrown.
String	toString() Returns a String representation of this exception, containing information about the failing operation, and DN if available.

Methods inherited from class com.isode.dsapi.DSAPIException

getNativeErrorCode, getNativeErrorString, nativeErrorToString

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

ind

protected Indication ind

Constructor Detail

IndicationException

protected IndicationException(Indication ind,
                              int nativeErrorCode)

This constructor is used by JNI and subclasses to create a new object that refers to an Indication object.

Parameters:

ind - the Indication which provoked the exception

nativeErrorCode - the error status returned by the DSAPI layer (which may be zero)

IndicationException

protected IndicationException(String message)

Constructor provided to let subclasses instantiate themselves without needing a native Indication object

Parameters:

message - information about the reason for the exception

Method Detail

getErrorType

public int getErrorType()

Determine the error type associated with this IndicationException.

Returns:

Returns the errorType.

getErrorValue

public int getErrorValue()

Determine the error value associated with this IndicationException.

Returns:

Returns the errorValue.

getIndication

public Indication getIndication()

Returns the Indication object that is associated with this exception, if one exists. There will only be an Indication object associated with an IndicationException if the exception was thrown by native code.

Returns:

an Indication object associated with this exception, or null if none exists.

getOperation

public String getOperation()

Returns a String containing information about the operation which resulted in the exception being thrown.

Returns:

a String such as "Search", "Modify" etc.

getDN

public DN getDN()

Return the DN which was involved in the failing operation (if known)

Returns:

a DN - which may be null if none is known.

toString

public String toString()

Returns a String representation of this exception, containing information about the failing operation, and DN if available.

Overrides:

toString in class Throwable

Returns:

a user-friendly String representation of this exception.

getMessage

public String getMessage()

Returns a String containing information about the operation which caused the exception, the DN if available, and details of the indication error type and value.

Overrides:

getMessage in class Throwable

Returns:

a String containing details about the exception

getErrorTypeString

public static String getErrorTypeString(int errorType)

Return a user-friendly String representation of the errorType for this exception.

Parameters:

errorType - a numeric error type

Returns:

a String representation of errorType

See Also:

Indication.getErrorType()

getErrorValueString

public static String getErrorValueString(int errorValue)

Return a user-friendly String representation of the errorValue for this exception.

Parameters:

errorValue - a numeric error value

Returns:

a String representation of errorValue

See Also:

Indication.getErrorValue()