org.opends.server.tools
Class ClientException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.opends.server.types.OpenDsException
              org.opends.server.types.IdentifiedException
                  org.opends.server.tools.ClientException

All Implemented Interfaces:

java.io.Serializable

public class ClientException
extends IdentifiedException

This class defines an exception that may be thrown if a local problem occurs in a Directory Server client.

See Also:

Serialized Form

Constructor Summary

ClientException(int exitCode, Message message)
Creates a new client exception with the provided message.

ClientException(int exitCode, Message message, java.lang.Throwable cause)
Creates a new client exception with the provided message and root cause.

Method Summary

int	getExitCode() Retrieves the exit code that the client may use if it considers this to be a fatal problem.

Methods inherited from class org.opends.server.types.OpenDsException

getMessageObject

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

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

Constructor Detail

ClientException

public ClientException(int exitCode,
                       Message message)

Creates a new client exception with the provided message.

Parameters:

exitCode - The exit code that may be used if the client considers this to be a fatal problem.

message - The message that explains the problem that occurred.

ClientException

public ClientException(int exitCode,
                       Message message,
                       java.lang.Throwable cause)

Creates a new client exception with the provided message and root cause.

Parameters:

exitCode - The exit code that may be used if the client considers this to be a fatal problem.

message - The message that explains the problem that occurred.

cause - The exception that was caught to trigger this exception.

Method Detail

getExitCode

public int getExitCode()

Retrieves the exit code that the client may use if it considers this to be a fatal problem.

Returns:

The exit code that the client may use if it considers this to be a fatal problem.