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

Expand "What's New" section #125

Merged
merged 3 commits into from
Aug 15, 2020
Merged

Conversation

dblevins
Copy link
Contributor

The spirit of this update is to:

  • Slightly expand the detail on changes in 4.0
    • Opted for "javax.ejb" vs "javax" as several javax namespaces referenced in the document are still valid and not renamed.
    • Added short reasons for the removals so that knowledge is in the spec (vs institutional knowledge)
    • Explicitly call out the fact that this specification revision is a breaking change
  • Explicitly add "Jakarta Enterprise Beans 3.2" as this specification is technically part of our history. Also to call out a potential source of future confusion since it has the same version number as Enterprise JavaBeans 3.2.
  • Use "Enterprise JavaBeans" for the duration of this section where applicable:
    • Legally correct trademark to use for the older specifications
    • Adds a bit of clarity by explicitly noting the name change and history at the JCP
  • Introduce links to EJB 3.1 and 3.0 in Related Documents as these specifications are explicitly referenced.

…erences.

Signed-off-by: David Blevins <david.blevins@gmail.com>
@dblevins
Copy link
Contributor Author

@hussainnm Would love your feedback on this one too. (thanks again for all your contributions)

* _Removed the deprecated EJBContext.getEnvironment() method._

* _Removed the Support for Distributed Interoperability to reflect
the removal of CORBA from Java 11 and the Jakarta EE 9 Platform._

* _Marked the EJB 2.x API Group as "Optional"_

Copy link
Contributor

Choose a reason for hiding this comment

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

In the current spec document, the term "Enterprise Beans 2.x API" is used. I think we should use the new term name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note that isn't a change part of this PR. That said, the trademark rules here are a little nuanced. Here's the discussions we've had in the Specification/Steering committees and the guidance we've been given on use of either trademark.

  • When referring to the specification in general or referring to a new version of the specification, we should use the new name.
  • When explicitly referring to past JCP versions of the specification we should take care to use the appropriate trademark. For example, "J2EE 1.2" not "Jakarta EE 1.2"

Similarly, when "Java EE" became the new name for "J2EE" we continued to refer to the older specs using their proper name "J2EE 1.3", "J2EE 1.4", etc and did not being referring to them as "Java EE 1.3", "Java EE 1.4", etc.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 to change EJB 2.x to Enterprise Beans 2.x.

As I have explained in the mailing list, an earlier version under the new namespace should be referred with the new name.

Copy link
Member

Choose a reason for hiding this comment

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

+1 to change EJB 2.x to Enterprise Beans 2.x.

This does not appear to be a reference to an older spec level, but instead is a reference to a subset of the current specification, specifically the 2.x API Group, so should use the same terminology as in the rest of the current version of the spec.


* _Removed the methods relying on java.security.Identity_
* _All 'javax.ejb' namespace/packages have been renamed to 'jakarta.ejb'_
Copy link
Contributor

Choose a reason for hiding this comment

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

My personal preference of formatting, either javax.ejb jakarta.ejb, or the plain javax.ejb jakarta.ejb. The single quote seems a bit odd here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. Fixed.

Signed-off-by: David Blevins <david.blevins@gmail.com>
Copy link
Contributor

@hussainnm hussainnm left a comment

Choose a reason for hiding this comment

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

LGTM

* _Removed the deprecated EJBContext.getEnvironment() method._

* _Removed the Support for Distributed Interoperability to reflect
the removal of CORBA from Java 11 and the Jakarta EE 9 Platform._

* _Marked the EJB 2.x API Group as "Optional"_

Copy link
Member

Choose a reason for hiding this comment

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

+1 to change EJB 2.x to Enterprise Beans 2.x.

This does not appear to be a reference to an older spec level, but instead is a reference to a subset of the current specification, specifically the 2.x API Group, so should use the same terminology as in the rest of the current version of the spec.

Copy link
Contributor

@jeanouii jeanouii left a comment

Choose a reason for hiding this comment

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

@dblevins I have reviewed and approved.
Note that there was a conflict with your previous PR I merged this morning. So I resolved it. Hopefully it's good.

@dblevins dblevins merged commit 9771114 into jakartaee:master Aug 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants