Difference between revisions of "Overly-Broad Throws Declaration"

From OWASP
Jump to: navigation, search
 
Line 1: Line 1:
 
{{Template:Vulnerability}}
 
{{Template:Vulnerability}}
 +
 +
==Abstract==
 +
 +
The method throws a generic exception making it harder for callers to do a good job of error handling and recovery.
  
 
==Description==
 
==Description==
 +
 +
Declaring a method to throw Exception or Throwable makes it difficult for callers to do good error handling and error recovery. Java's exception mechanism is set up to make it easy for callers to anticipate what can go wrong and write code to handle each specific exceptional circumstance. Declaring that a method throws a generic form of exception defeats this system.
  
 
==Examples ==
 
==Examples ==
 +
 +
The following method throws three types of exceptions.
 +
 +
<pre>
 +
public void doExchange()
 +
  throws IOException, InvocationTargetException,
 +
SQLException {
 +
  ...
 +
}
 +
</pre>
 +
 +
While it might seem tidier to write
 +
 +
 +
<pre>
 +
public void doExchange()
 +
  throws Exception {
 +
  ...
 +
}
 +
</pre>
 +
 +
doing so hampers the caller's ability to understand and handle the exceptions that occur. Further, if a later revision of doExchange() introduces a new type of exception that should be treated differently than previous exceptions, there is no easy way to enforce this requirement.
  
 
==Related Threats==
 
==Related Threats==
Line 14: Line 42:
  
 
==Categories==
 
==Categories==
 
{{Template:Stub}}
 
  
 
[[Category:Implementation]]
 
[[Category:Implementation]]
 
 
[[Category:Error Handling Vulnerability]]
 
[[Category:Error Handling Vulnerability]]
 +
[[Category:Java]]
 +
[[Category:Implementation]]
 +
[[Category:Code Snippet]]

Revision as of 12:28, 19 July 2006

This is a Vulnerability. To view all vulnerabilities, please see the Vulnerability Category page.


Abstract

The method throws a generic exception making it harder for callers to do a good job of error handling and recovery.

Description

Declaring a method to throw Exception or Throwable makes it difficult for callers to do good error handling and error recovery. Java's exception mechanism is set up to make it easy for callers to anticipate what can go wrong and write code to handle each specific exceptional circumstance. Declaring that a method throws a generic form of exception defeats this system.

Examples

The following method throws three types of exceptions.

	public void doExchange()
	  throws IOException, InvocationTargetException,
			 SQLException {
	  ...
	}

While it might seem tidier to write


	public void doExchange()
	  throws Exception {
	  ...
	}

doing so hampers the caller's ability to understand and handle the exceptions that occur. Further, if a later revision of doExchange() introduces a new type of exception that should be treated differently than previous exceptions, there is no easy way to enforce this requirement.

Related Threats

Related Attacks

Related Vulnerabilities

Related Countermeasures

Categories