JsonSuport with correctly named factory method.

tomas-langer · tomas-langer · commit 5a324373be3b · 2019-01-09T19:50:52.000+01:00
HeatlhSupport with new factory methods.

Signed-off-by: Tomas Langer &lt;tomas.langer@oracle.com&gt;
diff --git a/docs/src/main/docs/webserver/08_json-support.adoc b/docs/src/main/docs/webserver/08_json-support.adoc
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 
-    Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+    Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
@@ -46,7 +46,7 @@ Then you can add routes that handle and return JSON.
 .Configure JsonSupport and use it for reading and writing of entities
 ----
 Routing.builder()
-       .register(JsonSupport.get()) // <1>
+       .register(JsonSupport.create()) // <1>
        .post("/sayhello", Handler.of(JsonObject.class, this::sayHello)) // <2>
        .build();
 ----
diff --git a/examples/guides/se-restful-webservice/src/main/docs/index.adoc b/examples/guides/se-restful-webservice/src/main/docs/index.adoc
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 
-    Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+    Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
@@ -491,7 +491,7 @@ include::{main-class}[tag=initMetrics]
 ----
 <1> Initializes the metrics infrastructure in Helidon.
 
-... Just after the invocation of `register(JsonSupport.get())`
+... Just after the invocation of `register(JsonSupport.create())`
 add this
 +
 [source,java]
diff --git a/examples/guides/se-restful-webservice/src/main/java-start/io/helidon/guides/se/restfulwebservice/Main.java b/examples/guides/se-restful-webservice/src/main/java-start/io/helidon/guides/se/restfulwebservice/Main.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,7 +42,7 @@ private Main() { }
      */
     private static Routing createRouting() {
         return Routing.builder()
-                .register(JsonSupport.get())
+                .register(JsonSupport.create())
                 .register("/greet", new GreetService())
                 .build();
     }
diff --git a/examples/guides/se-restful-webservice/src/main/java/io/helidon/guides/se/restfulwebservice/Main.java b/examples/guides/se-restful-webservice/src/main/java/io/helidon/guides/se/restfulwebservice/Main.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -74,7 +74,7 @@ private static Routing createRouting() {
     // tag::createRoutingBasic[]
         greetService = new GreetService(); // <1>
         return Routing.builder()
-                .register(JsonSupport.get()) // <2>
+                .register(JsonSupport.create()) // <2>
     // end::createRoutingBasic[]
     // tag::registerMetrics[]
                 .register(metrics) // <1>
diff --git a/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java b/examples/quickstarts/helidon-quickstart-se/src/main/java/io/helidon/examples/quickstart/se/Main.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -85,7 +85,7 @@ static WebServer startServer() throws IOException {
      */
     private static Routing createRouting(Config config) {
         return Routing.builder()
-                .register(JsonSupport.get())
+                .register(JsonSupport.create())
                 .register("/greet", new GreetService(config))
                 .build();
     }
diff --git a/examples/todo-app/demo-frontend/src/main/java/io/helidon/demo/todos/frontend/TodosHandler.java b/examples/todo-app/demo-frontend/src/main/java/io/helidon/demo/todos/frontend/TodosHandler.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -100,7 +100,7 @@ private Metadata counterMetadata(String name, String description) {
     @Override
     public void update(final Routing.Rules rules) {
         rules
-                .any(JsonSupport.get())
+                .any(JsonSupport.create())
                 .get("/todo/{id}", this::getSingle)
                 .delete("/todo/{id}", this::delete)
                 .put("/todo/{id}", this::update)
diff --git a/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Main.java b/examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/Main.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -268,7 +268,7 @@ public void filterAndProcessEntity() {
     public void supports() {
         Routing routing = Routing.builder()
                                  .register(StaticContentSupport.create("/static"))
-                                 .register("/hello", JsonSupport.get())
+                                 .register("/hello", JsonSupport.create())
                                  .get("/hello/{what}", (req, res) -> res.send(Json.createObjectBuilder()
                                                                                   .add("message",
                                                                                        "Hello " + req.path()
diff --git a/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/CounterService.java b/examples/webserver/static-content/src/main/java/io/helidon/webserver/examples/staticcontent/CounterService.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,7 +39,7 @@ public class CounterService implements Service {
     @Override
     public void update(Routing.Rules routingRules) {
         routingRules.any(this::handleAny)
-                    .register("/api", JsonSupport.get())
+                    .register("/api", JsonSupport.create())
                     .get("/api/counter", this::handleGet);
     }
 
diff --git a/health/health/src/main/java/io/helidon/health/HealthSupport.java b/health/health/src/main/java/io/helidon/health/HealthSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -71,7 +71,7 @@ private HealthSupport(Builder builder) {
 
     @Override
     public void update(Routing.Rules rules) {
-        rules.get(webContext, JsonSupport.get())
+        rules.get(webContext, JsonSupport.create())
                 .get(webContext, (req, res) -> {
                     HealthResponse hres = callHealthChecks();
 
@@ -158,6 +158,28 @@ public static Builder builder() {
         return new Builder();
     }
 
+    /**
+     * Create a new HealthSupport with no health checks configured.
+     * The endpoint will always return {@code UP}.
+     *
+     * @return health support configured with no health checks
+     */
+    public static HealthSupport create(){
+        return builder().build();
+    }
+
+    /**
+     * Create a new HealthSupport with no health checks, configured from provided config.
+     * The endpoint will always return {@code UP}.
+     *
+     * @param config configuration of this health check, used only to get {@code web-context} property to configure
+     *      {@link Builder#webContext(String)}
+     * @return health support configured with no health checks
+     */
+    public static HealthSupport create(Config config) {
+        return builder().config(config).build();
+    }
+
     /**
      * Fluent API builder for {@link io.helidon.health.HealthSupport}.
      */
diff --git a/metrics/metrics/src/main/java/io/helidon/metrics/MetricsSupport.java b/metrics/metrics/src/main/java/io/helidon/metrics/MetricsSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -285,7 +285,7 @@ public void update(Routing.Rules rules) {
         });
 
         rules.anyOf(CollectionsHelper.listOf(Http.Method.GET, Http.Method.OPTIONS),
-                    JsonSupport.get());
+                    JsonSupport.create());
 
         // routing to root of metrics
         rules.get(context, (req, res) -> getMultiple(req, res, base, app, vendor))
diff --git a/webserver/json/src/main/java/io/helidon/webserver/json/JsonSupport.java b/webserver/json/src/main/java/io/helidon/webserver/json/JsonSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -60,21 +60,21 @@
  * with {@link JsonStructure JSON} objects.
  *
  * <h3>Get Instance</h3>
- * Use factory methods {@link #get()} or {@link #create(Map)} to acquire an instance.
+ * Use factory methods {@link #create()} or {@link #create(Map)} to acquire an instance.
  *
  * <h3>Usage with Routing</h3>
  * {@code JsonSupport} should be registered on the routing before any business logic handlers.
  * <pre>{@code
  * Routing.builder()
- *        .register(JsonSupport.get())
+ *        .register(JsonSupport.create())
  *        .etc.... // Business logic related handlers
  * }</pre>
  * Instance behaves also as a routing filter. It means that it can be registered on any routing rule (for example HTTP method)
  * and then it can be used in following handlers with compatible rules.
  * <pre>{@code
  * // Register JsonSupport only for POST of 'foo'
  * Routing.builder()
- *        .post("/foo/{}", JsonSupport.get())
+ *        .post("/foo/{}", JsonSupport.create())
  *        .post("/foo/bar", ...) // It can use JSON structures
  *        .get("/foo/bar", ...);  // It can NOT use JSON structures
  * }</pre>
@@ -116,7 +116,7 @@ private JsonSupport(Map<String, ?> config) {
      * {@link Http.Method HTTP method}.
      * <p>
      * This method is called from {@link Routing} during build process. The user should register whole class
-     * ot the routing: {@code Routing.builder().}{@link Routing.Builder#register(Service...) register}{@code (JsonSupport.get())}.
+     * ot the routing: {@code Routing.builder().}{@link Routing.Builder#register(Service...) register}{@code (JsonSupport.create())}.
      *
      * @param routingRules a routing configuration where JSON support should be registered
      * @see Routing
@@ -132,7 +132,7 @@ public void update(Routing.Rules routingRules) {
      * <p>
      * This method is called from {@link Routing} during build process. The user should register whole class
      * ot the routing criteria. For example: {@code Routing.builder().}
-     * {@link Routing.Builder#post(String, Handler...) post}{@code ("/foo", JsonSupport.get())}.
+     * {@link Routing.Builder#post(String, Handler...) post}{@code ("/foo", JsonSupport.create())}.
      * <p>
      * It calls {@code ServerRequest.}{@link ServerRequest#next() next()} method to invoke following handlers with
      * particular business logic.
@@ -302,7 +302,7 @@ public Function<JsonStructure, Flow.Publisher<DataChunk>> writer() {
      *
      * @return a singleton instance with default configuration
      */
-    public static JsonSupport get() {
+    public static JsonSupport create() {
         return DefaultJsonSupportHolder.INSTANCE;
     }
 
@@ -315,7 +315,7 @@ public static JsonSupport get() {
      */
     public static JsonSupport create(Map<String, ?> config) {
         if (config == null || config.isEmpty()) {
-            return get();
+            return create();
         } else {
             return new JsonSupport(config);
         }
diff --git a/webserver/json/src/test/java/io/helidon/webserver/json/JsonContentReaderTest.java b/webserver/json/src/test/java/io/helidon/webserver/json/JsonContentReaderTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -46,7 +46,7 @@ public class JsonContentReaderTest {
     public void simpleJsonObject() throws Exception {
         Flux<DataChunk> flux = Flux.just("{ \"p\" : \"val\" }").map(s -> DataChunk.create(s.getBytes()));
 
-        CompletionStage<? extends JsonObject> stage = JsonSupport.get()
+        CompletionStage<? extends JsonObject> stage = JsonSupport.create()
                                                                  .reader()
                                                                  .applyAndCast(ReactiveStreamsAdapter.publisherToFlow(flux), JsonObject.class);
 
@@ -58,7 +58,7 @@ public void simpleJsonObject() throws Exception {
     public void incompatibleTypes() throws Exception {
         Flux<DataChunk> flux = Flux.just("{ \"p\" : \"val\" }").map(s -> DataChunk.create(s.getBytes()));
 
-        CompletionStage<? extends JsonArray> stage = JsonSupport.get()
+        CompletionStage<? extends JsonArray> stage = JsonSupport.create()
                 .reader()
                 .applyAndCast(ReactiveStreamsAdapter.publisherToFlow(flux), JsonArray.class);
 
@@ -77,7 +77,7 @@ public void incompatibleTypes() throws Exception {
     public void simpleJsonArray() throws Exception {
         Flux<DataChunk> flux = Flux.just("[ \"val\" ]").map(s -> DataChunk.create(s.getBytes()));
 
-        CompletionStage<? extends JsonArray> stage = JsonSupport.get()
+        CompletionStage<? extends JsonArray> stage = JsonSupport.create()
                 .reader()
                 .applyAndCast(ReactiveStreamsAdapter.publisherToFlow(flux), JsonArray.class);
 
@@ -89,7 +89,7 @@ public void simpleJsonArray() throws Exception {
     public void invalidJson() throws Exception {
         Flux<DataChunk> flux = Flux.just("{ \"p\" : \"val\" ").map(s -> DataChunk.create(s.getBytes()));
 
-        CompletionStage<? extends JsonObject> stage = JsonSupport.get()
+        CompletionStage<? extends JsonObject> stage = JsonSupport.create()
                 .reader()
                 .applyAndCast(ReactiveStreamsAdapter.publisherToFlow(flux), JsonObject.class);
         try {
@@ -103,7 +103,7 @@ public void invalidJson() throws Exception {
 
     @Test
     public void defaultJsonSupportAsSingleton() {
-        assertThat(JsonSupport.get(), sameInstance(JsonSupport.get()));
+        assertThat(JsonSupport.create(), sameInstance(JsonSupport.create()));
         assertThat(JsonSupport.create(null), sameInstance(JsonSupport.create(null)));
     }
 }
diff --git a/webserver/json/src/test/java/io/helidon/webserver/json/JsonSupportTest.java b/webserver/json/src/test/java/io/helidon/webserver/json/JsonSupportTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -50,7 +50,7 @@ private JsonObject createJson() {
     @Test
     public void pingPong() throws Exception {
         Routing routing = Routing.builder()
-                                 .register(JsonSupport.get())
+                                 .register(JsonSupport.create())
                                  .post("/foo", Handler.create(JsonObject.class, (req, res, json) -> res.send(json)))
                                  .build();
         JsonObject json = createJson();
@@ -68,7 +68,7 @@ public void pingPong() throws Exception {
     @Test
     public void invalidJson() throws Exception {
         Routing routing = Routing.builder()
-                .register(JsonSupport.get())
+                .register(JsonSupport.create())
                 .post("/foo", Handler.create(JsonObject.class, (req, res, json) -> res.send(json)))
                 .build();
         TestResponse response = TestClient.create(routing)
@@ -94,7 +94,7 @@ public void explicitJsonSupportRegistrationMissingJsonProperty() throws Exceptio
     @Test
     public void acceptHeaders() throws Exception {
         Routing routing = Routing.builder()
-                .register(JsonSupport.get())
+                .register(JsonSupport.create())
                 .post("/foo", Handler.create(JsonObject.class, (req, res, json) -> res.send(json)))
                 .build();
         JsonObject json = createJson();

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.`
	`2`	`+ * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -39,7 +39,7 @@ public class CounterService implements Service {`
`39`	`39`	`@Override`
`40`	`40`	`public void update(Routing.Rules routingRules) {`
`41`	`41`	`routingRules.any(this::handleAny)`
`42`		`- .register("/api", JsonSupport.get())`
	`42`	`+ .register("/api", JsonSupport.create())`
`43`	`43`	`.get("/api/counter", this::handleGet);`
`44`	`44`	`}`
`45`	`45`