Invoking overridable methods from the readObject()
method can allow the overriding method to read the state of the subclass before it is fully constructed, since the base class is deserialized first, followed by the subclass. As a result, readObject()
must not call any overridable methods.
Also see the related rule MET06-J. Do not invoke overridable methods in clone().
Noncompliant Code Example
This noncompliant code example invokes an overridable method from the readObject()
method.
private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException { overridableMethod(); stream.defaultReadObject(); } public void overridableMethod() { // ... }
Compliant Solution
This compliant solution removes the call to the overridable method. When removing such calls is infeasible, ensure that the overridable method is declared private
or final
.
private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException { stream.defaultReadObject(); }
Exceptions
SER09-EX1: "The readObject
methods will often call java.io.ObjectInputStream.defaultReadObject
, which is an overridable method" [[SCG 2009]]. Such calls are permitted.
Risk Assessment
Invoking overridable methods from the readObject()
method can lead to initialization errors.
Rule |
Severity |
Likelihood |
Remediation Cost |
Priority |
Level |
---|---|---|---|---|---|
SER09-J |
low |
probable |
medium |
P4 |
L3 |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Bibliography
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="763323d7-b301-487b-84f9-6ceca4d44940"><ac:plain-text-body><![CDATA[ |
[[API 2006 |
AA. Bibliography#API 06]] |
|
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d5ec51e0-f135-4180-8738-8e8660d875ca"><ac:plain-text-body><![CDATA[ |
[[SCG 2009 |
AA. Bibliography#SCG 09]] |
Guideline 4-4 Prevent constructors from calling methods that can be overridden |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="92970452-ba7f-4c74-b934-e002cd7df24f"><ac:plain-text-body><![CDATA[ |
[[Bloch 2008 |
AA. Bibliography#Bloch 08]] |
Item 17: "Design and document for inheritance or else prohibit it" |
]]></ac:plain-text-body></ac:structured-macro> |