Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8297794: Deprecate JMX Management Applets for Removal #11430

Closed

Conversation

kevinjwalls
Copy link
Contributor

@kevinjwalls kevinjwalls commented Nov 30, 2022

Deprecate the Java Management Extension (JMX) Management Applet (m-let) feature for removal.

This deprecation will have no impact on users of other JMX features, the JDK's built-in instrumentation, or any of the observability tools.

More details in bug, and CSR JDK-8297795


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change requires a CSR request to be approved

Issues

  • JDK-8297794: Deprecate JMX Management Applets for Removal
  • JDK-8297795: Deprecate JMX Management Applets for Removal (CSR)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/11430/head:pull/11430
$ git checkout pull/11430

Update a local copy of the PR:
$ git checkout pull/11430
$ git pull https://git.openjdk.org/jdk pull/11430/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11430

View PR using the GUI difftool:
$ git pr show -t 11430

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/11430.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 30, 2022

👋 Welcome back kevinw! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Nov 30, 2022

@kevinjwalls The following labels will be automatically applied to this pull request:

  • jmx
  • serviceability

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added serviceability serviceability-dev@openjdk.org jmx jmx-dev@openjdk.org csr Pull request needs approved CSR before integration labels Nov 30, 2022
@kevinjwalls kevinjwalls marked this pull request as ready for review November 30, 2022 13:14
@openjdk openjdk bot added the rfr Pull request is ready for review label Nov 30, 2022
@mlbridge
Copy link

mlbridge bot commented Nov 30, 2022

Webrevs

@AlanBateman
Copy link
Contributor

Are you planning to add the @deprecated tag with the description for why they are deprecated? I'm surprised the java.management module compiles without it but maybe this module has doclint config in its make file.

Copy link
Member

@dfuch dfuch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have the same remark as Alan - I believe an @deprecated text is needed in the API documentation of the public exported classes that are deprecated. At the minimum something like:

* @deprecated This class is deprecated for removal. There is no replacement. 

I also see that you have chosen to add @SuppressWarnings in tests. Not sure what the rules are for the serviceability area - but usually it's fine to keep the deprecation warning in tests (that is: suppressing deprecation warnings in tests is usually optional).

@kevinjwalls
Copy link
Contributor Author

Thanks both, yes will add a doc comment also. Currently the generated docs give you: "Deprecated, for removal: This API element is subject to removal in a future version." But will add more around that.

MLetObjectInputStream and MLetParser are not public classes, so thinking they are not part of the public API we need to deprecate before removal.

Happy to try and avoid test logs being full of excess noise with those suppression annotations... 8-)

@dfuch
Copy link
Member

dfuch commented Nov 30, 2022

MLetObjectInputStream and MLetParser are not public classes, so thinking they are not part of the public API we need to deprecate before removal.

Whether a class is public exported or not has no real relationship with whether it should have the @Deprecated annotation or not. It is better to add the @Deprecated annotation eagerly to all classes that are part of the feature being deprecated, if they are only used for the implementation of that feature, and if the thinking is that they would be removed if the feature is removed. Plus it usually simplifies things as it usually minimizes the places where you need to suppress warnings.

@kevinjwalls
Copy link
Contributor Author

Updated with additional Deprecated annotations on two non-public classes which would also be removed.
No deprecation tag doc update as there are no public API docs for these.

@openjdk openjdk bot removed the csr Pull request needs approved CSR before integration label Nov 30, 2022
@kevinjwalls
Copy link
Contributor Author

Added release-note in a subtask for the issue.

Copy link
Member

@dfuch dfuch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@openjdk
Copy link

openjdk bot commented Dec 1, 2022

@kevinjwalls This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8297794: Deprecate JMX Management Applets for Removal

Reviewed-by: dfuchs, mullan, rriggs, alanb

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 80 new commits pushed to the master branch:

  • 82561de: 8296384: [TESTBUG] sun/security/provider/SecureRandom/AbstractDrbg/SpecTest.java intermittently timeout
  • 61b7093: 8297872: Non-local G1MonotonicArenaFreePool::_freelist_pool has non-trivial ctor/dtor
  • 3b3bbe5: 8296907: VMError: add optional callstacks, siginfo for secondary errors
  • a573923: 8297264: C2: Cast node is not processed again in CCP and keeps a wrong too narrow type which is later replaced by top
  • b49fd92: 8298055: AArch64: fastdebug build fails after JDK-8247645
  • 914ef07: 8297609: Add application/wasm MIME type for wasm file extension
  • a71d91b: 8298067: Persistent test failures after 8296012
  • 87572d4: 8298068: ProblemList tests failing due to JDK-8297235
  • 0edb5d0: 8297683: Use enhanced-for cycle instead of Enumeration in java.security.jgss
  • c67166f: 8298003: NMT: fatal block printout does not show the correct corruption address
  • ... and 70 more: https://git.openjdk.org/jdk/compare/b52611bc36d4fa7b62d1bb1618aa5185f75bf5d0...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Dec 1, 2022
Copy link
Contributor

@RogerRiggs RogerRiggs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kevinjwalls
Copy link
Contributor Author

Thanks for all the reviews!

@kevinjwalls
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Dec 5, 2022

Going to push as commit 17666fb.
Since your change was applied there have been 81 commits pushed to the master branch:

  • 619b68c: 8294540: Remove Opaque2Node: it is broken and triggers assert
  • 82561de: 8296384: [TESTBUG] sun/security/provider/SecureRandom/AbstractDrbg/SpecTest.java intermittently timeout
  • 61b7093: 8297872: Non-local G1MonotonicArenaFreePool::_freelist_pool has non-trivial ctor/dtor
  • 3b3bbe5: 8296907: VMError: add optional callstacks, siginfo for secondary errors
  • a573923: 8297264: C2: Cast node is not processed again in CCP and keeps a wrong too narrow type which is later replaced by top
  • b49fd92: 8298055: AArch64: fastdebug build fails after JDK-8247645
  • 914ef07: 8297609: Add application/wasm MIME type for wasm file extension
  • a71d91b: 8298067: Persistent test failures after 8296012
  • 87572d4: 8298068: ProblemList tests failing due to JDK-8297235
  • 0edb5d0: 8297683: Use enhanced-for cycle instead of Enumeration in java.security.jgss
  • ... and 71 more: https://git.openjdk.org/jdk/compare/b52611bc36d4fa7b62d1bb1618aa5185f75bf5d0...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Dec 5, 2022
@openjdk openjdk bot closed this Dec 5, 2022
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Dec 5, 2022
@openjdk
Copy link

openjdk bot commented Dec 5, 2022

@kevinjwalls Pushed as commit 17666fb.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated jmx jmx-dev@openjdk.org serviceability serviceability-dev@openjdk.org
5 participants