Uploaded image for project: 'Rules Repository'
  1. Rules Repository
  2. RSPEC-2142

"InterruptedException" should not be ignored

    XMLWordPrintable

    Details

    • Message:
      Either re-interrupt this method or rethrow the "{InterruptedException/ThreadDeath}" that can be caught here.
    • Highlighting:
      • Primary: Catch parameter
      • Secondary: Method call throwing "InterruptedException"
    • Default Severity:
      Major
    • Impact:
      Low
    • Likelihood:
      High
    • Default Quality Profiles:
      Sonar way
    • Covered Languages:
      Java
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      15min
    • Analysis Scope:
      Main Sources
    • CWE:
      CWE-391

      Description

      InterruptedExceptions should never be ignored in the code, and simply logging the exception counts in this case as "ignoring". The throwing of the InterruptedException clears the interrupted state of the Thread, so if the exception is not handled properly the information that the thread was interrupted will be lost. Instead, InterruptedExceptions should either be rethrown - immediately or after cleaning up the method's state - or the thread should be re-interrupted by calling Thread.interrupt() even if this is supposed to be a single-threaded application. Any other course of action risks delaying thread shutdown and loses the information that the thread was interrupted - probably without finishing its task.

      Similarly, the ThreadDeath exception should also be propagated. According to its JavaDoc:

      If ThreadDeath is caught by a method, it is important that it be rethrown so that the thread actually dies.

      Noncompliant Code Example

      public void run () {
        try {
          while (true) { 
            // do stuff
          }
        }catch (InterruptedException e) { // Noncompliant; logging is not enough
          LOGGER.log(Level.WARN, "Interrupted!", e);
        }
      }
      

      Compliant Solution

      public void run () {
        try {
          while (true) { 
            // do stuff
          }
        }catch (InterruptedException e) {
          LOGGER.log(Level.WARN, "Interrupted!", e);
          // Restore interrupted state...
          Thread.currentThread().interrupt();
        }
      }
      

      See

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              ann.campbell.2 Ann Campbell
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated: