@PublicAPI(stability=UNCOMMITTED, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class DirectoryException extends IdentifiedException
Constructor and Description |
---|
DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode,
LocalizableMessage errorMessage)
Creates a new directory exception with the provided information.
|
DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode,
LocalizableMessage errorMessage,
DN matchedDN,
List<String> referralURLs,
Throwable cause)
Creates a new directory exception with the provided information.
|
DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode,
LocalizableMessage errorMessage,
DN matchedDN,
Throwable cause)
Creates a new directory exception with the provided information.
|
DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode,
LocalizableMessage errorMessage,
Throwable cause)
Creates a new directory exception with the provided information.
|
DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode,
OpenDsException cause)
Creates a new directory exception with the provided information.
|
Modifier and Type | Method and Description |
---|---|
LocalizableMessage |
getMaskedMessage()
Returns the real, masked message for this directory exception that cannot
be returned to the client, but will be logged.
|
org.forgerock.opendj.ldap.ResultCode |
getMaskedResultCode()
Returns the real result code for this directory exception that cannot be
returned to the client, but will be logged.
|
DN |
getMatchedDN()
Retrieves the matched DN for this directory exception.
|
List<String> |
getReferralURLs()
Retrieves the set of referral URLs for this directory exception.
|
org.forgerock.opendj.ldap.ResultCode |
getResultCode()
Retrieves the result code for this directory exception.
|
void |
setMaskedMessage(LocalizableMessage maskedMessage)
Sets the real message for this directory exception that cannot be returned
to the client, but will be logged.
|
void |
setMaskedResultCode(org.forgerock.opendj.ldap.ResultCode maskedResultCode)
Sets the real result code for this directory exception that cannot be
returned to the client, but will be logged.
|
getMessageObject
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
public DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode, LocalizableMessage errorMessage)
resultCode
- The result code for this directory
exception.errorMessage
- The error message for this directory
exception.public DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode, LocalizableMessage errorMessage, Throwable cause)
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.public DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode, OpenDsException cause)
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.public DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode, LocalizableMessage errorMessage, DN matchedDN, Throwable cause)
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.public DirectoryException(org.forgerock.opendj.ldap.ResultCode resultCode, LocalizableMessage errorMessage, DN matchedDN, List<String> referralURLs, Throwable cause)
resultCode
- The result code for this directory
exception.errorMessage
- The error message for this directorymatchedDN
- 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.public org.forgerock.opendj.ldap.ResultCode getResultCode()
public DN getMatchedDN()
null
if there is none.public List<String> getReferralURLs()
null
if there are none.public LocalizableMessage getMaskedMessage()
for the message returned to the client
public org.forgerock.opendj.ldap.ResultCode getMaskedResultCode()
for the result code returned to the client
public void setMaskedMessage(LocalizableMessage maskedMessage)
maskedMessage
- the real, masked message to setpublic void setMaskedResultCode(org.forgerock.opendj.ldap.ResultCode maskedResultCode)
maskedResultCode
- the real, masked result code to setCopyright © 2010-2015 ForgeRock AS. All Rights Reserved.