org.opends.server.types
Class DirectoryException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.opends.server.types.OpenDsException
              extended by org.opends.server.types.IdentifiedException
                  extended by org.opends.server.types.DirectoryException
All Implemented Interfaces:
java.io.Serializable

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class DirectoryException
extends IdentifiedException

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

See Also:
Serialized Form

Constructor Summary
DirectoryException(ResultCode resultCode, Message errorMessage)
          Creates a new directory exception with the provided information.
DirectoryException(ResultCode resultCode, Message errorMessage, DN matchedDN, java.util.List<java.lang.String> referralURLs, java.lang.Throwable cause)
          Creates a new directory exception with the provided information.
DirectoryException(ResultCode resultCode, Message errorMessage, DN matchedDN, java.lang.Throwable cause)
          Creates a new directory exception with the provided information.
DirectoryException(ResultCode resultCode, Message errorMessage, java.lang.Throwable cause)
          Creates a new directory exception with the provided information.
DirectoryException(ResultCode resultCode, OpenDsException cause)
          Creates a new directory exception with the provided information.
 
Method Summary
 DN getMatchedDN()
          Retrieves the matched DN for this directory exception.
 java.util.List<java.lang.String> getReferralURLs()
          Retrieves the set of referral URLs for this directory exception.
 ResultCode getResultCode()
          Retrieves the result code for this directory exception.
 
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

DirectoryException

public DirectoryException(ResultCode resultCode,
                          Message errorMessage)
Creates a new directory exception with the provided information.

Parameters:
resultCode - The result code for this directory exception.
errorMessage - The error message for this directory exception.

DirectoryException

public DirectoryException(ResultCode resultCode,
                          Message errorMessage,
                          java.lang.Throwable cause)
Creates a new directory exception with the provided information.

Parameters:
resultCode - The result code for this directory exception.
errorMessage - The error message for this directory exception.
cause - The exception that was caught to trigger this directory exception.

DirectoryException

public DirectoryException(ResultCode resultCode,
                          OpenDsException cause)
Creates a new directory exception with the provided information.

Parameters:
resultCode - The result code for this directory exception.
cause - The exception that was caught to trigger this directory exception. The message of this exception will be set to that of this parameter.

DirectoryException

public DirectoryException(ResultCode resultCode,
                          Message errorMessage,
                          DN matchedDN,
                          java.lang.Throwable cause)
Creates a new directory exception with the provided information.

Parameters:
resultCode - The result code for this directory exception.
errorMessage - The error message for this directory exception.
matchedDN - The matched DN for this directory exception.
cause - The exception that was caught to trigger this directory exception.

DirectoryException

public DirectoryException(ResultCode resultCode,
                          Message errorMessage,
                          DN matchedDN,
                          java.util.List<java.lang.String> referralURLs,
                          java.lang.Throwable cause)
Creates a new directory exception with the provided information.

Parameters:
resultCode - The result code for this directory exception.
errorMessage - The error message for this directory
matchedDN - The matched DN for this directory exception.
referralURLs - The set of referral URLs for this directory exception.
cause - The exception that was caught to trigger this directory exception.
Method Detail

getResultCode

public ResultCode getResultCode()
Retrieves the result code for this directory exception.

Returns:
The result code for this directory exception.

getMatchedDN

public DN getMatchedDN()
Retrieves the matched DN for this directory exception.

Returns:
The matched DN for this directory exception, or null if there is none.

getReferralURLs

public java.util.List<java.lang.String> getReferralURLs()
Retrieves the set of referral URLs for this directory exception.

Returns:
The set of referral URLs for this directory exception, or null if there are none.