Skip to content

Commit 89f768a

Browse files
authored
Boilerplate spec and Jakarta EE 8 related updates (#184)
1 parent d9eff66 commit 89f768a

File tree

29 files changed

+1075
-102
lines changed

29 files changed

+1075
-102
lines changed

.gitignore

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
1-
.classpath
2-
.project
3-
.settings/
1+
# Maven noise
42
target/
5-
*~
3+
4+
# OSX noise
5+
.DS_Store
6+
7+
# IntelliJ Idea noise
8+
.idea
9+
*.iws
10+
*.ipr
611
*.iml
7-
*nbactions.xml
12+
13+
# Eclipse noise
14+
.settings/
15+
.classpath
16+
.project
17+
18+
# NetBeans noise
19+
nbproject/
20+
21+
# VS Code noise
822
.vscode/
9-
.idea
23+
24+
# Java noise
25+
*.class
26+
*err_pid*.log

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to Eclipse Project for JSON Processing
1+
# Contributing to Jakarta JSON Processing
22

33
Thanks for your interest in this project.
44

NOTICE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Notices for Eclipse Project for JSON Processing
1+
# Notices for Jakarta JSON Processing
22

33
This content is produced and maintained by the Eclipse Project for JSON
44
Processing project.
@@ -7,7 +7,7 @@ Processing project.
77

88
## Trademarks
99

10-
Eclipse Project for JSON Processing is a trademark of the Eclipse Foundation.
10+
Jakarta JSON Processing is a trademark of the Eclipse Foundation.
1111

1212
## Copyright
1313

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
# Jakarta JSON Processing (JSON-P)
44

5-
Jakarta API for JSON Processing provides portable APIs to parse, generate, transform, and query JSON documents. The project is an evolution of [JSR-374](https://jcp.org/en/jsr/detail?id=374) under Jakarta EE umbrella and contains API and a compatible implementation.
5+
Jakarta JSON Processing provides portable APIs to parse, generate, transform, and query JSON documents. This project contains Jakarta JSON Processing specification, API and a compatible implementation.
66

77
## Build
88

99
Use the following command:
10-
```bash
10+
```bash
1111
mvn -U -C clean install -Dnon.final=true
1212
```
1313

@@ -18,5 +18,5 @@ mvn -U -C clean install -Dnon.final=true
1818

1919
## Links
2020

21-
- Official [web site](https://eclipse-ee4j.github.io/jsonp/)
22-
- [Eclipse Project](https://projects.eclipse.org/projects/ee4j.jsonp/)
21+
- [JSON-P official web site](https://eclipse-ee4j.github.io/jsonp)
22+
- [Jakarta JSON Processing @ Eclipse](https://projects.eclipse.org/projects/ee4j.jsonp)

api/pom.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
<artifactId>jakarta.json-api</artifactId>
3232
<packaging>bundle</packaging>
3333
<version>1.2-SNAPSHOT</version>
34-
<name>JSR 374 (JSON Processing) API</name>
35-
<description>API module of JSR 374:Java API for Processing JSON</description>
36-
<url>https://javaee.github.io/jsonp</url>
34+
<name>Jakarta JSON Processing API</name>
35+
<description>Jakarta JSON Processing defines a Java(R) based framework for parsing, generating, transforming, and querying JSON documents.</description>
36+
<url>https://github.com/eclipse-ee4j/jsonp</url>
3737

3838
<properties>
3939
<packages.export>javax.json.*</packages.export>
@@ -121,7 +121,7 @@
121121
<Implementation-Version>${spec.implementation.version}</Implementation-Version>
122122
<Specification-Version>${spec.specification.version}</Specification-Version>
123123
<Export-Package>${packages.export}</Export-Package>
124-
<Bundle-Description>Java API for JSON Processing (JSON-P) ${spec_version}</Bundle-Description>
124+
<Bundle-Description>Jakarta JSON Processing API ${spec_version}</Bundle-Description>
125125
<Specification-Vendor>Oracle</Specification-Vendor>
126126
</instructions>
127127
</configuration>

api/src/main/javadoc/overview.html

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<html>
22
<!--
33
4-
Copyright (c) 2013, 2017 Oracle and/or its affiliates. All rights reserved.
4+
Copyright (c) 2013, 2019 Oracle and/or its affiliates. All rights reserved.
55
66
This program and the accompanying materials are made available under the
77
terms of the Eclipse Public License v. 2.0, which is available at
@@ -18,7 +18,7 @@
1818
-->
1919

2020
<body>
21-
The Java API for JSON Processing provides portable APIs to parse,
21+
Jakarta JSON Processing provides portable APIs to parse,
2222
generate, transform, and query <a href="http://json.org/">JSON</a> using the
2323
streaming API or the object model API.
2424

@@ -41,68 +41,68 @@
4141
The object model generates JSON output by navigating the entire tree at once.
4242

4343
<h2>The Streaming API</h2>
44-
<p>The streaming API is similar to the StAX API for XML and consists of the
45-
interfaces {@link javax.json.stream.JsonParser} and
46-
{@link javax.json.stream.JsonGenerator}. {@code JsonParser}
47-
contains methods to parse JSON data using the streaming model.
44+
<p>The streaming API is similar to the StAX API for XML and consists of the
45+
interfaces {@link javax.json.stream.JsonParser} and
46+
{@link javax.json.stream.JsonGenerator}. {@code JsonParser}
47+
contains methods to parse JSON data using the streaming model.
4848
{@code JsonGenerator} contains methods to write JSON data to an ouptut source.
4949

50-
<p>{@code JsonParser} provides forward, read-only access to
51-
JSON data using the pull parsing programming model. In this model the
52-
application code controls the thread and calls methods in the parser interface
53-
to move the parser forward or to obtain JSON data from the current state of
54-
the parser. Refer to
55-
<a href="javax/json/stream/JsonParser.html#JsonParserExample2">this example</a>
56-
for more details.
50+
<p>{@code JsonParser} provides forward, read-only access to
51+
JSON data using the pull parsing programming model. In this model the
52+
application code controls the thread and calls methods in the parser interface
53+
to move the parser forward or to obtain JSON data from the current state of
54+
the parser. Refer to
55+
<a href="javax/json/stream/JsonParser.html#JsonParserExample2">this example</a>
56+
for more details.
5757

58-
<p>{@code JsonGenerator} provides methods to write JSON to a stream. The
58+
<p>{@code JsonGenerator} provides methods to write JSON to a stream. The
5959
generator writes name/value pairs in JSON objects and values in JSON arrays.
60-
Refer to
61-
<a href="javax/json/stream/JsonGenerator.html#JsonGeneratorExample3">this
62-
example</a> for more details.
60+
Refer to
61+
<a href="javax/json/stream/JsonGenerator.html#JsonGeneratorExample3">this
62+
example</a> for more details.
6363

64-
<p>The streaming API is a low-level API designed to process large amounts of
65-
JSON data efficiently. Other JSON frameworks (such as JSON binding) can be
66-
implemented using this API.</p>
64+
<p>The streaming API is a low-level API designed to process large amounts of
65+
JSON data efficiently. Other JSON frameworks (such as JSON binding) can be
66+
implemented using this API.</p>
6767

6868
<h2>The Object Model API</h2>
69-
<p>The object model API is similar to the DOM API for XML. It is a high-level
70-
API that provides immutable object models for JSON object and array structures.
71-
These JSON structures are represented as object models using the Java types
72-
{@link javax.json.JsonObject} and {@link javax.json.JsonArray}.
73-
{@code JsonObject} provides a {@link java.util.Map} view to access the unordered
69+
<p>The object model API is similar to the DOM API for XML. It is a high-level
70+
API that provides immutable object models for JSON object and array structures.
71+
These JSON structures are represented as object models using the Java types
72+
{@link javax.json.JsonObject} and {@link javax.json.JsonArray}.
73+
{@code JsonObject} provides a {@link java.util.Map} view to access the unordered
7474
collection of zero or more name/value pairs from the model. Similarly,
75-
{@code JsonArray} provides a {@link java.util.List} view to access the ordered
76-
sequence of zero or more values from the model.
75+
{@code JsonArray} provides a {@link java.util.List} view to access the ordered
76+
sequence of zero or more values from the model.
7777

78-
<p>The object model API uses builder patterns to create these object models.
78+
<p>The object model API uses builder patterns to create these object models.
7979
Application code can use the interface {@link javax.json.JsonObjectBuilder}
80-
to create models that represent JSON objects. The resulting model is of type
81-
{@code JsonObject}. Refer to
82-
<a href="javax/json/JsonObjectBuilder.html#JsonObjectBuilderExample1">this example</a>
80+
to create models that represent JSON objects. The resulting model is of type
81+
{@code JsonObject}. Refer to
82+
<a href="javax/json/JsonObjectBuilder.html#JsonObjectBuilderExample1">this example</a>
8383
for more details. Application code can use the interface
84-
{@link javax.json.JsonArrayBuilder} to create models that represent JSON arrays.
85-
The resulting model is of type {@code JsonArray}. Refer to
86-
<a href="javax/json/JsonArrayBuilder.html#JsonArrayBuilderExample1">this example</a>
87-
for more details.
84+
{@link javax.json.JsonArrayBuilder} to create models that represent JSON arrays.
85+
The resulting model is of type {@code JsonArray}. Refer to
86+
<a href="javax/json/JsonArrayBuilder.html#JsonArrayBuilderExample1">this example</a>
87+
for more details.
8888

89-
<p>These object models can also be created from an input source (such as
89+
<p>These object models can also be created from an input source (such as
9090
{@link java.io.InputStream} or {@link java.io.Reader}) using the interface
91-
{@link javax.json.JsonReader}.
92-
<a href="javax/json/JsonReader.html#JsonReaderExample1">This example</a> shows
91+
{@link javax.json.JsonReader}.
92+
<a href="javax/json/JsonReader.html#JsonReaderExample1">This example</a> shows
9393
how to read and create an empty {@code JsonArray} model using the interface
94-
{@code JsonReader}. Similarly, these object models can be written to an output
95-
source (such as {@link java.io.OutputStream} or {@link java.io.Writer}) using
96-
the class {@link javax.json.JsonWriter}.
97-
<a href="javax/json/JsonWriter.html#JsonWriterExample1">This example</a> shows
94+
{@code JsonReader}. Similarly, these object models can be written to an output
95+
source (such as {@link java.io.OutputStream} or {@link java.io.Writer}) using
96+
the class {@link javax.json.JsonWriter}.
97+
<a href="javax/json/JsonWriter.html#JsonWriterExample1">This example</a> shows
9898
how to write an empty {@code JsonObject} model using the interface
9999
{@code JsonWriter}.
100100

101101
<h2>JSON Pointer, JSON Patch, and JSON Merge Patch</h2>
102-
The Java API for JSON Processing supports the latest standard on
102+
The Java API for JSON Processing supports the latest standard on
103103
<a href="http://tools.ietf.org/html/rfc6901">JSON Pointer</a>,
104104
<a Href="http://tools.ietf.org/html/rfc6902">JSON Patch</a>, and
105105
<a Href="http://tools.ietf.org/html/rfc7396">JSON Merge Patch</a>.
106-
106+
107107
</body>
108108
</html>

bundles/pom.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!--
33
4-
Copyright (c) 2013, 2017 Oracle and/or its affiliates. All rights reserved.
4+
Copyright (c) 2013, 2019 Oracle and/or its affiliates. All rights reserved.
55
66
This program and the accompanying materials are made available under the
77
terms of the Eclipse Public License v. 2.0, which is available at
@@ -30,9 +30,9 @@
3030
<groupId>org.glassfish</groupId>
3131
<artifactId>json-bundles</artifactId>
3232
<packaging>pom</packaging>
33-
<name>JSR 374 (JSON Processing) bundles</name>
34-
<description>JSON Processing bundles</description>
35-
<url>https://javaee.github.io/jsonp</url>
33+
<name>Jakarta JSON Processing bundles</name>
34+
<description>Jakarta JSON Processing bundles</description>
35+
<url>https://github.com/eclipse-ee4j/jsonp</url>
3636

3737
<modules>
3838
<module>ri</module>

bundles/ri/src/main/resources/README.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
* standalone/jakarta.json-${project.version}.jar contains both "JSR 374 : Java API for JSON Processing 1.1" API
1+
* standalone/jakarta.json-${project.version}.jar contains both "Jakarta JSON Processing 1.1" API
22
and its default provider implementation. Keep it in classpath for both compiling and running your application.
33
Automatic module name is: 'java.json'
44

55
For running on JPMS, following modules are provided:
66
* mods/jakarta.json-api-${project.version}.jar - 'java.json' module containing only API classes
77
* mods/jakarta.json-${project.version}-module.jar - 'org.glassfish.java.json' module containing implementation
88

9-
Integration with JAX-RS: Java API for RESTful Web Services (JAX-RS) is provided through
9+
Integration with Jakarta RESTful Web Services: Jakarta RESTful Web Services is provided through
1010
* jaxrs/jsonp-jaxrs-${project.version}.jar
1111

1212

@@ -37,15 +37,15 @@ for implementation only:
3737
<version>${project.version}</version>
3838
</dependency>
3939

40-
for JAX-RS integration module:
40+
for Jakarta RESTful Web Services integration module:
4141
<dependency>
4242
<groupId>org.glassfish</groupId>
4343
<artifactId>jsonp-jaxrs</artifactId>
4444
<version>${project.version}</version>
4545
</dependency>
4646

4747

48-
* GlassFish 5.x already bundles latest JSON Processing implementation and JAX-RS integration module.
48+
* GlassFish 5.x already bundles latest Jakarta JSON Processing implementation and Jakarta RESTful Web Services integration module.
4949
If you deploy an application with GlassFish 5.x, your application (war/ear) doesn't have to bundle APIs nor the ri jar.
5050

5151
* Samples can be run from https://github.com/javaee/glassfish-samples

demos/jaxrs/src/main/java/org/glassfish/jsondemos/jaxrs/ArrayResource.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2012, 2017 Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2012, 2019 Oracle and/or its affiliates. All rights reserved.
33
*
44
* This program and the accompanying materials are made available under the
55
* terms of the Eclipse Distribution License v. 1.0, which is available at
@@ -15,7 +15,7 @@
1515
import javax.ws.rs.core.MediaType;
1616

1717
/**
18-
* JsonArray as parameter and return type for a JAX-RS resource
18+
* JsonArray as parameter and return type for a Jakarta RESTful Web Services resource
1919
*
2020
* @author Jitendra Kotamraju
2121
*/

demos/jaxrs/src/main/java/org/glassfish/jsondemos/jaxrs/DemoApplication.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2012, 2017 Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2012, 2019 Oracle and/or its affiliates. All rights reserved.
33
*
44
* This program and the accompanying materials are made available under the
55
* terms of the Eclipse Distribution License v. 1.0, which is available at
@@ -19,7 +19,7 @@
1919
import java.util.Set;
2020

2121
/**
22-
* A JAX-RS Demo Application using JSON API
22+
* A Jakarta RESTful Web Services Demo Application
2323
*
2424
* @author Jitendra Kotamraju
2525
*/

0 commit comments

Comments
 (0)