Skip to content

Commit

Permalink
Adjust docs, leave out JSR references, replace them with Jakarta link…
Browse files Browse the repository at this point in the history
…s and terminilogy.
  • Loading branch information
manovotn committed Dec 16, 2020
1 parent 5534718 commit 7425f13
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 189 deletions.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,6 @@
:toclevels: 3
= Weld {weldVersion} - CDI Reference Implementation

[preface]
= A note about naming and nomenclature

Throughout this document, mentions of JSR-299, JSR-346 and JSR-365 appear. JSR is
a document of a proposed specification used in the Java Community
Process (JCP). JSRs are somewhat analogous to RFCs used by IETF. JSR-299
and JSR-346 are the JCP specification names for the 1.0 and 1.1 versions
of CDI, respectively. JSR-365 is the JCP specification name for the CDI 2.0 version.

Shortly before the final draft of JSR-299 was submitted, the
specification changed its name from "Web Beans" to "Java Contexts and
Dependency Injection for the Java EE platform", abbreviated CDI. For a
brief period after the renaming, the reference implementation adopted
the name "Web Beans". However, this ended up causing more confusion than
it solved and Red Hat decided to change the name of the reference
implementation to "Weld". You may still find other documentation, blogs,
forum posts, etc. that use the old nomenclature. Please update any
references you can. The naming game is over.

You'll also find that some of the functionality that once existed in the
specification is now missing, such as defining beans in XML. These
features will be available as portable extensions.

Note that this reference guide was started while changes were still
being made to the specification. We've done our best to update it for
accuracy. If you discover a conflict between what is written in this
guide and the specification, the specification is the authority—assume
it is correct. If you believe you have found an error in the
specification, please report it to the CDI EG.


:numbered:
:sectanchors:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/src/main/asciidoc/ee.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ built-in beans, all with the qualifier `@Default`:

* the current JTA `UserTransaction`,
* a `Principal` representing the current caller identity,
* the default http://jcp.org/en/jsr/detail?id=303[Bean Validation]
* the default https://jakarta.ee/specifications/bean-validation/3.0/[Bean Validation]
`ValidationFactory`,
* a `Validator` for the default `ValidationFactory`,
* `HttpServletRequest`, `HttpSession` and `ServletContext`
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/src/main/asciidoc/environments.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ ifdef::generate-index-link[link:configure.html[additional configuration settings
=== GlassFish

Weld is also built into GlassFish from V3 onwards. Since GlassFish is
the Java EE reference implementation, it supports all features of
the Jakarta EE compatible implementation, it supports all features of
CDI. What better way for GlassFish to support these features than to use
Weld, the CDI reference implementation? Just package up your CDI
Weld, the CDI compatible implementation? Just package up your CDI
application and deploy.

[[weld-servlet]]
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/src/main/asciidoc/gettingstarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@ $> mvn verify -Darquillian=wildfly-managed
=== Deploying to GlassFish

Deploying to GlassFish should be easy and familiar, right? After all,
it's the Java EE 8 reference implementation and Weld is the CDI
reference implementation, meaning Weld gets bundled with GlassFish. So
it's the Jakarta EE compatible implementation and Weld is the CDI
compatible implementation, meaning Weld gets bundled with GlassFish. So
yes, it's all quite easy and familiar.

To deploy the examples to GlassFish, you'll need a GlassFish 5.1.0 release. Extract
Expand Down
37 changes: 10 additions & 27 deletions docs/reference/src/main/asciidoc/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,36 +1,19 @@
= Weld {weldVersion} - CDI Reference Implementation

[preface]
= A note about naming and nomenclature
= A note about this document

Throughout this document, mentions of JSR-299, JSR-346 and JSR-365 appear. JSR is
a document of a proposed specification used in the Java Community
Process (JCP). JSRs are somewhat analogous to RFCs used by IETF. JSR-299
and JSR-346 are the JCP specification names for the 1.0 and 1.1 versions
of CDI, respectively. JSR-365 is the JCP specification name for the CDI 2.0 version.
This document is meant as a complimentary source of information to the
https://jakarta.ee/specifications/cdi/3.0/jakarta-cdi-spec-3.0.html[CDI specification].
It doesn't cover all general parts of CDI, instead it goes more in-depth in certain areas
and also explains many areas in which Weld offers certain non-portable configurations and
behavior on top of what CDI defines.

Shortly before the final draft of JSR-299 was submitted, the
specification changed its name from "Web Beans" to "Java Contexts and
Dependency Injection for the Java EE platform", abbreviated CDI. For a
brief period after the renaming, the reference implementation adopted
the name "Web Beans". However, this ended up causing more confusion than
it solved and Red Hat decided to change the name of the reference
implementation to "Weld". You may still find other documentation, blogs,
forum posts, etc. that use the old nomenclature. Please update any
references you can. The naming game is over.
It also shows some simple setup examples for user applications and talks a bit about how to
integrate Weld into various environments.

You'll also find that some of the functionality that once existed in the
specification is now missing, such as defining beans in XML. These
features will be available as portable extensions.

Note that this reference guide was started while changes were still
being made to the specification. We've done our best to update it for
accuracy. If you discover a conflict between what is written in this
guide and the specification, the specification is the authority—assume
it is correct. If you believe you have found an error in the
specification, please report it to the CDI EG.

Below are links to separate documentation chapters.
The document is divided into many separate parts and chapters for ease of read and navigation.
Below are the links to them.

. link:part1.html[Beans]
.. link:intro.html[Introduction]
Expand Down
10 changes: 4 additions & 6 deletions docs/reference/src/main/asciidoc/next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,11 @@ endif::[]

A lot of additional information on CDI can be found online. Regardless,
the CDI specification remains the authority for information on CDI. The
spec is less than 100 pages and is quite readable (don't worry, it's not
like your Blu-ray player manual). Of course, it covers many details
we've skipped over here. The spec is available on the at the JCP website
(http://jcp.org/en/jsr/detail?id=299[CDI 1.0])
(http://jcp.org/en/jsr/detail?id=346[CDI 1.1]).
spec is fairly readable and it covers many details
we've skipped over here.It is available on the at the Jakarta website
(https://jakarta.ee/specifications/cdi/3.0/jakarta-cdi-spec-3.0.html[CDI 3.0]).

The CDI reference implementation, Weld, is being developed by the
The CDI compatible implementation, Weld, is being developed by the
https://github.com/weld/core/graphs/contributors[Weld team]. The team
and the CDI spec lead blog at http://in.relation.to[in.relation.to].
This guide was originally based on a series of blog entries published
Expand Down
21 changes: 5 additions & 16 deletions docs/reference/src/main/asciidoc/part1.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ endif::[]

[partintro]
--
The http://jcp.org/en/jsr/detail?id=346[CDI] specification defines a set
The https://jakarta.ee/specifications/cdi[CDI] specification defines a set
of complementary services that help improve the structure of application
code. CDI layers an enhanced lifecycle and interaction model over
existing Java component types, including managed beans and Enterprise
Expand All @@ -22,10 +22,10 @@ new kind of interceptor, called a _decorator_, that is more appropriate
for use in solving business problems, and
* an _SPI_ for developing portable extensions to the container.

The CDI services are a core aspect of the Java EE platform and include
full support for Java EE modularity and the Java EE component
The CDI services are a core aspect of the Jakarta EE platform and include
full support for Jakarta EE modularity and the Jakarta EE component
architecture. But the specification does not limit the use of CDI to the
Java EE environment. Starting with CDI 2.0, the specification covers the use of CDI
Jakarta EE environment. Starting with CDI 2.0, the specification covers the use of CDI
in the Java SE environment as well. In Java SE, the services might be
provided by a standalone CDI implementation like Weld (see
ifndef::generate-index-link[<<_cdi_se_module>>]
Expand Down Expand Up @@ -105,21 +105,10 @@ handle persistence, or what web framework you have to use. You'll have
to decide those kinds of things for yourself.

CDI even provides a comprehensive SPI, allowing other kinds of object
defined by future Java EE specifications or by third-party frameworks to
defined by future Jakarta EE specifications or by third-party frameworks to
be cleanly integrated with CDI, take advantage of the CDI services, and
interact with any other kind of bean.

CDI was influenced by a number of existing Java frameworks, including
Seam, Guice and Spring. However, CDI has its own, very distinct,
character: more typesafe than Seam, more stateful and less XML-centric
than Spring, more web and enterprise-application capable than Guice. But
it couldn't have been any of these without inspiration from the
frameworks mentioned and _lots_ of collaboration and hard work by the
JSR-299 and JSR-346 Expert Groups (EG).

Finally, CDI is a http://jcp.org[Java Community Process] (JCP) standard.
Java EE 7 requires that all compliant application servers provide
support for JSR-346 (even in the web profile).
--


Expand Down
2 changes: 1 addition & 1 deletion docs/reference/src/main/asciidoc/part5.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ endif::[]

[partintro]
--
Weld is the reference implementation of CDI, and is used by WildFly,
Weld is compatible implementation of CDI, and is used by WildFly,
GlassFish and WebLogic to provide CDI services for Java Enterprise
Edition (Java EE) applications. Weld also goes beyond the environments
and APIs defined by the CDI specification by providing support for a
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/src/main/asciidoc/weldexamples.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -298,9 +298,8 @@ does not provide the CDI services. For your convenience we provide a
single jar suitable for running Weld in any servlet container (including
Jetty), `weld-servlet-shaded`.

NOTE: You must also include the jars for JSF, EL, and the common annotations
(`jsr250-api.jar`), all of which are provided by the Java EE platform (a
Java EE application server).
NOTE: You must also include the jars for JSF, EL, and the common annotations,
all of which are provided by the Java EE platform (a Java EE application server).

Second, we need to explicitly specify the servlet listener in `web.xml`,
again because the container isn't doing this stuff for you. The servlet
Expand Down

0 comments on commit 7425f13

Please sign in to comment.