Class LogException

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class LogException
    extends LDAPSDKException
    This class defines an exception that may be thrown if a problem occurs while attempting to parse a log message.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      LogException​(java.lang.String logMessage, java.lang.String explanation)
      Creates a new log exception with the provided information.
      LogException​(java.lang.String logMessage, java.lang.String explanation, java.lang.Throwable cause)
      Creates a new log exception with the provided information.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLogMessage()
      Retrieves the malformed log message string that triggered this exception.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • LogException

        public LogException​(java.lang.String logMessage,
                            java.lang.String explanation)
        Creates a new log exception with the provided information.
        Parameters:
        logMessage - The malformed log message string that triggered this exception. It must not be null.
        explanation - A message explaining the problem that occurred. It must not be null.
      • LogException

        public LogException​(java.lang.String logMessage,
                            java.lang.String explanation,
                            java.lang.Throwable cause)
        Creates a new log exception with the provided information.
        Parameters:
        logMessage - The malformed log message string that triggered this exception. It must not be null.
        explanation - A message explaining the problem that occurred. It must not be null.
        cause - An underlying exception that triggered this exception.
    • Method Detail

      • getLogMessage

        public java.lang.String getLogMessage()
        Retrieves the malformed log message string that triggered this exception.
        Returns:
        The malformed log message string that triggered this exception.