org.olat.core.logging
Class KnownIssueException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.olat.core.logging.OLATRuntimeException
                  org.olat.core.logging.KnownIssueException

All Implemented Interfaces:

java.io.Serializable

public class KnownIssueException
extends OLATRuntimeException

Use this exception when you want to identify a situation where an exception occurs that we want to treat as a known issues case.

Known issues shall then be given a JIRA number and instances of this class hence carry that number.

When this exception ends up in a log file, we can then treat this case as a known issue and not let a test fail because of this - plus we have a jira number which should speed up error analysis.

Author:

Stefan

See Also:

Serialized Form

Constructor Summary

KnownIssueException(java.lang.String logMsg, int jiraNumber)
Generic signature.

KnownIssueException(java.lang.String logMsg, int jiraNumber, java.lang.Throwable cause)
Includes throwable.

Method Summary

java.lang.String	getJiraLink() convenience method to retrieve html fragment with link to jira e.g.
int	getJiraNumber() JIRA Number without prefix

Methods inherited from class org.olat.core.logging.OLATRuntimeException

getLogMsg, getThrowingClazz, getUsrMsgArgs, getUsrMsgKey, getUsrMsgPackage, throwableToHtml

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KnownIssueException

public KnownIssueException(java.lang.String logMsg,
                           int jiraNumber,
                           java.lang.Throwable cause)

Includes throwable.

Parameters:

logMsg -

cause -

KnownIssueException

public KnownIssueException(java.lang.String logMsg,
                           int jiraNumber)

Generic signature.

Parameters:

logMsg -

Method Detail

getJiraNumber

public int getJiraNumber()

JIRA Number without prefix

Returns:

getJiraLink

public java.lang.String getJiraLink()

convenience method to retrieve html fragment with link to jira e.g. OLAT-XXXX

Returns: