com.ibm.di.api.exceptions
Class AuthenticationException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.di.api.DIException
              com.ibm.di.api.exceptions.AuthenticationException

All Implemented Interfaces:

java.io.Serializable

public class AuthenticationException
extends DIException

An exception object thrown when the authentication of a user against a specific system fails.

See Also:

Serialized Form

Constructor Summary

AuthenticationException()
Default constructor of the exception that creates the exception with a predefined cause message.

AuthenticationException(java.lang.String aMessage, java.lang.String aErrorDescription, java.lang.Object aErrorCode)
This constructor creates an instance of this type with a specific error attributes.

Method Summary

java.lang.Integer	getErrorCode() Retrieves error code.
java.lang.String	getErrorDescription() Retrieves error description.
java.lang.String	toString() Converts the exception to string.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationException

public AuthenticationException()

Default constructor of the exception that creates the exception with a predefined cause message.

AuthenticationException

public AuthenticationException(java.lang.String aMessage,
                               java.lang.String aErrorDescription,
                               java.lang.Object aErrorCode)

This constructor creates an instance of this type with a specific error attributes.

Parameters:

aMessage - the custom cause message

aErrorDescription - the description of the occurred error.

aErrorCode - a numeric value used as an error code.

Method Detail

getErrorDescription

public java.lang.String getErrorDescription()

Retrieves error description.

Returns:

the description of the error the object was created with.

getErrorCode

public java.lang.Integer getErrorCode()

Retrieves error code.

Returns:

the code of the error the object was created with.

toString

public java.lang.String toString()

Converts the exception to string.

Overrides:

toString in class java.lang.Throwable

Returns:

the string representation of the thrown exception.