RLK.OUT
RLK (Resource Leak) issues are reported when resources are allocated but not properly disposed after use. Failing to properly dispose a resource can lead to such problems as:
- too many files being open
- an application not being able to access a temporary file when it is needed
RLK.OUT indicates that an output stream that was opened is not explicitly closed.
Vulnerability and risk
Resources such as streams, connections and graphic objects must be explicitly closed. The close operation can unblock transactions or flush file changes in the file system. While a resource will eventually be closed by the garbage collector, resource exhaustion can occur before garbage collection starts. Depending on the nature of the resource, various exceptions will be thrown on a failed attempt to allocate another resource, for example: java.io.FileNotFoundException: Too many open files or too many database connections.
Mitigation and prevention
Explicitly close all resources that have the close method, even those that you think are not doing anything significant. Future code changes will then be safe from such errors.
Example 1
public void printLines(String fName, Collection<String> lines) {
try {
File file = new File(fName);
PrintWriter pstr = new PrintWriter(
new BufferedOutputStream(
new FileOutputStream(file)));
for (final String line : lines) {
pstr.println(line);
}
} catch (IOException e) {
e.printStackTrace();
}
}RLK.OUT is reported for the snippet on line 16: Output stream 'pstr' is not closed on exit.
Example 2
public void printLines(String fName, Collection<String> lines) {
try {
File file = new File(fName);
PrintWriter pstr = new PrintWriter(
new BufferedOutputStream(
new FileOutputStream(file)));
try {
for (final String line : lines) {
pstr.println(line);
}
} finally {
pstr.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}The snippet from the previous section is fixed; RLK.OUT is not reported here.
External guidance
Extension
This checker can be extended through the Klocwork knowledge base. See Tuning Java analysis for more information.