What you’ll learn
- What is CDI?
Handling dependencies in the application
- Managing scopes and contexts
- Injecting a dependency
Testing the inventory application
Great work! You’re done!

Injecting dependencies into microservices

15 minutes

Prerequisites:

Table of contents

Learn how to use Contexts and Dependency Injection (CDI) to manage scopes and inject dependencies into microservices.

What you’ll learn

You will learn how to use Contexts and Dependency Injection (CDI) to manage scopes and inject dependencies in a simple inventory management application.

The application that you will be working with is an inventory service, which stores the information about various JVMs that run on different systems. Whenever a request is made to the inventory service to retrieve the JVM system properties of a particular host, the inventory service communicates with the system service on that host to get these system properties. The system properties are then stored and returned.

You will use scopes to bind objects in this application to their well-defined contexts. CDI provides a variety of scopes for you to work with and while you will not use all of them in this guide, there is one for almost every scenario that you may encounter. Scopes are defined by using CDI annotations. You will also use dependency injection to inject one bean into another to make use of its functionalities. This enables you to inject the bean in its specified context without having to instantiate it yourself.

The implementation of the application and its services are provided for you in the start/src directory. The system service can be found in the start/src/main/java/io/openliberty/guides/system directory, and the inventory service can be found in the start/src/main/java/io/openliberty/guides/inventory directory. If you want to learn more about RESTful web services and how to build them, see Creating a RESTful web service for details about how to build the system service. The inventory service is built in a similar way.

What is CDI?

Contexts and Dependency Injection (CDI) defines a rich set of complementary services that improve the application structure. The most fundamental services that are provided by CDI are contexts that bind the lifecycle of stateful components to well-defined contexts, and dependency injection that is the ability to inject components into an application in a typesafe way. With CDI, the container does all the daunting work of instantiating dependencies, and controlling exactly when and how these components are instantiated and destroyed.

Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/OpenLiberty/guides-common/maven-gradle/gitclone.adoc[]

Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/OpenLiberty/guides-common/maven-gradle/twyb-intro.adoc[]

Point your browser to the http://localhost:9080/inventory/systems URL. This is the starting point of the inventory service and it displays the current contents of the inventory. As you might expect, these are empty since nothing is stored in the inventory yet. Next, point your browser to the http://localhost:9080/inventory/systems/localhost URL. You see a result in JSON format with the system properties of your local JVM. When you visit this URL, these system properties are automatically stored in the inventory. Go back to http://localhost:9080/inventory/systems and you see a new entry for localhost. For simplicity, only the OS name and username are shown here for each host. You can repeat this process for your own hostname or any other machine that is running the system service.

Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/OpenLiberty/guides-common/maven-gradle/twyb-end.adoc[]

Handling dependencies in the application

You will use CDI to inject dependencies into the inventory manager application and learn how to manage the life cycles of your objects.

Managing scopes and contexts

Navigate to the start directory to begin.

Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/OpenLiberty/guides-common/maven-gradle/devmode-lmp33-start.adoc[]

Create the InventoryManager class.
src/main/java/io/openliberty/guides/inventory/InventoryManager.java

InventoryManager.java

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 2019 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License v1.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-v10.html
 8 *
 9 * Contributors:
10 *     IBM Corporation - Initial implementation
11 *******************************************************************************/
12// end::copyright[]
13package io.openliberty.guides.inventory;
14
15import java.util.ArrayList;
16import java.util.Collections;
17import java.util.List;
18import java.util.Properties;
19import io.openliberty.guides.inventory.model.InventoryList;
20import io.openliberty.guides.inventory.model.SystemData;
21import javax.enterprise.context.ApplicationScoped;
22
23// tag::ApplicationScoped[]
24@ApplicationScoped
25// end::ApplicationScoped[]
26public class InventoryManager {
27
28  private List<SystemData> systems = Collections.synchronizedList(new ArrayList<>());
29
30  // tag::add[]
31  public void add(String hostname, Properties systemProps) {
32    Properties props = new Properties();
33    props.setProperty("os.name", systemProps.getProperty("os.name"));
34    props.setProperty("user.name", systemProps.getProperty("user.name"));
35
36    SystemData system = new SystemData(hostname, props);
37    if (!systems.contains(system)) {
38      systems.add(system);
39    }
40  }
41  // end::add[]
42
43  // tag::list[]
44  public InventoryList list() {
45    return new InventoryList(systems);
46  }
47  // end::list[]
48}

This bean contains two simple functions. The add() function is for adding entries to the inventory. The list() function is for listing all the entries currently stored in the inventory.

This bean must be persistent between all of the clients, which means multiple clients need to share the same instance. To achieve this by using CDI, you can simply add the @ApplicationScoped annotation onto the class.

This annotation indicates that this particular bean is to be initialized once per application. By making it application-scoped, the container ensures that the same instance of the bean is used whenever it is injected into the application.

Create the InventoryResource class.
src/main/java/io/openliberty/guides/inventory/InventoryResource.java

InventoryResource.java

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 2020 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License v1.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-v10.html
 8 *
 9 * Contributors:
10 *     IBM Corporation - Initial implementation
11 *******************************************************************************/
12// end::copyright[]
13package io.openliberty.guides.inventory;
14
15import java.util.Properties;
16import javax.enterprise.context.ApplicationScoped;
17import javax.inject.Inject;
18import javax.ws.rs.GET;
19import javax.ws.rs.Path;
20import javax.ws.rs.PathParam;
21import javax.ws.rs.Produces;
22import javax.ws.rs.core.MediaType;
23import javax.ws.rs.core.Response;
24import io.openliberty.guides.inventory.model.InventoryList;
25import io.openliberty.guides.inventory.client.SystemClient;
26
27// tag::ApplicationScoped[]
28@ApplicationScoped
29// end::ApplicationScoped[]
30// tag::endpoint[]
31@Path("/systems")
32// end::endpoint[]
33// tag::InventoryResource[]
34public class InventoryResource {
35
36  // tag::inject[]
37  @Inject
38  // end::inject[]
39  InventoryManager manager;
40
41  // tag::inject2[]
42  @Inject
43  // end::inject2[]
44  SystemClient systemClient;
45
46  @GET
47  @Path("/{hostname}")
48  @Produces(MediaType.APPLICATION_JSON)
49  public Response getPropertiesForHost(@PathParam("hostname") String hostname) {
50    // Get properties for host
51    // tag::properties[]
52    Properties props = systemClient.getProperties(hostname);
53    // end::properties[]
54    if (props == null) {
55      return Response.status(Response.Status.NOT_FOUND)
56                     .entity("{ \"error\" : \"Unknown hostname " + hostname
57                             + " or the inventory service may not be running "
58                             + "on the host machine \" }")
59                     .build();
60    }
61
62    // Add to inventory
63    // tag::managerAdd[]
64    manager.add(hostname, props);
65    // end::managerAdd[]
66    return Response.ok(props).build();
67  }
68
69  @GET
70  @Produces(MediaType.APPLICATION_JSON)
71  public InventoryList listContents() {
72    // tag::managerList[]
73    return manager.list();
74    // end::managerList[]
75  }
76}
77// tag::InventoryResource[]

The inventory resource is a RESTful service that is served at the inventory/systems endpoint.

Annotating a class with the @ApplicationScoped annotation indicates that the bean is initialized once and is shared between all requests while the application runs.

If you want this bean to be initialized once for every request, you can annotate the class with the @RequestScoped annotation instead. With the @RequestScoped annotation, the bean is instantiated when the request is received and destroyed when a response is sent back to the client. A request scope is short-lived.

Injecting a dependency

Refer to the InventoryResource class you created above.

The @Inject annotation indicates a dependency injection. You are injecting your InventoryManager and SystemClient beans into the InventoryResource class. This injects the beans in their specified context and makes all of their functionalities available without the need of instantiating them yourself. The injected bean InventoryManager can then be invoked directly through the manager.add(hostname, props) and manager.list() function calls. The injected bean SystemClient can be invoked through the systemClient.getProperties(hostname) function call.

Finally, you have a client component SystemClient that can be found in the src/main/java/io/openliberty/guides/inventory/client directory. This class communicates with the system service to retrieve the JVM system properties for a particular host that exposes them. This class also contains detailed Javadocs that you can read for reference.

Your inventory application is now completed.

InventoryResource.java

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 2020 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License v1.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-v10.html
 8 *
 9 * Contributors:
10 *     IBM Corporation - Initial implementation
11 *******************************************************************************/
12// end::copyright[]
13package io.openliberty.guides.inventory;
14
15import java.util.Properties;
16import javax.enterprise.context.ApplicationScoped;
17import javax.inject.Inject;
18import javax.ws.rs.GET;
19import javax.ws.rs.Path;
20import javax.ws.rs.PathParam;
21import javax.ws.rs.Produces;
22import javax.ws.rs.core.MediaType;
23import javax.ws.rs.core.Response;
24import io.openliberty.guides.inventory.model.InventoryList;
25import io.openliberty.guides.inventory.client.SystemClient;
26
27// tag::ApplicationScoped[]
28@ApplicationScoped
29// end::ApplicationScoped[]
30// tag::endpoint[]
31@Path("/systems")
32// end::endpoint[]
33// tag::InventoryResource[]
34public class InventoryResource {
35
36  // tag::inject[]
37  @Inject
38  // end::inject[]
39  InventoryManager manager;
40
41  // tag::inject2[]
42  @Inject
43  // end::inject2[]
44  SystemClient systemClient;
45
46  @GET
47  @Path("/{hostname}")
48  @Produces(MediaType.APPLICATION_JSON)
49  public Response getPropertiesForHost(@PathParam("hostname") String hostname) {
50    // Get properties for host
51    // tag::properties[]
52    Properties props = systemClient.getProperties(hostname);
53    // end::properties[]
54    if (props == null) {
55      return Response.status(Response.Status.NOT_FOUND)
56                     .entity("{ \"error\" : \"Unknown hostname " + hostname
57                             + " or the inventory service may not be running "
58                             + "on the host machine \" }")
59                     .build();
60    }
61
62    // Add to inventory
63    // tag::managerAdd[]
64    manager.add(hostname, props);
65    // end::managerAdd[]
66    return Response.ok(props).build();
67  }
68
69  @GET
70  @Produces(MediaType.APPLICATION_JSON)
71  public InventoryList listContents() {
72    // tag::managerList[]
73    return manager.list();
74    // end::managerList[]
75  }
76}
77// tag::InventoryResource[]

SystemClient.java

  1// tag::copyright[]
  2/*******************************************************************************
  3 * Copyright (c) 2017, 2019 IBM Corporation and others.
  4 * All rights reserved. This program and the accompanying materials
  5 * are made available under the terms of the Eclipse Public License v1.0
  6 * which accompanies this distribution, and is available at
  7 * http://www.eclipse.org/legal/epl-v10.html
  8 *
  9 * Contributors:
 10 *     IBM Corporation - Initial implementation
 11 *******************************************************************************/
 12// end::copyright[]
 13package io.openliberty.guides.inventory.client;
 14
 15import javax.enterprise.context.ApplicationScoped;
 16import javax.inject.Inject;
 17import javax.ws.rs.client.Client;
 18import javax.ws.rs.client.ClientBuilder;
 19import javax.ws.rs.client.Invocation.Builder;
 20import javax.ws.rs.core.HttpHeaders;
 21import javax.ws.rs.core.MediaType;
 22import javax.ws.rs.core.Response;
 23import javax.ws.rs.core.Response.Status;
 24import java.util.Properties;
 25import java.net.URI;
 26import org.eclipse.microprofile.config.inject.ConfigProperty;
 27
 28@ApplicationScoped
 29public class SystemClient {
 30
 31  // Constants for building URI to the system service.
 32  private final String SYSTEM_PROPERTIES = "/system/properties";
 33  private final String PROTOCOL = "http";
 34
 35  @Inject
 36  @ConfigProperty(name = "system.http.port")
 37  String SYS_HTTP_PORT;
 38
 39  // Wrapper function that gets properties
 40  public Properties getProperties(String hostname) {
 41    String url = buildUrl(PROTOCOL, hostname, Integer.valueOf(SYS_HTTP_PORT), SYSTEM_PROPERTIES);
 42    Builder clientBuilder = buildClientBuilder(url);
 43    return getPropertiesHelper(clientBuilder);
 44  }
 45
 46  // tag::doc[]
 47  /**
 48   * Builds the URI string to the system service for a particular host.
 49   * @param protocol
 50   *          - http or https.
 51   * @param host
 52   *          - name of host.
 53   * @param port
 54   *          - port number.
 55   * @param path
 56   *          - Note that the path needs to start with a slash!!!
 57   * @return String representation of the URI to the system properties service.
 58   */
 59  // end::doc[]
 60  protected String buildUrl(String protocol, String host, int port, String path) {
 61    try {
 62      URI uri = new URI(protocol, null, host, port, path, null, null);
 63      return uri.toString();
 64    } catch (Exception e) {
 65      System.err.println("Exception thrown while building the URL: " + e.getMessage());
 66      return null;
 67    }
 68  }
 69
 70  // Method that creates the client builder
 71  protected Builder buildClientBuilder(String urlString) {
 72    try {
 73      Client client = ClientBuilder.newClient();
 74      Builder builder = client.target(urlString).request();
 75      return builder.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON);
 76    } catch (Exception e) {
 77      System.err.println("Exception thrown while building the client: " + e.getMessage());
 78      return null;
 79    }
 80  }
 81
 82  // Helper method that processes the request
 83  protected Properties getPropertiesHelper(Builder builder) {
 84    try {
 85      Response response = builder.get();
 86      if (response.getStatus() == Status.OK.getStatusCode()) {
 87        return response.readEntity(Properties.class);
 88      } else {
 89        System.err.println("Response Status is not OK.");
 90      }
 91    } catch (RuntimeException e) {
 92      System.err.println("Runtime exception: " + e.getMessage());
 93    } catch (Exception e) {
 94      System.err.println("Exception thrown while invoking the request: " + e.getMessage());
 95    }
 96    return null;
 97  }
 98
 99}

Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/OpenLiberty/guides-common/maven-gradle/devmode-build.adoc[]

You can find the inventory and system services at the following URLs:

Testing the inventory application

While you can test your application manually, you should rely on automated tests since they trigger a failure whenever a code change introduces a defect. Since the application is a RESTful web service application, you can use JUnit and the RESTful web service Client API to write tests. In testing the functionality of the application, the scopes and dependencies are being tested.

Create the InventoryEndpointIT class.
src/test/java/it/io/openliberty/guides/inventory/InventoryEndpointIT.java

The @BeforeAll annotation is placed on a method that runs before any of the test cases. In this case, the oneTimeSetup() method retrieves the port number for the Open Liberty server and builds a base URL string that is used throughout the tests.

The @BeforeEach and @AfterEach annotations are placed on methods that run before and after every test case. These methods are generally used to perform any setup and teardown tasks. In this case, the setup() method creates a JAX-RS client, which makes HTTP requests to the inventory service. This client must also be registered with a JSON-P provider (JsrJsonpProvider) to process JSON resources. The teardown() method simply destroys this client instance.

See the following descriptions of the test cases:

testHostRegistration() verifies that a host is correctly added to the inventory.
testSystemPropertiesMatch() verifies that the JVM system properties returned by the system service match the ones stored in the inventory service.
testUnknownHost() verifies that an unknown host or a host that does not expose their JVM system properties is correctly handled as an error.

To force these test cases to run in a particular order, annotate your InventoryEndpointIT test class with the @TestMethodOrder(OrderAnnotation.class) annotation. OrderAnnotation.class runs test methods in numerical order, according to the values specified in the @Order annotation. You can also create a custom MethodOrderer class or use built-in MethodOrderer implementations, such as OrderAnnotation.class, Alphanumeric.class, or Random.class. Label your test cases with the @Test annotation so that they automatically run when your test class runs.

Finally, the src/test/java/it/io/openliberty/guides/system/SystemEndpointIT.java file is included for you to test the basic functionality of the system service. If a test failure occurs, then you might have introduced a bug into the code.

InventoryEndpointIT.java

  1// tag::copyright[]
  2/*******************************************************************************
  3 * Copyright (c) 2017, 2020 IBM Corporation and others.
  4 * All rights reserved. This program and the accompanying materials
  5 * are made available under the terms of the Eclipse Public License v1.0
  6 * which accompanies this distribution, and is available at
  7 * http://www.eclipse.org/legal/epl-v10.html
  8 *
  9 * Contributors:
 10 *     IBM Corporation - Initial implementation
 11 *******************************************************************************/
 12// end::copyright[]
 13// tag::testClass[]
 14package it.io.openliberty.guides.inventory;
 15
 16import static org.junit.jupiter.api.Assertions.assertEquals;
 17import static org.junit.jupiter.api.Assertions.assertTrue;
 18
 19import javax.json.JsonArray;
 20import javax.json.JsonObject;
 21import javax.ws.rs.client.Client;
 22import javax.ws.rs.client.ClientBuilder;
 23import javax.ws.rs.core.MediaType;
 24import javax.ws.rs.core.Response;
 25
 26import org.apache.cxf.jaxrs.provider.jsrjsonp.JsrJsonpProvider;
 27import org.junit.jupiter.api.AfterEach;
 28import org.junit.jupiter.api.BeforeEach;
 29import org.junit.jupiter.api.BeforeAll;
 30// tag::MethodOrderer[]
 31import org.junit.jupiter.api.MethodOrderer.OrderAnnotation;
 32// end::MethodOrderer[]
 33import org.junit.jupiter.api.Order;
 34import org.junit.jupiter.api.Test;
 35import org.junit.jupiter.api.TestMethodOrder;
 36
 37// tag::TestMethodOrder[]
 38@TestMethodOrder(OrderAnnotation.class)
 39// end::TestMethodOrder[]
 40public class InventoryEndpointIT {
 41
 42  private static String port;
 43  private static String baseUrl;
 44
 45  private Client client;
 46
 47  private final String SYSTEM_PROPERTIES = "system/properties";
 48  private final String INVENTORY_SYSTEMS = "inventory/systems";
 49
 50  // tag::BeforeAll[]
 51  @BeforeAll
 52  // end::BeforeAll[]
 53  // tag::oneTimeSetup[]
 54  public static void oneTimeSetup() {
 55    port = System.getProperty("http.port");
 56    baseUrl = "http://localhost:" + port + "/";
 57  }
 58  // end::oneTimeSetup[]
 59
 60  // tag::BeforeEach[]
 61  @BeforeEach
 62  // end::BeforeEach[]
 63  // tag::setup[]
 64  public void setup() {
 65    client = ClientBuilder.newClient();
 66    // tag::JsrJsonpProvider[]
 67    client.register(JsrJsonpProvider.class);
 68    // end::JsrJsonpProvider[]
 69  }
 70  // end::setup[]
 71
 72  // tag::AfterEach[]
 73  @AfterEach
 74  // end::AfterEach[]
 75  // tag::teardown[]
 76  public void teardown() {
 77    client.close();
 78  }
 79  // end::teardown[]
 80
 81  // tag::tests[]
 82  // tag::Test1[]
 83  @Test
 84  // end::Test1[]
 85  // tag::Order1[]
 86  @Order(1)
 87  // end::Order1[]
 88  // tag::testHostRegistration[]
 89  public void testHostRegistration() {
 90    this.visitLocalhost();
 91
 92    Response response = this.getResponse(baseUrl + INVENTORY_SYSTEMS);
 93    this.assertResponse(baseUrl, response);
 94
 95    JsonObject obj = response.readEntity(JsonObject.class);
 96
 97    JsonArray systems = obj.getJsonArray("systems");
 98
 99    boolean localhostExists = false;
100    for (int n = 0; n < systems.size(); n++) {
101      localhostExists = systems.getJsonObject(n)
102                                .get("hostname").toString()
103                                .contains("localhost");
104      if (localhostExists) {
105          break;
106      }
107    }
108    assertTrue(localhostExists, 
109              "A host was registered, but it was not localhost");
110
111    response.close();
112  }
113  // end::testHostRegistration[]
114
115  // tag::Test2[]
116  @Test
117  // end::Test2[]
118  // tag::Order2[]
119  @Order(2)
120  // end::Order2[]
121  // tag::testSystemPropertiesMatch[]
122  public void testSystemPropertiesMatch() {
123    Response invResponse = this.getResponse(baseUrl + INVENTORY_SYSTEMS);
124    Response sysResponse = this.getResponse(baseUrl + SYSTEM_PROPERTIES);
125
126    this.assertResponse(baseUrl, invResponse);
127    this.assertResponse(baseUrl, sysResponse);
128
129    JsonObject jsonFromInventory = (JsonObject) invResponse.readEntity(JsonObject.class)
130                                                           .getJsonArray("systems")
131                                                           .getJsonObject(0)
132                                                           .get("properties");
133
134    JsonObject jsonFromSystem = sysResponse.readEntity(JsonObject.class);
135
136    String osNameFromInventory = jsonFromInventory.getString("os.name");
137    String osNameFromSystem = jsonFromSystem.getString("os.name");
138    this.assertProperty("os.name", "localhost", osNameFromSystem,
139                        osNameFromInventory);
140
141    String userNameFromInventory = jsonFromInventory.getString("user.name");
142    String userNameFromSystem = jsonFromSystem.getString("user.name");
143    this.assertProperty("user.name", "localhost", userNameFromSystem,
144                        userNameFromInventory);
145
146    invResponse.close();
147    sysResponse.close();
148  }
149  // end::testSystemPropertiesMatch[]
150
151  // tag::Test3[]
152  @Test
153  // end::Test3[]
154  // tag::Order3[]
155  @Order(3)
156  // end::Order3[]
157  // tag::testUnknownHost[]
158  public void testUnknownHost() {
159    Response response = this.getResponse(baseUrl + INVENTORY_SYSTEMS);
160    this.assertResponse(baseUrl, response);
161
162    Response badResponse = client.target(baseUrl + INVENTORY_SYSTEMS + "/"
163        + "badhostname").request(MediaType.APPLICATION_JSON).get();
164
165    assertEquals(404, badResponse.getStatus(),
166        "BadResponse expected status: 404. Response code not as expected.");
167
168    String obj = badResponse.readEntity(String.class);
169
170    boolean isError = obj.contains("error");
171    assertTrue(isError, 
172              "badhostname is not a valid host but it didn't raise an error");
173
174    response.close();
175    badResponse.close();
176  }
177  // end::testUnknownHost[]
178  // end::tests[]
179
180  private Response getResponse(String url) {
181    return client.target(url).request().get();
182  }
183
184  private void assertResponse(String url, Response response) {
185    assertEquals(200, response.getStatus(), "Incorrect response code from " + url);
186  }
187
188  private void assertProperty(String propertyName, String hostname,
189      String expected, String actual) {
190    assertEquals(expected, actual, "JVM system property [" + propertyName + "] "
191        + "in the system service does not match the one stored in "
192        + "the inventory service for " + hostname);
193  }
194
195  private void visitLocalhost() {
196    Response response = this.getResponse(baseUrl + SYSTEM_PROPERTIES);
197    this.assertResponse(baseUrl, response);
198    response.close();
199
200    Response targetResponse = client.target(baseUrl + INVENTORY_SYSTEMS
201        + "/localhost").request().get();
202    targetResponse.close();
203  }
204}
205// end::testClass[]

SystemEndpointIT.java

 1//tag::copyright[]
 2/*******************************************************************************
 3* Copyright (c) 2017, 2019 IBM Corporation and others.
 4* All rights reserved. This program and the accompanying materials
 5* are made available under the terms of the Eclipse Public License v1.0
 6* which accompanies this distribution, and is available at
 7* http://www.eclipse.org/legal/epl-v10.html
 8*
 9* Contributors:
10*     IBM Corporation - initial API and implementation
11*******************************************************************************/
12// end::copyright[]
13package it.io.openliberty.guides.system;
14
15import static org.junit.jupiter.api.Assertions.assertEquals;
16import javax.json.JsonObject;
17import javax.ws.rs.client.Client;
18import javax.ws.rs.client.ClientBuilder;
19import javax.ws.rs.client.WebTarget;
20import javax.ws.rs.core.Response;
21
22import org.apache.cxf.jaxrs.provider.jsrjsonp.JsrJsonpProvider;
23import org.junit.jupiter.api.Test;
24
25public class SystemEndpointIT {
26
27 @Test
28 public void testGetProperties() {
29     String port = System.getProperty("http.port");
30     String url = "http://localhost:" + port + "/";
31
32     Client client = ClientBuilder.newClient();
33     client.register(JsrJsonpProvider.class);
34
35     WebTarget target = client.target(url + "system/properties");
36     Response response = target.request().get();
37
38     assertEquals(200, response.getStatus(), "Incorrect response code from " + url);
39
40     JsonObject obj = response.readEntity(JsonObject.class);
41
42     assertEquals(System.getProperty("os.name"),
43                  obj.getString("os.name"),
44                  "The system property for the local and remote JVM should match");
45     
46     response.close();
47 }
48}

Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/OpenLiberty/guides-common/maven-gradle/devmode-test.adoc[]

If the tests pass, you see a similar output to the following example:

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running it.io.openliberty.guides.system.SystemEndpointIT
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.99 sec - in it.io.openliberty.guides.system.SystemEndpointIT
Running it.io.openliberty.guides.inventory.InventoryEndpointIT
[WARNING ] Interceptor for {http://badhostname:9080/system/properties}WebClient has thrown exception, unwinding now
Could not send Message.
[err] Runtime exception: java.net.UnknownHostException: UnknownHostException invoking http://badhostname:9080/system/properties: badhostname
Tests run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.325 sec - in it.io.openliberty.guides.inventory.InventoryEndpointIT

Results :

Tests run: 4, Failures: 0, Errors: 0, Skipped: 0

The warning and error messages are expected and result from a request to a bad or an unknown hostname. This request is made in the testUnknownHost() test from the InventoryEndpointIT integration test.

To see whether the tests detect a failure, change the endpoint for the inventory service in the src/main/java/io/openliberty/guides/inventory/InventoryResource.java file to something else. Then, run the tests again to see that a test failure occurs.

InventoryResource.java

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 2020 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License v1.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-v10.html
 8 *
 9 * Contributors:
10 *     IBM Corporation - Initial implementation
11 *******************************************************************************/
12// end::copyright[]
13package io.openliberty.guides.inventory;
14
15import java.util.Properties;
16import javax.enterprise.context.ApplicationScoped;
17import javax.inject.Inject;
18import javax.ws.rs.GET;
19import javax.ws.rs.Path;
20import javax.ws.rs.PathParam;
21import javax.ws.rs.Produces;
22import javax.ws.rs.core.MediaType;
23import javax.ws.rs.core.Response;
24import io.openliberty.guides.inventory.model.InventoryList;
25import io.openliberty.guides.inventory.client.SystemClient;
26
27// tag::ApplicationScoped[]
28@ApplicationScoped
29// end::ApplicationScoped[]
30// tag::endpoint[]
31@Path("/systems")
32// end::endpoint[]
33// tag::InventoryResource[]
34public class InventoryResource {
35
36  // tag::inject[]
37  @Inject
38  // end::inject[]
39  InventoryManager manager;
40
41  // tag::inject2[]
42  @Inject
43  // end::inject2[]
44  SystemClient systemClient;
45
46  @GET
47  @Path("/{hostname}")
48  @Produces(MediaType.APPLICATION_JSON)
49  public Response getPropertiesForHost(@PathParam("hostname") String hostname) {
50    // Get properties for host
51    // tag::properties[]
52    Properties props = systemClient.getProperties(hostname);
53    // end::properties[]
54    if (props == null) {
55      return Response.status(Response.Status.NOT_FOUND)
56                     .entity("{ \"error\" : \"Unknown hostname " + hostname
57                             + " or the inventory service may not be running "
58                             + "on the host machine \" }")
59                     .build();
60    }
61
62    // Add to inventory
63    // tag::managerAdd[]
64    manager.add(hostname, props);
65    // end::managerAdd[]
66    return Response.ok(props).build();
67  }
68
69  @GET
70  @Produces(MediaType.APPLICATION_JSON)
71  public InventoryList listContents() {
72    // tag::managerList[]
73    return manager.list();
74    // end::managerList[]
75  }
76}
77// tag::InventoryResource[]

Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/OpenLiberty/guides-common/maven-gradle/devmode-quit.adoc[]

Great work! You’re done!

You just used CDI services in Open Liberty to build a simple inventory application.

Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/OpenLiberty/guides-common/maven-gradle/attribution.adoc[subs="attributes"]