A common misconception is that shared references to immutable objects are visible across multiple threads as soon as they are updated. For example, a developer can mistakenly believe that a class containing fields referring to only immutable objects is immutable and, consequently, thread-safe.
Section 14.10.2, "Final Fields and Security" of _Java Programming Language, Fourth Edition_ states \[[JPL 2006|AA. Bibliography#JPL 06]\]
{quote}
The problem is that, while the shared object is immutable, the reference used to access the shared object is itself shared and often mutable. Consequently, a correctly synchronized program must synchronize access to that shared reference, but often programs do not do this, because programmers do not recognize the need to do it.
{quote}
{mc} The String example might be good for the intro...if the long quote was not a good idea, perhaps a "For example, ..." line will help {mc}
References to both immutable and mutable objects must be made visible to all the threads. Immutable objects can be shared safely among multiple threads. However, mutable objects may not be fully constructed when their references are made visible. Guideline [TSM03-J. Do not publish partially initialized objects] describes object construction and visibility issues specific to mutable objects.
h2. Noncompliant Code Example
This noncompliant code example consists of the immutable {{Helper}} class:
{code:bgColor=#FFCCCC}
// Immutable Helper
public final class Helper {
private final int n;
public Helper(int n) {
this.n = n;
}
// ...
}
{code}
and a mutable {{Foo}} class:
{code:bgColor=#FFCCCC}
final class Foo {
private Helper helper;
public Helper getHelper() {
return helper;
}
public void setHelper(int num) {
helper = new Helper(num);
}
}
{code}
The {{getHelper()}} method publishes the mutable {{helper}} field. Because the {{Helper}} class is [immutable|BB. Definitions#immutable], it cannot be changed after it is initialized{mc} do not replace with "after initialization" {mc}. Furthermore, because {{Helper}} is immutable, it is always constructed properly before its reference is made visible, in compliance with guideline [TSM03-J. Do not publish partially initialized objects]. Unfortunately, a separate thread could observe a stale reference in the {{helper}} field of the {{Foo}} class.
h2. Compliant Solution (Synchronization)
This compliant solution synchronizes the methods of the {{Foo}} class to ensure that no thread sees a stale {{Helper}} reference.
{code:bgColor=#CCCCFF}
final class Foo {
private Helper helper;
public synchronized Helper getHelper() {
return helper;
}
public synchronized void setHelper(int num) {
helper = new Helper(num);
}
}
{code}
The immutable {{Helper}} class remains unchanged.
h2. Compliant Solution ({{volatile}})
References to immutable member objects can be made visible by declaring them volatile.
{code:bgColor=#CCCCFF}
final class Foo {
private volatile Helper helper;
public Helper getHelper() {
return helper;
}
public void setHelper(int num) {
helper = new Helper(num);
}
}
{code}
The immutable {{Helper}} class remains unchanged.
h2. Compliant Solution ({{java.util.concurrent}} Utilities)
This compliant solution wraps the immutable {{Helper}} object within an {{AtomicReference}} wrapper that can be updated atomically.
{code:bgColor=#CCCCFF}
final class Foo {
private final AtomicReference<Helper> helperRef =
new AtomicReference<Helper>();
public Helper getHelper() {
return helperRef.get();
}
public void setHelper(int num) {
helperRef.set(new Helper(num));
}
}
{code}
The immutable {{Helper}} class remains unchanged.
{mc} Sometimes I use the area before the risk assessment as a summary area for other CSs that can simply be mentioned to avoid redundancy, or CSs that are worth considering but have limitations which preclude us from recommending them. Basically general advice so that the implementer is not left wondering with a "what if I use ..." question. You deleted the line about making Helper immutable so where could such advice go? {mc}
h2. Risk Assessment
The assumption that classes containing immutable objects are immutable is misleading and can cause serious thread-safety issues.
|| Guideline || Severity || Likelihood || Remediation Cost || Priority || Level ||
| VNA01-J | low | probable | medium | {color:green}{*}P4{*}{color} | {color:green}{*}L3{*}{color} |
h3. Automated Detection
TODO
h3. Related Vulnerabilities
Any vulnerabilities resulting from the violation of this guideline are listed on the [CERT website|https://www.kb.cert.org/vulnotes/bymetric?searchview&query=FIELD+KEYWORDS+contains+CON28-J].
h2. Bibliography
\[[API 2006|AA. Bibliography#API 06]\]
\[[JPL 2006|AA. Bibliography#JPL 06]\] Section 14.10.2, "Final Fields and Security"
h2. Issue Tracking
{tasklist:Review List}
||Completed||Priority||Locked||CreatedDate||CompletedDate||Assignee||Name||
|F|M|F|1270826173609| |dmohindr|"Unfortunately, a separate thread -could- *can* observe a stale reference in the helper field of the Foo class."|
|T|M|F|1270826698362|1271441478121|svoboda|"This compliant solution synchronizes the methods of *class* Foo -class- " (it sounds strange with class occuring after Foo)|
{tasklist}
----
[!The CERT Oracle Secure Coding Standard for Java^button_arrow_left.png!|VNA00-J. Ensure visibility when accessing shared primitive variables] [!The CERT Oracle Secure Coding Standard for Java^button_arrow_up.png!|11. Visibility and Atomicity (VNA)] [!The CERT Oracle Secure Coding Standard for Java^button_arrow_right.png!|VNA02-J. Ensure that compound operations on shared variables are atomic]
| 