<chapter id="MicroProfile_Rest_Client">
<title>MicroProfile Rest Client</title>

<para>
As the microservices style of system architecture (see, for example,
<ulink url="https://martinfowler.com/articles/microservices.html">Microservices</ulink> by Martin Fowler)
gains increasing traction, new API standards are coming along to support it. One set of such standards comes from
the <ulink url="https://microprofile.io/">Microprofile Project</ulink> supported by the Eclipse Foundation, and among 
those is one, <ulink url="https://microprofile.io/project/eclipse/microprofile-rest-client">MicroProfile Rest Client</ulink>,
of particular interest to RESTEasy and &REST-API;. In fact, it is intended to be based on, and consistent with, &REST-API;,
and it includes ideas already implemented in RESTEasy. For a more detailed description of MicroProfile Rest Client,
see <ulink url="https://github.com/eclipse/microprofile-rest-client">https://github.com/eclipse/microprofile-rest-client</ulink>.
In particular, the API code is in 
<ulink url="https://github.com/eclipse/microprofile-rest-client/tree/master/api">https://github.com/eclipse/microprofile-rest-client/tree/master/api</ulink>.
and the specification is in
<ulink url="https://github.com/eclipse/microprofile-rest-client/tree/master/spec">https://github.com/eclipse/microprofile-rest-client/tree/master/spec</ulink>.
</para>
<para>
    <emphasis role="bold">IMPORTANT:</emphasis> As of RESTEasy 5.0.0 the MicroProfile integration has moved to a new
    project, group id, artifact id and version. The new group id is <code>org.jboss.resteasy.microprofile</code>.The
    artifact id for the client is now <code>microprofile-client</code>. To use the MicroProfile Config sources the
    artifact id is <code>microprofile-config</code>. Finally for context propagation the new artifact is is
    <code>microprofile-context-propagation</code>
</para>
<para>
    You could also use the RESTEasy MicroProfile BOM:
    <programlisting><![CDATA[<dependency>
    <groupId>org.jboss.resteasy.microprofile</groupId>
    <artifactId>resteasy-microprofile-bom</artifactId>
    <version>${version.org.jboss.resteasy.microprofile}</version>
</dependency>]]></programlisting>
</para>

<sect1>
<title>Client proxies</title>

<para>
One of the central ideas in MicroProfile Rest Client is a version of <emphasis>distributed object communication</emphasis>, a concept
implemented in, among other places, <ulink url="http://www.corba.org/orb_basics.htm">CORBA</ulink>, Java RMI, the JBoss
Remoting project, and RESTEasy. Consider the resource
</para>

<programlisting>
@Path("resource")
public class TestResource {

   @Path("test")
   @GET
   String test() {
      return "test";
   }
}
</programlisting>

<para>
The &REST-API; native way of accessing <classname>TestResource</classname> looks like
</para>

<programlisting>
Client client = ClientBuilder.newClient();
String response = client.target("http://localhost:8081/test").request().get(String.class);
</programlisting>

<para>
The call to <methodname>TestResource.test()</methodname> is not particularly onerous, but calling 
<methodname>test()</methodname> directly allows a more natural syntax. That is exactly what Microprofile
Rest Client supports:
</para>

<programlisting>
@Path("resource")
public interface TestResourceIntf {

   @Path("test")
   @GET
   public String test();
}
   
TestResourceIntf service = RestClientBuilder.newBuilder()
                              .baseUrl("http://localhost:8081/")
                              .build(TestResourceIntf.class);
String s = service.test();
</programlisting>

<para>
The first four lines of executable code are spent creating a proxy, <code>service</code>, that implements
<classname>TestResourceIntf</classname>, but once that is done, calls on <classname>TestResource</classname>
can be made very naturally in terms of <classname>TestResourceIntf</classname>, as illustrated by the call
<code>service.test()</code>. 
</para>

<para>
Beyond the natural syntax, another advantage of proxies is the way the proxy construction process quietly
gathers useful information from the implemented interface and makes it available for remote invocations.
Consider a more elaborate version of <classname>TestResourceIntf</classname>:
</para>

<programlisting>
@Path("resource")
public interface TestResourceIntf2 {

   @Path("test/{path}")
   @Consumes("text/plain")
   @Produces("text/html")
   @POST
   public String test(@PathParam("path") String path, @QueryParam("query") String query, String entity);
}
</programlisting>

<para>
Calling <methodname>service.test("p", "q", "e")</methodname> results in an HTTP message that looks like
</para>

<programlisting>
POST /resource/test/p/?query=q HTTP/1.1
Accept: text/html
Content-Type: text/plain
Content-Length: 1

e
</programlisting>

<para>
The HTTP verb is derived from the <code>@POST</code> annotation, the request URI is derived from the
two instances of the <classname>@Path</classname> annotation (one on the class, one on the method) plus the
first and second parameters of <methodname>test()</methodname>, the Accept header is derived from the
<classname>@Produces</classname> annotation, and the Content-Type header is derived from the
<classname>@Consumes</classname> annotation, 
</para>

<para>
Using the &REST-API; API, <code>service.test("p", "q", "e")</code> would look like the more verbose
</para>

<programlisting>
Client client = ClientBuilder.newClient();
String response = client.target("http://localhost:8081/resource/test/p")
                     .queryParam("query", "q")
                     .request()
                     .accept("text/html")
                     .post(Entity.entity("e", "text/plain"), String.class);
</programlisting>

<para>
One other basic facility offered by MicroProfile Rest Client is the ability to configure the client environment
by registering providers:
</para>

<programlisting id="listing1">
TestResourceIntf service = RestClientBuilder.newBuilder()
                              .baseUrl("http://localhost:8081/")
                              .register(MyClientResponseFilter.class)
                              .register(MyMessageBodyReader.class)
                              .build(TestResourceIntf.class);
</programlisting>

<para>
Naturally, the registered providers should be relevant to the client environment, rather than, say, a
<classname>ContainerResponseFilter</classname>.
</para>

<note>
<para>
So far, the MicroProfile Rest Client should look familiar to anyone who has used the RESTEasy client proxy facility
(<link linkend='proxies'>Section ""RESTEasy Proxy Framework"</link>). The construction in 
the previous listing would look like
</para>

<programlisting>
ResteasyClient client = (ResteasyClient) ResteasyClientBuilder.newClient();
TestResourceIntf service = client.target("http://localhost:8081/")
                              .register(MyClientResponseFilter.class)
                              .register(MyMessageBodyReader.class)
                              .proxy(TestResourceIntf.class);
</programlisting>

<para>
in RESTEasy.
</para>
</note>
</sect1>

<sect1>
<title>Concepts imported from &REST-API;</title>

<para>
Beyond the central concept of the client proxy, some basic concepts in MicroProfile Client originate
in &REST-API;. Some of these have already been introduced in the previous section, since the interface
implemented by a client proxy represents the facilities provided by a &REST-API; server. For example, the
HTTP verb annotations and the <code>@Consumes</code> and <code>@Produces</code> annotations originate on the
&REST-API; server side. Injectable parameters annotated with <code>@PathParameter</code>, <code>@QueryParameter</code>,
etc., also come from &REST-API;.
</para>

<para>
Nearly all of the provider concepts supported by MicroProfile Client also originate in &REST-API;. These are:
</para>

<itemizedlist>
   <listitem>javax.ws.rs.client.ClientRequestFilter</listitem>
   <listitem>javax.ws.rs.client.ClientResponseFilter</listitem>
   <listitem>javax.ws.rs.ext.MessageBodyReader</listitem>
   <listitem>javax.ws.rs.ext.MessageBodyWriter</listitem>
   <listitem>javax.ws.rs.ext.ParamConverter</listitem>
   <listitem>javax.ws.rs.ext.ReaderInterceptor</listitem>
   <listitem>javax.ws.rs.ext.WriterInterceptor</listitem>
</itemizedlist>

<para>
Like &REST-API;, MicroProfile Client also has the concept of mandated providers. These are
</para>

<itemizedlist>
   <listitem>JSON-P <classname>MessageBodyReader</classname> and <classname>MessageBodyWriter</classname>
   must be provided.</listitem>
   <listitem>JSON-B <classname>MessageBodyReader</classname> and <classname>MessageBodyWriter</classname>
   must be provided if the implementation supports JSON-B.</listitem>
   <listitem><classname>MessageBodyReader</classname>s and <classname>MessageBodyWriter</classname>s
   must be provided for the following types:
   <itemizedlist>
      <listitem>byte[]</listitem>
      <listitem>String</listitem>
      <listitem>InputStream</listitem>
      <listitem>Reader</listitem>
      <listitem>File</listitem>
   </itemizedlist>
   </listitem>
</itemizedlist>
</sect1>

<sect1>
<title>Beyond &REST-API; and RESTEasy</title>

<para>
Some concepts in MicroProfile Rest Client do not appear in either &REST-API; or RESTEasy.
</para>

<sect1>
<title>Default media type</title>

<para>
Whenever no media type is specified by, for example, <code>@Consumes</code> or <code>@Produces</code> annotations,
the media type of a request entity or response entity is "application/json". This is different than &REST-API;, where
the media type defaults to "application/octet-stream".
</para>
</sect1>

<sect1>
<title>Declarative registration of providers</title>

<para>
In addition to programmatic registration of providers as illustrated above, it is also possible to
register providers declaratively with annotations introduced in MicroProfile Rest Client. In particular,
providers can be registered by adding the <classname>org.eclipse.microprofile.rest.client.annotation.RegisterProvider</classname>
annotation to the target interface:
</para>

<programlisting>
@Path("resource")
@RegisterProvider(MyClientResponseFilter.class)
@RegisterProvider(MyMessageBodyReader.class)
public interface TestResourceIntf2 {

   @Path("test/{path}")
   @Consumes("text/plain")
   @Produces("text/html")
   @POST
   public String test(@PathParam("path") String path, @QueryParam("query") String query, String entity);
}
</programlisting>

<para>
Declaring <classname>MyClientResponseFilter</classname> and <classname>MyMessageBodyReader</classname>  with
annotations eliminates the need to call <methodname>RestClientBuilder.register()</methodname>.
</para>
</sect1>

<sect1>
<title>Global registration of providers</title>

<para>
One more way to register providers is by implementing one or both of the listeners in package
<code>org.eclipse.microprofile.rest.client.spi</code>:
</para>

<programlisting>
public interface RestClientBuilderListener {

    void onNewBuilder(RestClientBuilder builder);
}

public interface RestClientListener {

    void onNewClient(Class&lt;?&gt; serviceInterface, RestClientBuilder builder);
}
</programlisting>

<para>
which can access a <classname>RestClientBuilder</classname> upon creation of a new <classname>RestClientBuilder</classname> or
upon the execution of <methodname>RestClientBuilder.build()</methodname>, respectively. Implementations must
be declared in 
</para>

<programlisting>
META-INF/services/org.eclipse.microprofile.rest.client.spi.RestClientBuilderListener
</programlisting>

<para>or</para>

<programlisting>
META-INF/services/org.eclipse.microprofile.rest.client.spi.RestClientListener
</programlisting>
</sect1>

<sect1>
<title>Declarative specification of headers</title>

<para>
One way of declaring a header to be included in a request is by annotating one of the resource method
parameters with <code>@HeaderValue</code>:
</para>

<programlisting>
@POST
@Produces(MediaType.TEXT_PLAIN)
@Consumes(MediaType.TEXT_PLAIN)
String contentLang(@HeaderParam(HttpHeaders.CONTENT_LANGUAGE) String contentLanguage, String subject);
</programlisting>

<para>
That option is available with RESTEasy client proxies as well,
but in case it is inconvenient or otherwise inappropriate to include the necessary parameter,
MicroProfile Client makes a declarative alternative available through the use of the
<classname>org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam</classname> annotation: 
</para>

<programlisting>
@POST
@Produces(MediaType.TEXT_PLAIN)
@Consumes(MediaType.TEXT_PLAIN)
@ClientHeaderParam(name=HttpHeaders.CONTENT_LANGUAGE, value="en")
String contentLang(String subject);
</programlisting>

<para>
In this example, the header value is hardcoded, but it is also possible to compute a value:
</para>

<programlisting>
@POST
@Produces(MediaType.TEXT_PLAIN)
@Consumes(MediaType.TEXT_PLAIN)
@ClientHeaderParam(name=HttpHeaders.CONTENT_LANGUAGE, value="{getLanguage}")
String contentLang(String subject);

default String getLanguage() {
   return ...;
}
</programlisting>
</sect1>

<sect1>
<title>Propagating headers on the server</title>

<para>
An instance of <classname>org.eclipse.microprofile.rest.client.ext.ClientHeadersFactory</classname>,
</para>

<programlisting>
public interface ClientHeadersFactory {

/**
 * Updates the HTTP headers to send to the remote service. Note that providers
 * on the outbound processing chain could further update the headers.
 *
 * @param incomingHeaders - the map of headers from the inbound &REST-API; request. This will
 * be an empty map if the associated client interface is not part of a &REST-API; request.
 * @param clientOutgoingHeaders - the read-only map of header parameters specified on the
 * client interface.
 * @return a map of HTTP headers to merge with the clientOutgoingHeaders to be sent to
 * the remote service.
 */
MultivaluedMap&lt;String, String&gt; update(MultivaluedMap&lt;String, String&gt; incomingHeaders,
                                      MultivaluedMap&lt;String, String&gt; clientOutgoingHeaders);
}
</programlisting>
<para>
if activated, can do a bulk transfer of incoming headers to an outgoing request. The default instance
<classname>org.eclipse.microprofile.rest.client.ext.DefaultClientHeadersFactoryImpl</classname>
will return a map consisting of those incoming headers listed in the comma separated configuration property
</para>

<programlisting>
org.eclipse.microprofile.rest.client.propagateHeaders
</programlisting>

<para>
In order for an instance of <classname>ClientHeadersFactory</classname> to be activated,
the interface must be annotated with 
<classname>org.eclipse.microprofile.rest.client.annotation.RegisterClientHeaders</classname>. Optionally,
the annotation may include a value field set to an implementation class; without an explicit value, the
default instance will be used.
</para>

<para>
Although a <classname>ClientHeadersFactory</classname> is not officially designated as a provider, it is
now (as of MicroProfile REST Client specification 1.4) subject to injection. In particular, when an instance of <classname>ClientHeadersFactory</classname>
is managed by CDI, then CDI injection is mandatory. When a REST Client is executing in the context
of a &REST-API; implementation, then @Context injection into a <classname>ClientHeadersFactory</classname> is
currently optional. RESTEasy supports CDI injection and does not currently support @Context injection.
</para>
</sect1>

<sect1>
<title>ResponseExceptionMapper</title>

<para>
The <classname>org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper</classname> is the
client side inverse of the <classname>javax.ws.rs.ext.ExceptionMapper</classname> defined in &REST-API;. That is,
where <methodname>ExceptionMapper.toResponse()</methodname> turns an <classname>Exception</classname> thrown
during server side processing into a <classname>Response</classname>,
<methodname>ResponseExceptionMapper.toThrowable()</methodname> turns a 
<classname>Response</classname> received on the client side with an HTTP error status into
an <classname>Exception</classname>. <classname>ResponseExceptionMapper</classname>s can be registered
in the same manner as other providers, that is, either programmatically or declaratively. In the absence
of a registered <classname>ResponseExceptionMapper</classname>, a default <classname>ResponseExceptionMapper</classname>
will map any response with status >= 400 to a <classname>WebApplicationException</classname>.
</para>

</sect1>

<sect1>
<title>Proxy injection by CDI</title>

<para>
MicroProfile Rest Client mandates that implementations must support CDI injection of proxies. At first, the
concept might seem odd in that CDI is more commonly available on the server side. However, the idea is very
consistent with the microservices philosophy. If an application is composed of a number of small services,
then it is to be expected that services will often act as clients to other services.
</para>

<para>
CDI (Contexts and Dependency Injection) is a fairly rich subject and beyond the scope of this Guide. For more information, see 
<ulink url="https://jakarta.ee/specifications/cdi/3.0/jakarta-cdi-spec-3.0.html">Jakarta Contexts and Dependency Injection</ulink> (the specification), 
<ulink url="https://eclipse-ee4j.github.io/jakartaee-tutorial/">Jakarta EE Tutorial</ulink>, or
<ulink url="https://docs.jboss.org/weld/reference/latest-3.1/en-US/html_single/">WELD - CDI Reference Implementation</ulink>.
</para>

<para>
The fundamental thing to know about CDI injection is that annotating a variable with 
<classname>javax.inject.Inject</classname> will lead the CDI runtime (if it is present and enabled) to
create an object of the appropriate type and assign it to the variable. For example, in
</para>

<programlisting>
   public interface Book {
      public String getTitle();
      public void setTitle(String title);
   }

   public class BookImpl implements Book {
      
      private String title;

      @Override
      public String getTitle() {
         return title;
      }
      
      @Override
      public void setTitle(String title) {
         this.title = title;
      }
   }
   
   public class Author {
      
      @Inject private Book book; 
      
      public Book getBook() {
         return book;
      }
   }
</programlisting>

<para>
The CDI runtime will create an instance of <classname>BookImpl</classname> and assign it to the private field
<code>book</code> when an instance of <classname>Author</classname> is created;
</para>

<para>
In this example, the injection is done because <classname>BookImpl</classname> is assignable to <code>book</code>, but
greater discrimination can be imposed by annotating the interface and the field with <emphasis role="bold">qualifier</emphasis>
annotations. For the injection to be legal, every qualifier on the field must be present on the injected interface.
For example:</para>

<programlisting>
   @Qualifier
   @Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD})
   @Retention(RetentionPolicy.RUNTIME)
   public @interface Text {}
   
   @Qualifier
   @Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD})
   @Retention(RetentionPolicy.RUNTIME)
   public @interface Graphic {}
   
   @Text
   public class TextBookImpl extends BookImpl { }
   
   @Graphic
   public class GraphicNovelImpl extends BookImpl { }
   
   public class Genius {
      
      @Inject @Graphic Book book;
   }

</programlisting>

<para>
Here, the class <classname>TextBookImpl</classname> is annotated with the <classname>@Text</classname> qualifier and
<classname>GraphicNovelImpl</classname> is annotated with <classname>@Graphic</classname>. It follows that an instance
of <classname>GraphicNovelImpl</classname> is eligible for assignment to the field <code>book</code> in the 
<classname>Genius</classname> class, but an instance of <classname>TextBookImpl</classname> is not.
</para>

<para>
Now, in MicroProfile Rest Client, any interface that is to be managed as a CDI bean must be annotated with
<classname>@RegisterRestClient</classname>:
</para>

<programlisting>
   @Path("resource")
   @RegisterProvider(MyClientResponseFilter.class)
   public static class TestResourceImpl {

      @Inject TestDataBase db;
      
      @Path("test/{path}")
      @Consumes("text/plain")
      @Produces("text/html")
      @POST
      public String test(@PathParam("path") String path, @QueryParam("query") String query, String entity) {
         return db.getByName(query);
      }
   }

   @Path("database")
   @RegisterRestClient
   public interface TestDataBase {
      
      @Path("")
      @POST
      public String getByName(String name);
   }
</programlisting>

<para>
Here, the MicroProfile Rest Client implementation creates a proxy for a <classname>TestDataBase</classname> service,
allowing easy access by <classname>TestResourceImpl</classname>. Notice, though, that there's no indication of
where the <classname>TestDataBase</classname> implementation lives. That information can be supplied by the optional
<classname>@RegisterProvider</classname> parameter <code>baseUri</code>:</para>

<programlisting>
   @Path("database")
   @RegisterRestClient(baseUri="https://localhost:8080/webapp")
   public interface TestDataBase {
      
      @Path("")
      @POST
      public String getByName(String name);
   }
</programlisting>

<para>
which indicates that an implementation of <classname>TestDatabase</classname> can be
accessed at https://localhost:8080/webapp. The same information can be supplied externally with the system variable
</para>

<programlisting>
&lt;fqn of TestDataBase&gt;/mp-rest/uri=&lt;URL&gt;
</programlisting>

<para>or</para>

<programlisting>
&lt;fqn of TestDataBase&gt;/mp-rest/url=&lt;URL&gt;
</programlisting>

<para>
which will override the value hardcoded in <classname>@RegisterRestClient</classname>. For example,
</para>

<programlisting>
com.bluemonkeydiamond.TestDatabase/mp-rest/url=https://localhost:8080/webapp
</programlisting>

<para>
A number of other properties will be examined in the course of creating the proxy, including, for example
</para>

<programlisting>
com.bluemonkeydiamond.TestDatabase/mp-rest/providers
</programlisting>

<para>
a comma separated list of provider classes to be registered with the proxy. See the MicroProfile Client
documentation for more such properties.
</para>

<para>
These properties can be simplified through the use of the <code>configKey</code> field in 
<classname>@RegisterRestClient</classname>. For example, setting the <code>configKey</code> as in
</para>

<programlisting>
@Path("database")
@RegisterRestClient(configKey="bmd")
public interface TestDataBase { ... }
</programlisting>

<para>
allows the use of properties like
</para>

<programlisting>
bmd/mp-rest/url=https://localhost:8080/webapp
</programlisting>

<para>
Note that, since the configKey is not tied to a particular interface name, multiple proxies can be
configured with the same properties.
</para>
</sect1>

<sect1>
<title>Proxy lifecycle</title>

<para>
Proxies should be closed so that any resources they hold can be released. Every proxy created by
<classname>RestClientBuilder</classname> implements the <classname>java.io.Closeable</classname>
interface, so it is always possible to cast a proxy to <classname>Closeable</classname> and call
<methodname>close()</methodname>. A nice trick to have the proxy interface explicitly extend
<classname>Closeable</classname>, which not only avoids the need for a cast but also makes the proxy
eligible to use in a try-with-resources block:
</para>

<programlisting>
@Path("resource")
public interface TestResourceIntf extends Closeable {

   @Path("test")
   @GET
   public String test();
}
   
TestResourceIntf service = RestClientBuilder.newBuilder()
                              .baseUrl("http://localhost:8081/")
                              .build(TestResourceIntf.class);
try (TestResourceIntf tr = service) {
   String s = service.test();
}
</programlisting>
</sect1>

<sect1>
<title>Asynchronous support</title>

<para>An interface method can be designated as asynchronous by having it return a
<classname>java.util.concurrent.CompletionStage</classname>. For example, in
</para>

<programlisting>
public interface TestResourceIntf extends Closeable {

   @Path("test")
   @GET
   public String test();
   
   @Path("testasync")
   @GET
   public CompletionStage&lt;String&gt; testAsync();
}
</programlisting>

<para>
the <code>test()</code> method can be turned into the asynchronous method <code>testAsync()</code> by having it return
a <classname>CompletionStage&lt;String&gt;</classname> instead of a <classname>String</classname>.
</para>

<para>
Asynchronous methods are made to be asynchronous by scheduling their execution on a thread distinct from
the calling thread. The MicroProfile Client implementation will have a default means of doing that, but
<methodname>RestClientBuilder.executorService(ExecutorService)</methodname> provides a way of substituting
an application specific <classname>ExecutorService</classname>.
</para>

<para>
The classes <classname>AsyncInvocationInterceptorFactory</classname> and
<classname>AsyncInvocationInterceptor</classname> in package
<code>org.eclipse.microprofile.rest.client.ext</code> provides a means of communication
between the calling thread and the asynchronous thread:
</para>

<programlisting>
public interface AsyncInvocationInterceptorFactory {

    /**
     * Implementations of this method should return an implementation of the
     * <code>AsyncInvocationInterceptor</code> interface.  The MP Rest Client
     * implementation runtime will invoke this method, and then invoke the
     * <code>prepareContext</code> and <code>applyContext</code> methods of the
     * returned interceptor when performing an asynchronous method invocation.
     * Null return values will be ignored.
     *
     * @return Non-null instance of <code>AsyncInvocationInterceptor</code>
     */
    AsyncInvocationInterceptor newInterceptor();
}

public interface AsyncInvocationInterceptor {

    /**
     * This method will be invoked by the MP Rest Client runtime on the "main"
     * thread (i.e. the thread calling the async Rest Client interface method)
     * prior to returning control to the calling method.
     */
    void prepareContext();

    /**
     * This method will be invoked by the MP Rest Client runtime on the "async"
     * thread (i.e. the thread used to actually invoke the remote service and
     * wait for the response) prior to sending the request.
     */
    void applyContext();

    /**
     * This method will be invoked by the MP Rest Client runtime on the "async"
     * thread (i.e. the thread used to actually invoke the remote service and
     * wait for the response) after all providers on the inbound response flow
     * have been invoked.
     *
     * @since 1.2
     */
     void removeContext();
}
</programlisting>

<para>
The following sequence of events occurs:
</para>

<orderedlist>
   <listitem>
      <para>
      <methodname>AsyncInvocationInterceptorFactory.newInterceptor()</methodname> is called
      on the calling thread to get an instance of the <classname>AsyncInvocationInterceptor</classname>.
      </para>
   </listitem>
   <listitem>
      <para>
      <methodname>AsyncInvocationInterceptor.prepareContext()</methodname> is executed on the calling
      thread to store information to be used by the request execution.
      </para>
   </listitem>
   <listitem>
      <para>
      <methodname>AsyncInvocationInterceptor.applyContext()</methodname> is executed on the 
      asynchronous thread.
      </para>
   </listitem>
   <listitem>
      <para>
      All relevant outbound providers such as interceptors and filters are executed on the asynchronous thread,
      followed by the request invocation.
      </para>
   </listitem>
   <listitem>
      <para>
      All relevant inbound providers are executed on the asynchronous thread, followed by executing
      <methodname>AsyncInvocationInterceptor.removeContext()</methodname>
      </para>
   </listitem>
   <listitem>
      <para>
      The asynchronous thread returns.
      </para>
   </listitem>
</orderedlist>

<para>
An <classname>AsyncInvocationInterceptorFactory</classname> class is enabled by registering it on the
client interface with <classname>@RegisterProvider</classname>. 
</para>

</sect1>

<sect1>
<title>SSL</title>

<para>
The MicroProfile Client <classname>RestClientBuilder</classname> interface includes a number
of methods that support the use of SSL:
</para>

<programlisting>
RestClientBuilder hostnameVerifier(HostnameVerifier hostnameVerifier);
RestClientBuilder keyStore(KeyStore keyStore, String keystorePassword);
RestClientBuilder sslContext(SSLContext sslContext);
RestClientBuilder trustStore(KeyStore trustStore);
</programlisting>

<para>
For example:
</para>

<programlisting>
KeyStore trustStore = ... ;
HostnameVerifier verifier ... ;
TestResourceIntf service = RestClientBuilder.newBuilder()
                              .baseUrl("http://localhost:8081/")
                              .trustStore(trustStore)
                              .hostnameVerifier(verifier)
                              .build(TestResourceIntf.class);
</programlisting>

<para>
It is also possible to configure <classname>HostnameVerifier</classname>s, 
<classname>KeyStore</classname>s, and <classname>TrustStore</classname>s using configuration
properties:
</para>

<itemizedlist>
   <listitem><para>com.bluemonkeydiamond.TestResourceIntf/mp-rest/hostnameVerifier</para></listitem>
   <listitem><para>com.bluemonkeydiamond.TestResourceIntf/mp-rest/keyStore</para></listitem>
   <listitem><para>com.bluemonkeydiamond.TestResourceIntf/mp-rest/keyStorePassword</para></listitem>
   <listitem><para>com.bluemonkeydiamond.TestResourceIntf/mp-rest/keyStoreType</para></listitem>
   <listitem><para>com.bluemonkeydiamond.TestResourceIntf/mp-rest/trustStore</para></listitem>
   <listitem><para>com.bluemonkeydiamond.TestResourceIntf/mp-rest/trustStorePassword</para></listitem>
   <listitem><para>com.bluemonkeydiamond.TestResourceIntf/mp-rest/trustStoreType</para></listitem>
</itemizedlist>

<para>
The values of the ".../mp-rest/keyStore" and "../mp-rest/trustStore" parameters can be either
classpath resources (e.g., "classpath:/client-keystore.jks") or files (e.g., "file:/home/user/client-keystore.jks").
</para>

</sect1>
</sect1>

</chapter>
