Package org.ldaptive

Class LdapException

    • 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.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, 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

      • 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 exception
        msg - 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 exception
        e - underlying exception
      • LdapException

        public LdapException​(java.lang.String msg,
                             java.lang.Throwable e)
        Creates a new ldap exception.
        Parameters:
        msg - describing this exception
        e - 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 exception
        msg - describing this exception
        e - 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