Package org.ldaptive
Class LdapException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- org.ldaptive.LdapException
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
ConnectException
,FilterParseException
,PoolException
,SchemaParseException
public class LdapException extends java.lang.Exception
Base exception for all ldap related exceptions.- Author:
- Middleware Services
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LdapException(java.lang.String msg)
Creates a new ldap exception.LdapException(java.lang.String msg, java.lang.Throwable e)
Creates a new ldap exception.LdapException(java.lang.Throwable e)
Creates a new ldap exception.LdapException(Result result)
Creates a new ldap exception based on the supplied result.LdapException(ResultCode code, java.lang.String msg)
Creates a new ldap exception.LdapException(ResultCode code, java.lang.String msg, java.lang.Throwable e)
Creates a new ldap exception.LdapException(ResultCode code, java.lang.Throwable e)
Creates a new ldap exception.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static java.lang.String
formatResult(Result result)
Formats the supplied result for use as an exception message.ResultCode
getResultCode()
Returns the result code.
-
-
-
Constructor Detail
-
LdapException
public LdapException(Result result)
Creates a new ldap exception based on the supplied result.- Parameters:
result
- that produced this exception
-
LdapException
public LdapException(java.lang.String msg)
Creates a new ldap exception.- Parameters:
msg
- describing this exception
-
LdapException
public LdapException(ResultCode code, java.lang.String msg)
Creates a new ldap exception.- Parameters:
code
- result code describing this exceptionmsg
- describing this exception
-
LdapException
public LdapException(java.lang.Throwable e)
Creates a new ldap exception.- Parameters:
e
- underlying exception
-
LdapException
public LdapException(ResultCode code, java.lang.Throwable e)
Creates a new ldap exception.- Parameters:
code
- result code describing this exceptione
- underlying exception
-
LdapException
public LdapException(java.lang.String msg, java.lang.Throwable e)
Creates a new ldap exception.- Parameters:
msg
- describing this exceptione
- underlying exception
-
LdapException
public LdapException(ResultCode code, java.lang.String msg, java.lang.Throwable e)
Creates a new ldap exception.- Parameters:
code
- result code describing this exceptionmsg
- describing this exceptione
- underlying exception
-
-
Method Detail
-
getResultCode
public ResultCode getResultCode()
Returns the result code.- Returns:
- result code or null
-
formatResult
protected static java.lang.String formatResult(Result result)
Formats the supplied result for use as an exception message.- Parameters:
result
- to format- Returns:
- formatted result
-
-