Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8216289

Use "system-wide" terminology in serial filtering documentation

    Details

    • Type: CSR
    • Status: Closed
    • Priority: P4
    • Resolution: Approved
    • Fix Version/s: 13
    • Component/s: core-libs
    • Labels:
      None
    • Subcomponent:
    • Compatibility Risk:
      minimal
    • Compatibility Risk Description:
      There is no change in behavior, only a change in terminology to be consistent with other packages.
    • Interface Kind:
      Java API, System or security property
    • Scope:
      SE

      Description

      Summary

      The terminology "system-wide" should be used in serial filter classes to specify the filters that apply to a single Java Runtime environment.

      Problem

      Initially, the term "process-wide" was used to describe the scope of the serial filter, but to be consistent with other subsystems that apply to a single Java Runtime environment, the term "system-wide" should be used.

      Solution

      Replace "process-wide" with "system-wide" in serial filter classes, configurations and documentation.

      Specification

      Use "System-wide" instead of "Process-wide".

      diff --git a/src/java.base/share/classes/java/io/ObjectInputFilter.java b/src/java.base/share/classes/java/io/ObjectInputFilter.java
      
      @@ -75,1 +75,1 
      - * Typically, a custom filter should check if a process-wide filter
      + * Typically, a custom filter should check if a system-wide filter
      @@ -83,1 +83,1 @@ import jdk.internal.access.SharedSecrets
      - *             // The process-wide filter overrides this filter
      + *             // The system-wide filter overrides this filter
      @@ -199,2 +199,2 @@ public interface ObjectInputFilter {
      -     * A utility class to set and get the process-wide filter or create a filter
      -     * from a pattern string. If a process-wide filter is set, it will be
      +     * A utility class to set and get the system-wide filter or create a filter
      +     * from a pattern string. If a system-wide filter is set, it will be
      @@ -225,1 +225,1 @@ public interface ObjectInputFilter {
      -         * Lock object for process-wide filter.
      +         * Lock object for system-wide filter.
      @@ -244,1 +244,1 @@ public interface ObjectInputFilter {
      -         * The name for the process-wide deserialization filter.
      +         * The name for the system-wide deserialization filter.
      @@ -250,1 +250,1 @@ public interface ObjectInputFilter {
      -         * The process-wide filter; may be null.
      +         * The system-wide filter; may be null.
      @@ -289,1 +289,1 @@ public interface ObjectInputFilter {
      -         * Returns the process-wide serialization filter or {@code null} if not configured.
      +         * Returns the system-wide serialization filter or {@code null} if not configured.
      @@ -291,1 +291,1 @@ public interface ObjectInputFilter {
      -         * @return the process-wide serialization filter or {@code null} if not configured
      +         * @return the system-wide serialization filter or {@code null} if not configured
      @@ -300,1 +300,1 @@ public interface ObjectInputFilter {
      -         * Set the process-wide filter if it has not already been configured or set.
      +         * Set the system-wide filter if it has not already been configured or set.
      @@ -302,1 +302,1 @@ public interface ObjectInputFilter {
      -         * @param filter the serialization filter to set as the process-wide filter; not null
      +         * @param filter the serialization filter to set as the system-wide filter; not null
      @@ -404,1 +404,1 @@ public interface ObjectInputFilter {
      -         * the process-wide serialization filter. If configured, it will be
      +         * the system-wide serialization filter. If configured, it will be
      
      diff --git a/src/java.base/share/classes/java/io/ObjectInputStream.java b/src/java.base/share/classes/java/io/ObjectInputStream.java
      
      @@ -191,1 +191,1 @@ import sun.reflect.misc.ReflectUtil;
      - * A {@linkplain ObjectInputFilter.Config#setSerialFilter(ObjectInputFilter) process-wide filter}
      + * A {@linkplain ObjectInputFilter.Config#setSerialFilter(ObjectInputFilter) system-wide filter}
      @@ -325,1 +325,1 @@ public class ObjectInputStream
      -     * {@linkplain ObjectInputFilter.Config#getSerialFilter() the process-wide filter}.
      +     * {@linkplain ObjectInputFilter.Config#getSerialFilter() the system-wide filter}.
      @@ -360,1 +360,1 @@ public class ObjectInputStream
      -     * {@linkplain ObjectInputFilter.Config#getSerialFilter() the process-wide filter}.
      +     * {@linkplain ObjectInputFilter.Config#getSerialFilter() the system-wide filter}.
      @@ -1160,1 +1160,1 @@ public class ObjectInputStream
      -     * the initial process-wide filter from
      +     * the initial system-wide filter from
      @@ -1236,1 +1236,1 @@ public class ObjectInputStream
      -     *       is not {@code null} and is not the process-wide filter
      +     *       is not {@code null} and is not the system-wide filter
      @@ -1244,1 +1244,1 @@ public class ObjectInputStream
      -        // Allow replacement of the process-wide filter if not already set
      +        // Allow replacement of the system-wide filter if not already set
      
      diff --git a/src/java.base/share/classes/java/io/ObjectStreamConstants.java b/src/java.base/share/classes/java/io/ObjectStreamConstants.java
      
      @@ -204,1 +204,1 @@ public interface ObjectStreamConstants {
      -     * Enable setting the process-wide serial filter.
      +     * Enable setting the system-wide serial filter.
      
      diff --git a/src/java.base/share/conf/security/java.security b/src/java.base/share/conf/security/java.security
      --- a/src/java.base/share/conf/security/java.security
      +++ b/src/java.base/share/conf/security/java.security
      @@ -923,1 +923,1 
      -# Serialization process-wide filter
      +# Serialization system-wide filter

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                rriggs Roger Riggs
                Reporter:
                rriggs Roger Riggs
                Reviewed By:
                Alan Bateman
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: