Changes for Jakarta EE 8 Release (#779)

* Renamed project to 'Jakarta RESTful Web Services' (cherry picked from commit 66ce6b3) * Use new project name where appropriate. Remove use of acronym from Javadocs, preferring the use of 'API' over 'JAX-RS' given that the latter is implied by context. A few other minor changes. Signed-off-by: Santiago Pericas-Geertsen <santiago.pericasgeertsen@oracle.com> * Fixed name in pom. Signed-off-by: Santiago Pericas-Geertsen <santiago.pericasgeertsen@oracle.com>
jakartaee · Jul 10, 2019 · e4e4971 · e4e4971
1 parent ae9841a
commit e4e4971
Show file tree

Hide file tree

Showing 63 changed files with 319 additions and 341 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,12 +1,12 @@
-# Contributing to Eclipse Project for JAX-RS
+# Contributing to the Jakarta RESTful Web Services Project
 
 Thanks for your interest in this project.
 
 ## Project description
 
-JAX-RS: Java API for RESTful Web Services (JAX-RS) is a Java programming
-language API spec that provides support in creating web services according to
-the Representational State Transfer (REST) architectural pattern.
+Jakarta RESTful Web Services provides a specification document, TCK and foundational 
+API to develop web services following the Representational State Transfer (REST) 
+architectural pattern.
 
 * https://projects.eclipse.org/projects/ee4j.jaxrs
 

diff --git a/NOTICE.md b/NOTICE.md
@@ -1,13 +1,13 @@
-# Notices for Eclipse Project for JAX-RS
+# Notices for the Jakarta RESTful Web Services Project
 
-This content is produced and maintained by the Eclipse Project for JAX-RS
+This content is produced and maintained by the **Jakarta RESTful Web Services**
 project.
 
 * Project home: https://projects.eclipse.org/projects/ee4j.jaxrs
 
 ## Trademarks
 
-Eclipse Project for JAX-RS is a trademark of the Eclipse Foundation.
+**Jakarta RESTful Web Services** is a trademark of the Eclipse Foundation.
 
 ## Copyright
 

diff --git a/README.md b/README.md
@@ -14,6 +14,12 @@
 
 ---
 
-# JAX-RS API [![Build Status](https://travis-ci.org/eclipse-ee4j/jaxrs-api.svg?branch=master)](https://travis-ci.org/eclipse-ee4j/jaxrs-api)
+# Jakarta RESTful Web Services [![Build Status](https://travis-ci.org/eclipse-ee4j/jaxrs-api.svg?branch=master)](https://travis-ci.org/eclipse-ee4j/jaxrs-api)
 
-This repository contains JAX-RS API source code.
+**Jakarta RESTful Web Services** provides a specification document, TCK and foundational API to develop web services following the Representational State Transfer (REST) architectural pattern.
+
+Contributions are welcome, please sign the Eclipse Contributor Agreement before submitting PRs: https://www.eclipse.org/contribute/cla
+
+Project page: https://projects.eclipse.org/projects/ee4j.jaxrs
+
+Mailinglist: https://accounts.eclipse.org/mailing-list/jaxrs-dev
diff --git a/examples/pom.xml b/examples/pom.xml
@@ -15,12 +15,6 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <parent>
-        <groupId>net.java</groupId>
-        <artifactId>jvnet-parent</artifactId>
-        <version>1</version>
-    </parent>
-
     <groupId>jakarta.ws.rs</groupId>
     <artifactId>jakarta.ws.rs-examples</artifactId>
     <version>2.1.6-SNAPSHOT</version>
@@ -34,8 +28,8 @@
     </properties>
 
     <organization>
-        <name>Oracle Corporation</name>
-        <url>http://www.oracle.com/</url>
+        <name>Eclipse Foundation</name>
+        <url>https://www.eclipse.org/org/foundation/</url>
     </organization>
 
     <issueManagement>
@@ -45,8 +39,8 @@
 
     <mailingLists>
         <mailingList>
-            <name>JAX-RS Discussion Group </name>
-            <archive>jaxrs-spec@javaee.groups.io</archive>
+            <name>Developer Discussions</name>
+            <archive>jaxrs-dev@eclipse.org</archive>
         </mailingList>
     </mailingLists>
 
@@ -66,14 +60,10 @@
 
     <developers>
         <developer>
-            <email>santiago.pericasgeertsen@oracle.com</email>
-            <id>Santiago</id>
-            <name>Santiago Pericas-Geertsen</name>
-            <organization>Oracle</organization>
-            <roles>
-                <role>JAX-RS Spec Lead</role>
-            </roles>
-            <timezone>EST</timezone>
+            <id>developers</id>
+            <name>API Developers</name>
+            <email>jaxrs-dev@eclipse.org</email>
+            <url>https://github.com/eclipse-ee4j/jaxrs-api/graphs/contributors</url>
         </developer>
     </developers>
 
@@ -119,7 +109,7 @@
                     <artifactId>maven-javadoc-plugin</artifactId>
                     <version>2.10.3</version>
                     <configuration>
-                        <doctitle>JAX-RS ${project.version} API Specification</doctitle>
+                        <doctitle>${project.version} API Specification</doctitle>
                         <bottom>
                             <![CDATA[Copyright &#169; 1996-2014,
                                 <a href="http://www.oracle.com">Oracle</a>
@@ -273,13 +263,13 @@
     <distributionManagement>
         <repository>
             <id>repo.eclipse.org</id>
-            <name>JAX-RS API Repository - Releases</name>
+            <name>API Repository - Releases</name>
             <url>https://repo.eclipse.org/content/repositories/jax-rs-api-releases/</url>
         </repository>
 
         <snapshotRepository>
             <id>repo.eclipse.org</id>
-            <name>JAX-RS API Repository - Snapshots</name>
+            <name>API Repository - Snapshots</name>
             <url>https://repo.eclipse.org/content/repositories/jax-rs-api-snapshots/</url>
         </snapshotRepository>
     </distributionManagement>

diff --git a/jaxrs-api/pom.xml b/jaxrs-api/pom.xml
@@ -24,8 +24,8 @@
     <artifactId>jakarta.ws.rs-api</artifactId>
     <version>2.1.6-SNAPSHOT</version>
     <packaging>bundle</packaging>
-    <name>javax.ws.rs-api</name>
-    <description>Java API for RESTful Web Services</description>
+    <name>jakarta.ws.rs-api</name>
+    <description>Jakarta RESTful Web Services API</description>
 
     <url>https://github.com/eclipse-ee4j/jaxrs-api</url>
 
@@ -37,7 +37,7 @@
     <developers>
         <developer>
             <id>developers</id>
-            <name>JAX-RS API Developers</name>
+            <name>API Developers</name>
             <email>jaxrs-dev@eclipse.org</email>
             <url>https://github.com/eclipse-ee4j/jaxrs-api/graphs/contributors</url>
         </developer>
@@ -50,7 +50,7 @@
 
     <mailingLists>
         <mailingList>
-            <name>JAX-RS Developer Discussions</name>
+            <name>Developer Discussions</name>
             <archive>jaxrs-dev@eclipse.org</archive>
         </mailingList>
     </mailingLists>
@@ -449,7 +449,7 @@
                         <instructions>
                             <_failok>true</_failok>
                             <Build-Id>${buildNumber}</Build-Id>
-                            <Bundle-Description>Java API for RESTful Web Services (JAX-RS)</Bundle-Description>
+                            <Bundle-Description>Jakarta RESTful Web Services API</Bundle-Description>
                             <Bundle-Version>${spec.bundle.version}</Bundle-Version>
                             <Bundle-SymbolicName>jakarta.ws.rs-api</Bundle-SymbolicName>
                             <DynamicImport-Package>*</DynamicImport-Package>
@@ -714,7 +714,7 @@
     </dependencies>
 
     <properties>
-        <apidocs.title>JAX-RS ${spec.version} API Specification ${spec.version.revision}</apidocs.title>
+        <apidocs.title>Jakarta RESTful Web Services ${spec.version} API Specification ${spec.version.revision}</apidocs.title>
         <java.version>1.8</java.version>
 
         <maven.bundle.plugin.version>3.5.0</maven.bundle.plugin.version>
@@ -741,13 +741,13 @@
     <distributionManagement>
         <repository>
             <id>repo.eclipse.org</id>
-            <name>JAX-RS API Repository - Releases</name>
+            <name>API Repository - Releases</name>
             <url>https://repo.eclipse.org/content/repositories/jax-rs-api-releases/</url>
         </repository>
 
         <snapshotRepository>
             <id>repo.eclipse.org</id>
-            <name>JAX-RS API Repository - Snapshots</name>
+            <name>API Repository - Snapshots</name>
 	    <url>https://repo.eclipse.org/content/repositories/jax-rs-api-snapshots/</url>
         </snapshotRepository>
     </distributionManagement>

diff --git a/jaxrs-api/src/main/java/javax/ws/rs/BeanParam.java b/jaxrs-api/src/main/java/javax/ws/rs/BeanParam.java
@@ -23,10 +23,10 @@
 import java.lang.annotation.Target;
 
 /**
- * The annotation that may be used to inject custom JAX-RS "parameter aggregator" value object
+ * The annotation that may be used to inject a custom "parameter aggregator" value object
  * into a resource class field, property or resource method parameter.
  * <p>
- * The JAX-RS runtime will instantiate the object and inject all it's fields and properties annotated
+ * The runtime will instantiate the object and inject all it's fields and properties annotated
  * with either one of the {@code @XxxParam} annotation ({@link PathParam &#64;PathParam},
  * {@link FormParam &#64;FormParam} ...) or the {@link javax.ws.rs.core.Context &#64;Context}
  * annotation. For the POJO classes same instantiation and injection rules apply as in case of instantiation

diff --git a/jaxrs-api/src/main/java/javax/ws/rs/ConstrainedTo.java b/jaxrs-api/src/main/java/javax/ws/rs/ConstrainedTo.java
@@ -23,14 +23,14 @@
 import java.lang.annotation.Target;
 
 /**
- * Indicates the run-time context in which an annotated JAX-RS provider
+ * Indicates the run-time context in which an annotated provider
  * is applicable. If a {@code @ConstrainedTo} annotation is not
- * present on a JAX-RS provider type declaration, the declared provider
+ * present on a provider type declaration, the declared provider
  * may be used in any run-time context. If such a annotation is present,
- * the JAX-RS runtime will enforce the specified usage restriction.
+ * the runtime will enforce the specified usage restriction.
  * <p>
  * The following example illustrates restricting a {@link javax.ws.rs.ext.MessageBodyReader}
- * provider implementation to run only as part of a {@link RuntimeType#CLIENT JAX-RS client run-time}:
+ * provider implementation to run only as part of a {@link RuntimeType#CLIENT Client run-time}:
  * </p>
  * <pre>
  *  &#064;ConstrainedTo(RuntimeType.CLIENT)
@@ -40,7 +40,7 @@
  * </pre>
  * <p>
  * The following example illustrates restricting a {@link javax.ws.rs.ext.WriterInterceptor}
- * provider implementation to run only as part of a {@link RuntimeType#SERVER JAX-RS server run-time}:
+ * provider implementation to run only as part of a {@link RuntimeType#SERVER Server run-time}:
  * </p>
  * <pre>
  *  &#064;ConstrainedTo(RuntimeType.SERVER)
@@ -49,17 +49,17 @@
  *  }
  * </pre>
  * <p>
- * It is a configuration error to constraint a JAX-RS provider implementation to
- * a run-time context in which the provider cannot be applied. In such case a JAX-RS
+ * It is a configuration error to constraint a provider implementation to
+ * a run-time context in which the provider cannot be applied. In such case, the
  * runtime SHOULD inform a user about the issue and ignore the provider implementation in further
  * processing.
  * </p>
  * <p>
  * For example, the following restriction of a {@link javax.ws.rs.client.ClientRequestFilter}
- * to run only as part of a JAX-RS server run-time would be considered invalid:
+ * to run only as part of the server run-time would be considered invalid:
  * </p>
  * <pre>
- *  // reported as invalid and ignored by JAX-RS runtime
+ *  // reported as invalid and ignored by the runtime
  *  &#064;ConstrainedTo(RuntimeType.SERVER)
  *  public class MyFilter implements ClientRequestFilter {
  *      ...
@@ -75,7 +75,7 @@
 public @interface ConstrainedTo {
 
     /**
-     * Define the {@link RuntimeType constraint type} to be placed on a JAX-RS provider.
+     * Define the {@link RuntimeType constraint type} to be placed on a provider.
      */
     RuntimeType value();
 }

diff --git a/jaxrs-api/src/main/java/javax/ws/rs/CookieParam.java b/jaxrs-api/src/main/java/javax/ws/rs/CookieParam.java
@@ -37,7 +37,7 @@
  * <li>Have a static method named {@code valueOf} or {@code fromString}
  * that accepts a single String argument (see, for example, {@link Integer#valueOf(String)})</li>
  * <li>Have a registered implementation of {@link javax.ws.rs.ext.ParamConverterProvider}
- * JAX-RS extension SPI that returns a {@link javax.ws.rs.ext.ParamConverter}
+ * that returns a {@link javax.ws.rs.ext.ParamConverter}
  * instance capable of a "from string" conversion for the type.</li>
  * <li>Be {@code List<T>}, {@code Set<T>} or
  * {@code SortedSet<T>}, where {@code T} satisfies 2, 3, 4 or 5 above.

diff --git a/jaxrs-api/src/main/java/javax/ws/rs/FormParam.java b/jaxrs-api/src/main/java/javax/ws/rs/FormParam.java
@@ -38,7 +38,7 @@
  * that accepts a single {@code String} argument (see, for example,
  * {@link Integer#valueOf(String)})</li>
  * <li>Have a registered implementation of {@link javax.ws.rs.ext.ParamConverterProvider}
- * JAX-RS extension SPI that returns a {@link javax.ws.rs.ext.ParamConverter}
+ * that returns a {@link javax.ws.rs.ext.ParamConverter}
  * instance capable of a "from string" conversion for the type.</li>
  * <li>Be {@code List<T>}, {@code Set<T>} or
  * {@code SortedSet<T>}, where {@code T} satisfies 2, 3 or 4 above.

diff --git a/jaxrs-api/src/main/java/javax/ws/rs/HeaderParam.java b/jaxrs-api/src/main/java/javax/ws/rs/HeaderParam.java
@@ -36,7 +36,7 @@
  * that accepts a single
  * {@code String} argument (see, for example, {@link Integer#valueOf(String)})</li>
  * <li>Have a registered implementation of {@link javax.ws.rs.ext.ParamConverterProvider}
- * JAX-RS extension SPI that returns a {@link javax.ws.rs.ext.ParamConverter}
+ * that returns a {@link javax.ws.rs.ext.ParamConverter}
  * instance capable of a "from string" conversion for the type.</li>
  * <li>Be {@code List<T>}, {@code Set<T>} or
  * {@code SortedSet<T>}, where {@code T} satisfies 2, 3 or 4 above.

diff --git a/jaxrs-api/src/main/java/javax/ws/rs/MatrixParam.java b/jaxrs-api/src/main/java/javax/ws/rs/MatrixParam.java
@@ -45,7 +45,7 @@
  * that accepts a single
  * {@code String} argument (see, for example, {@link Integer#valueOf(String)})</li>
  * <li>Have a registered implementation of {@link javax.ws.rs.ext.ParamConverterProvider}
- * JAX-RS extension SPI that returns a {@link javax.ws.rs.ext.ParamConverter}
+ * that returns a {@link javax.ws.rs.ext.ParamConverter}
  * instance capable of a "from string" conversion for the type.</li>
  * <li>Be {@code List<T>}, {@code Set<T>} or
  * {@code SortedSet<T>}, where {@code T} satisfies 2, 3 or 4 above.

diff --git a/jaxrs-api/src/main/java/javax/ws/rs/NameBinding.java b/jaxrs-api/src/main/java/javax/ws/rs/NameBinding.java
@@ -50,7 +50,7 @@
  * </pre>
  *
  * At last, the name-binding annotation is applied to the resource method(s) to which the
- * name-bound JAX-RS provider(s) should be bound to:
+ * name-bound provider(s) should be bound to:
  *
  * <pre>
  *  &#64;Path("/")
@@ -65,10 +65,10 @@
  *  }
  * </pre>
  *
- * A name-binding annotation may also be attached to a custom JAX-RS
- * {@link javax.ws.rs.core.Application} subclass. In such case a name-bound JAX-RS provider
+ * A name-binding annotation may also be attached to a custom
+ * {@link javax.ws.rs.core.Application} subclass. In such case a name-bound provider
  * bound by the annotation will be applied to all {@link HttpMethod resource and sub-resource
- * methods} in the JAX-RS application:
+ * methods} in the application:
  *
  * <pre>
  *  <b>&#64;Logged</b>

diff --git a/jaxrs-api/src/main/java/javax/ws/rs/PathParam.java b/jaxrs-api/src/main/java/javax/ws/rs/PathParam.java
@@ -48,7 +48,7 @@
  * that accepts a single
  * String argument (see, for example, {@link Integer#valueOf(String)}).</li>
  * <li>Have a registered implementation of {@link javax.ws.rs.ext.ParamConverterProvider}
- * JAX-RS extension SPI that returns a {@link javax.ws.rs.ext.ParamConverter}
+ * that returns a {@link javax.ws.rs.ext.ParamConverter}
  * instance capable of a "from string" conversion for the type.</li>
  * </ul>
  *

diff --git a/jaxrs-api/src/main/java/javax/ws/rs/Priorities.java b/jaxrs-api/src/main/java/javax/ws/rs/Priorities.java
@@ -17,19 +17,19 @@
 package javax.ws.rs;
 
 /**
- * A collection of built-in priority constants for the JAX-RS components that are supposed to be
+ * A collection of built-in priority constants for the components that are supposed to be
  * ordered based on their {@code javax.annotation.Priority} class-level annotation value when used
- * or applied by JAX-RS runtime.
+ * or applied by the runtime.
  * <p>
- * For example, JAX-RS filters and interceptors are grouped in chains for each of the message
+ * For example, filters and interceptors are grouped in chains for each of the message
  * processing extension points: Pre, PreMatch, Post as well as ReadFrom and WriteTo.
  * Each of these chains is sorted based on priorities which are represented as integer numbers.
  * All chains, except Post, are sorted in ascending order; the lower the number the higher the priority.
  * The Post filter chain is sorted in descending order to ensure that response filters are executed in
  * <em>reverse order</em>.
  * </p>
  * <p>
- * JAX-RS components that belong to the same priority class (same integer value) are executed in an
+ * Components that belong to the same priority class (same integer value) are executed in an
  * implementation-defined manner. By default, when the {@code @Priority} annotation is absent on a component,
  * for which a priority should be applied, the {@link Priorities#USER} priority value is used.
  * </p>