|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
com.unboundid.util.LDAPSDKRuntimeException
com.unboundid.ldap.sdk.LDAPRuntimeException
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDAPRuntimeException
This class defines a version of the LDAPException
class that may be
thrown as a RuntimeException
without the need for it to have been
explicitly declared in the method's throws list.
Constructor Summary | |
---|---|
LDAPRuntimeException(LDAPException ldapException)
Creates a new instance of this LDAPRuntimeException using the
provided LDAPException . |
Method Summary | |
---|---|
java.lang.String |
getDiagnosticMessage()
Retrieves the diagnostic message returned by the directory server. |
java.lang.String |
getExceptionMessage()
Retrieves a string representation of this exception suitable for use in messages. |
LDAPException |
getLDAPException()
Retrieves the LDAPException object wrapped by this runtime
exception. |
java.lang.String |
getMatchedDN()
Retrieves the matched DN for this LDAP exception. |
java.lang.String[] |
getReferralURLs()
Retrieves the set of referral URLs for this LDAP exception. |
Control |
getResponseControl(java.lang.String oid)
Retrieves the response control with the specified OID. |
Control[] |
getResponseControls()
Retrieves the set of response controls for this LDAP exception. |
ResultCode |
getResultCode()
Retrieves the result code for this LDAP exception. |
boolean |
hasResponseControl()
Indicates whether this result contains at least one control. |
boolean |
hasResponseControl(java.lang.String oid)
Indicates whether this result contains at least one control with the specified OID. |
void |
throwLDAPException()
Throws the wrapped LDAPException object. |
LDAPResult |
toLDAPResult()
Creates a new LDAPResult object from this exception. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this exception to the provided buffer. |
Methods inherited from class com.unboundid.util.LDAPSDKRuntimeException |
---|
toString |
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 |
---|
public LDAPRuntimeException(LDAPException ldapException)
LDAPRuntimeException
using the
provided LDAPException
.
ldapException
- The LDAPException
object wrapped by this
runtime exception.Method Detail |
---|
public LDAPException getLDAPException()
LDAPException
object wrapped by this runtime
exception.
LDAPException
object wrapped by this runtime
exception.public void throwLDAPException() throws LDAPException
LDAPException
object.
LDAPException
- The wrapped LDAPException
object.public ResultCode getResultCode()
public java.lang.String getMatchedDN()
null
if there
is none.public java.lang.String getDiagnosticMessage()
null
if there is none.public java.lang.String[] getReferralURLs()
public boolean hasResponseControl()
true
if this result contains at least one control, or
false
if not.public boolean hasResponseControl(java.lang.String oid)
oid
- The object identifier for which to make the determination. It
must not be null
.
true
if this result contains at least one control with
the specified OID, or false
if not.public Control[] getResponseControls()
public Control getResponseControl(java.lang.String oid)
oid
- The OID of the control to retrieve.
null
if
there is no such control.public LDAPResult toLDAPResult()
LDAPResult
object from this exception.
LDAPResult
object created from this exception.public void toString(java.lang.StringBuilder buffer)
toString
in class LDAPSDKRuntimeException
buffer
- The buffer to which the string representation of this
exception is to be appended.public java.lang.String getExceptionMessage()
getExceptionMessage
in class LDAPSDKRuntimeException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |