Class AuditLogException

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class AuditLogException
    extends LDAPSDKException
    This class defines an exception that may be thrown if a problem occurs while attempting to parse an audit 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
      AuditLogException​(java.util.List<java.lang.String> logMessageLines, java.lang.String explanation)
      Creates a new audit log exception with the provided information.
      AuditLogException​(java.util.List<java.lang.String> logMessageLines, java.lang.String explanation, java.lang.Throwable cause)
      Creates a new audit log exception with the provided information.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getLogMessageLines()
      Retrieves a list of the lines that comprise the audit log message 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

      • AuditLogException

        public AuditLogException​(@NotNull
                                 java.util.List<java.lang.String> logMessageLines,
                                 @NotNull
                                 java.lang.String explanation)
        Creates a new audit log exception with the provided information.
        Parameters:
        logMessageLines - A list of the lines that comprise the audit log message. It must not be null but may be empty.
        explanation - A message explaining the problem that occurred. It must not be null.
      • AuditLogException

        public AuditLogException​(@NotNull
                                 java.util.List<java.lang.String> logMessageLines,
                                 @NotNull
                                 java.lang.String explanation,
                                 @Nullable
                                 java.lang.Throwable cause)
        Creates a new audit log exception with the provided information.
        Parameters:
        logMessageLines - A list of the lines that comprise the audit log message. It must not be null but may be empty.
        explanation - A message explaining the problem that occurred. It must not be null.
        cause - An underlying exception that triggered this exception.
    • Method Detail

      • getLogMessageLines

        @NotNull
        public java.util.List<java.lang.String> getLogMessageLines()
        Retrieves a list of the lines that comprise the audit log message that triggered this exception.
        Returns:
        A list of the lines that comprise the audit log message that triggered this exception, or an empty list if no log message lines are available.