Skip to content

Commit 0981edb

Browse files
jknackjknack
committed
jackson2: deprecate JacksonModule in favor of Jackson2Module
- fix #3898
1 parent fe731ee commit 0981edb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+472
-293
lines changed

‎docs/asciidoc/modules/avaje-jsonb.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ import io.jooby.avaje.jsonb.AvajeJsonbModule
8181
import io.avaje.jsonb.Jsonb
8282
8383
{
84-
install(JacksonModule())
84+
install(Jackson2Module())
8585
8686
val jsonb = require<Jsonb>()
8787
}

‎docs/asciidoc/modules/graphql.adoc‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ type Author {
3636
.Java
3737
[source, java, role="primary"]
3838
----
39-
import io.jooby.json.JacksonModule;
39+
import io.jooby.json.Jackson2Module;
4040
import io.jooby.graphql.GraphQLModule;
4141
4242
{
43-
install(new JacksonModule()); <1>
43+
install(new Jackson2Module()); <1>
4444
4545
install(new GraphQLModule(
4646
RuntimeWiring.newRuntimeWiring() <2>
@@ -56,11 +56,11 @@ import io.jooby.graphql.GraphQLModule;
5656
.Kotlin
5757
[source, kt, role="secondary"]
5858
----
59-
import io.jooby.json.JacksonModule
59+
import io.jooby.json.Jackson2Module
6060
import io.jooby.graphql.GraphQLModule
6161
6262
{
63-
install(JacksonModule()) <1>
63+
install(Jackson2Module()) <1>
6464
6565
install(GraphQLModule(
6666
RuntimeWiring.newRuntimeWiring() <2>
@@ -88,7 +88,7 @@ the async mode:
8888
.Async Mode
8989
[source, java, role="primary"]
9090
----
91-
import io.jooby.json.JacksonModule;
91+
import io.jooby.json.Jackson2Module;
9292
import io.jooby.graphql.GraphQLModule;
9393
9494
{
@@ -101,7 +101,7 @@ import io.jooby.graphql.GraphQLModule;
101101
.Kotlin
102102
[source, kt, role="secondary"]
103103
----
104-
import io.jooby.json.JacksonModule
104+
import io.jooby.json.Jackson2Module
105105
import io.jooby.graphql.GraphQLModule
106106
107107
{
@@ -122,7 +122,7 @@ By default the module only install a HTTP POST route. If you want a HTTP GET:
122122
.HTTP GET
123123
[source, java, role="primary"]
124124
----
125-
import io.jooby.json.JacksonModule;
125+
import io.jooby.json.Jackson2Module;
126126
import io.jooby.graphql.GraphQLModule;
127127
128128
{
@@ -135,7 +135,7 @@ import io.jooby.graphql.GraphQLModule;
135135
.Kotlin
136136
[source, kt, role="secondary"]
137137
----
138-
import io.jooby.json.JacksonModule
138+
import io.jooby.json.Jackson2Module
139139
import io.jooby.graphql.GraphQLModule
140140
141141
{
@@ -170,12 +170,12 @@ They are provided as optional dependencies.
170170
.Java
171171
[source, java, role="primary"]
172172
----
173-
import io.jooby.json.JacksonModule;
173+
import io.jooby.json.Jackson2Module;
174174
import io.jooby.graphql.GraphQLModule;
175175
import io.jooby.graphql.GraphiQLModule;
176176
177177
{
178-
install(new JacksonModule()); <1>
178+
install(new Jackson2Module()); <1>
179179
180180
install(new GraphQLModule(...)); <2>
181181
@@ -186,12 +186,12 @@ import io.jooby.graphql.GraphiQLModule;
186186
.Kotlin
187187
[source, kt, role="secondary"]
188188
----
189-
import io.jooby.json.JacksonModule
189+
import io.jooby.json.Jackson2Module
190190
import io.jooby.graphql.GraphQLModule
191191
import io.jooby.graphql.GraphiQLModule
192192
193193
{
194-
install(JacksonModule()) <1>
194+
install(Jackson2Module()) <1>
195195
196196
install(GraphQLModule(...)) <2>
197197
@@ -217,12 +217,12 @@ https://github.com/graphql/graphiql[GraphiQL] should be up and running at `/grap
217217
.Java
218218
[source, java, role="primary"]
219219
----
220-
import io.jooby.json.JacksonModule;
220+
import io.jooby.json.Jackson2Module;
221221
import io.jooby.graphql.GraphQLModule;
222222
import io.jooby.graphql.GraphQLPlaygroundModule;
223223
224224
{
225-
install(new JacksonModule()); <1>
225+
install(new Jackson2Module()); <1>
226226
227227
install(new GraphQLModule(...)); <2>
228228
@@ -233,12 +233,12 @@ import io.jooby.graphql.GraphQLPlaygroundModule;
233233
.Kotlin
234234
[source, kt, role="secondary"]
235235
----
236-
import io.jooby.json.JacksonModule
236+
import io.jooby.json.Jackson2Module
237237
import io.jooby.graphql.GraphQLModule
238238
import io.jooby.graphql.GraphQLPlaygroundModule
239239
240240
{
241-
install(JacksonModule()) <1>
241+
install(Jackson2Module()) <1>
242242
243243
install(GraphQLModule(...)) <2>
244244

‎docs/asciidoc/modules/hibernate-validator.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ It is possible to override the `title` and `status` code of the response above:
191191
----
192192
193193
{
194-
install(new JacksonModule());
194+
install(new Jackson2Module());
195195
install(new HibernateValidatorModule()
196196
.statusCode(StatusCode.BAD_REQUEST)
197197
.validationTitle("Incorrect input data")
@@ -205,7 +205,7 @@ If the default error handler doesn't fully meet your needs, you can always disab
205205
----
206206
207207
{
208-
install(new JacksonModule());
208+
install(new Jackson2Module());
209209
install(new HibernateValidatorModule().disableViolationHandler());
210210
211211
error(ConstraintViolationException.class, new MyConstraintViolationHandler());

‎docs/asciidoc/modules/jackson2.adoc‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ JSON support using https://github.com/FasterXML/jackson[Jackson 2] library.
1414
.Java
1515
[source, java, role="primary"]
1616
----
17-
import io.jooby.jackson.JacksonModule;
17+
import io.jooby.jackson.Jackson2Module;
1818
1919
{
20-
install(new JacksonModule()); <1>
20+
install(new Jackson2Module()); <1>
2121
2222
get("/", ctx -> {
2323
MyObject myObject = ...;
@@ -34,10 +34,10 @@ import io.jooby.jackson.JacksonModule;
3434
.Kotlin
3535
[source, kt, role="secondary"]
3636
----
37-
import io.jooby.jackson.JacksonModule;
37+
import io.jooby.jackson.Jackson2Module;
3838
3939
{
40-
install(JacksonModule()) <1>
40+
install(Jackson2Module()) <1>
4141
4242
get("/") {
4343
val myObject = ...;
@@ -62,10 +62,10 @@ Access to default object mapper is available via require call:
6262
.Default object mapper
6363
[source, java, role="primary"]
6464
----
65-
import io.jooby.jackson.JacksonModule;
65+
import io.jooby.jackson.Jackson2Module;
6666
6767
{
68-
install(new JacksonModule());
68+
install(new Jackson2Module());
6969
7070
ObjectMapper mapper = require(ObjectMapper.class);
7171
@@ -76,10 +76,10 @@ import io.jooby.jackson.JacksonModule;
7676
.Kotlin
7777
[source, kt, role="secondary"]
7878
----
79-
import io.jooby.jackson.JacksonModule
79+
import io.jooby.jackson.Jackson2Module
8080
8181
{
82-
install(JacksonModule())
82+
install(Jackson2Module())
8383
8484
val mapper = require<ObjectMapper>()
8585
}
@@ -90,46 +90,46 @@ You can provide your own `ObjectMapper`:
9090
.Custom ObjectMapper
9191
[source, java, role="primary"]
9292
----
93-
import io.jooby.jackson.JacksonModule;
93+
import io.jooby.jackson.Jackson2Module;
9494
9595
{
9696
ObjectMapper mapper = new ObjectMapper();
9797
98-
install(new JacksonModule(mapper));
98+
install(new Jackson2Module(mapper));
9999
}
100100
----
101101

102102
.Kotlin
103103
[source, kt, role="secondary"]
104104
----
105-
import io.jooby.jackson.JacksonModule
105+
import io.jooby.jackson.Jackson2Module
106106
107107
{
108108
val mapper = ObjectMapper()
109109
110-
install(JacksonModule(mapper))
110+
install(Jackson2Module(mapper))
111111
}
112112
----
113113

114-
This allows to configure JacksonModule for doing `xml` processing:
114+
This allows to configure Jackson2Module for doing `xml` processing:
115115

116116
.XmlMapper
117117
[source, java, role="primary"]
118118
----
119-
import io.jooby.jackson.JacksonModule;
119+
import io.jooby.jackson.Jackson2Module;
120120
121121
{
122-
install(new JacksonModule(new XmlMapper()));
122+
install(new Jackson2Module(new XmlMapper()));
123123
}
124124
----
125125

126126
.Kotlin
127127
[source, kt, role="secondary"]
128128
----
129-
import io.jooby.jackson.JacksonModule
129+
import io.jooby.jackson.Jackson2Module
130130
131131
{
132-
install(JacksonModule(XmlMapper()))
132+
install(Jackson2Module(XmlMapper()))
133133
}
134134
----
135135

@@ -138,22 +138,22 @@ If you want `json` and `xml` processing then install twice:
138138
.XmlMapper
139139
[source, java, role="primary"]
140140
----
141-
import io.jooby.jackson.JacksonModule;
141+
import io.jooby.jackson.Jackson2Module;
142142
143143
{
144-
install(new JacksonModule(new ObjectMapper()));
145-
install(new JacksonModule(new XmlMapper()));
144+
install(new Jackson2Module(new ObjectMapper()));
145+
install(new Jackson2Module(new XmlMapper()));
146146
}
147147
----
148148

149149
.Kotlin
150150
[source, kt, role="secondary"]
151151
----
152-
import io.jooby.jackson.JacksonModule
152+
import io.jooby.jackson.Jackson2Module
153153
154154
{
155-
install(JacksonModule(ObjectMapper()))
156-
install(JacksonModule(XmlMapper()))
155+
install(Jackson2Module(ObjectMapper()))
156+
install(Jackson2Module(XmlMapper()))
157157
}
158158
----
159159

@@ -164,20 +164,20 @@ Jackson module can be provided by a link:{uiVersion}/#ecosystem-services-and-the
164164
.Provisioning Modules
165165
[source, java, role="primary"]
166166
----
167-
import io.jooby.jackson.JacksonModule;
167+
import io.jooby.jackson.Jackson2Module;
168168
169169
{
170-
install(new JacksonModule().module(MyModule.class);
170+
install(new Jackson2Module().module(MyModule.class);
171171
}
172172
----
173173

174174
.Kotlin
175175
[source, kt, role="secondary"]
176176
----
177-
import io.jooby.jackson.JacksonModule
177+
import io.jooby.jackson.Jackson2Module
178178
179179
{
180-
install(JacksonModule().module(MyModule::class.java)
180+
install(Jackson2Module().module(MyModule::class.java)
181181
}
182182
----
183183

‎docs/asciidoc/modules/json-rpc.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The JSON-RPC extension delegates payload parsing and serialization to Jooby's st
9999

100100
Supported engines include:
101101

102-
* **Jackson 2**: `JacksonModule`, `JsonRpcJackson2Module`
102+
* **Jackson 2**: `Jackson2Module`, `JsonRpcJackson2Module`
103103
* **Jackson 3**: `Jackson3Module`, `JsonRpcJackson3Module`
104104
* **Avaje JSON-B**: `AvajeJsonbModule`, `JsonRpcAvajeJsonbModule`
105105

‎docs/asciidoc/modules/mcp.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ import io.jooby.mcp.McpModule
8080
}
8181
----
8282

83-
<1> Install JSON support (Jackson is required for MCP JSON-RPC serialization). For Jackson 2, use `JacksonModule()` instead.
83+
<1> Install JSON support (Jackson is required for MCP JSON-RPC serialization). For Jackson 2, use `Jackson2Module()` instead.
8484
<2> Install MCP JSON support. For Jackson 2, use `McpJackson2Module()` instead.
8585
<3> Install the MCP module with the APT-generated `McpService` dispatcher. The generated class always ends with the `Mcp_` suffix.
8686

‎docs/asciidoc/modules/tRPC.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Installing tRPC in your Jooby app is a 3-step process. Because tRPC relies heavi
1717
[source,java,role="primary"]
1818
----
1919
import io.jooby.Jooby;
20-
import io.jooby.json.JacksonModule;
20+
import io.jooby.json.Jackson2Module;
2121
import io.jooby.trpc.TrpcModule;
2222
import io.jooby.trpc.TrpcJackson2Module;
2323
@@ -34,7 +34,7 @@ import io.jooby.trpc.TrpcJackson2Module;
3434
[source,kotlin,role="secondary"]
3535
----
3636
import io.jooby.kt.Kooby
37-
import io.jooby.json.JacksonModule
37+
import io.jooby.json.Jackson2Module
3838
import io.jooby.trpc.TrpcModule
3939
import io.jooby.trpc.TrpcJackson2Module
4040
@@ -47,7 +47,7 @@ import io.jooby.trpc.TrpcJackson2Module
4747
}
4848
----
4949

50-
1. Install a supported JSON engine (`Jackson3Module`, `JacksonModule` for Jackson 2, or `AvajeJsonbModule`).
50+
1. Install a supported JSON engine (`Jackson3Module`, `Jackson2Module` for Jackson 2, or `AvajeJsonbModule`).
5151
2. Install the corresponding bridge module (`TrcJackson3Module`, `TrpcJackson2Module`, or `TrpcAvajeJsonbModule`).
5252
3. Install the core tRPC extension (`TrpcModule`).
5353
4. Register your `@Trpc` annotated controllers (using the APT generated route).

0 commit comments

Comments
 (0)