• Home
• org.pipservices
• pip-services3-rpc
• 3.1.2
• source code
• RestClient.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.pipservices3.rpc.clients.RestClient Maven / Gradle / Ivy

package org.pipservices3.rpc.clients;

import jakarta.ws.rs.client.Client;
import jakarta.ws.rs.client.ClientBuilder;
import jakarta.ws.rs.client.Entity;
import jakarta.ws.rs.core.*;
import net.jodah.failsafe.Failsafe;
import net.jodah.failsafe.RetryPolicy;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.ClientProperties;
import org.glassfish.jersey.jackson.JacksonFeature;
import org.pipservices3.commons.config.ConfigParams;
import org.pipservices3.commons.config.IConfigurable;
import org.pipservices3.commons.data.FilterParams;
import org.pipservices3.commons.data.PagingParams;
import org.pipservices3.commons.errors.*;
import org.pipservices3.commons.refer.IReferenceable;
import org.pipservices3.commons.refer.IReferences;
import org.pipservices3.commons.refer.ReferenceException;
import org.pipservices3.commons.run.IOpenable;
import org.pipservices3.components.connect.ConnectionParams;
import org.pipservices3.components.count.CompositeCounters;
import org.pipservices3.components.log.CompositeLogger;
import org.pipservices3.components.trace.CompositeTracer;
import org.pipservices3.rpc.connect.HttpConnectionResolver;
import org.pipservices3.rpc.services.InstrumentTiming;

import java.net.URI;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.time.temporal.ChronoUnit;

/**
 * Abstract client that calls remove endpoints using HTTP/REST protocol.
 * 

 * ### Configuration parameters ###
 * 

 * 
base_route:              base route for remote URI
 * 
connection(s):
 *   

 *   
discovery_key:         (optional) a key to retrieve the connection from IDiscovery
 *   
protocol:              connection protocol: http or https
 *   
host:                  host name or IP address
 *   
port:                  port number
 *   
uri:                   resource URI or connection string with all parameters in it
 *   
 * 
options:
 *   

 *   
retries:               number of retries (default: 3)
 *   
connect_timeout:       connection timeout in milliseconds (default: 10 sec)
 *   
timeout:               invocation timeout in milliseconds (default: 10 sec)
 *   
 * 
 * 

 * ### References ###
 * 

 * 
*:logger:*:*:1.0           (optional) ILogger components to pass log messages
 * 
*:counters:*:*:1.0         (optional) ICounters components to pass collected measurements
 * 
*:tracer:*:*:1.0        (optional) ITracer components to record traces
 * 
*:discovery:*:*:1.0        (optional) IDiscovery services to resolve connection
 * 
 * 

 * ### Example ###
 * 
 * {@code
 * class MyRestClient extends RestClient implements IMyClient {
 *    ...
 *
 *    public MyData getData(String correlationId, String id) {
 *        Timing timing = this.instrument(correlationId, 'myclient.get_data');
 *        MyData result = this.execute(MyData.class, correlationId, HttpMethod.POST, "/get_data", new MyData(id));
 *        timing.endTiming();
 *        return result;
 *    }
 *    ...
 * }
 *
 * MyRestClient client = new MyRestClient();
 * client.configure(ConfigParams.fromTuples(
 *     "connection.protocol", "http",
 *     "connection.host", "localhost",
 *     "connection.port", 8080
 * ));
 *
 * MyData data = client.getData("123", "1");
 * ...
 * }
 * 
 */
public class RestClient implements IOpenable, IConfigurable, IReferenceable {

    private final static ConfigParams _defaultConfig = ConfigParams.fromTuples(
            "connection.protocol", "http",
            "connection.host", "0.0.0.0",
            "connection.port", 3000,

            "options.request_max_size", 1024 * 1024,
            "options.connect_timeout", 10000,
            "options.timeout", 10000,
            "options.retries", 3,
            "options.debug", true
    );

    /**
     * The connection resolver.
     */
    protected HttpConnectionResolver _connectionResolver = new HttpConnectionResolver();
    /**
     * The logger.
     */
    protected CompositeLogger _logger = new CompositeLogger();
    /**
     * The performance counters.
     */
    protected CompositeCounters _counters = new CompositeCounters();
    /**
     * The tracer.
     */
    protected CompositeTracer _tracer = new CompositeTracer();

    /**
     * The configuration options.
     */
    protected ConfigParams _options = new ConfigParams();
    /**
     * The base route.
     */
    protected String _baseRoute;
    /**
     * The number of retries.
     */
    protected int _retries = 1;
    /**
     * The connection timeout in milliseconds.
     */
    protected long _connectTimeout = 10000;
    /**
     * The invocation timeout in milliseconds.
     */
    protected long _timeout = 10000;
    /**
     * The default headers to be added to every request.
     */
    protected MultivaluedMap _headers = new MultivaluedHashMap<>();
    protected String _correlationIdLocation = "query";

    /**
     * The remote service uri which is calculated on open.
     */
    protected String _url;
    /**
     * The HTTP client.
     */
    protected Client _client;

    /**
     * Creates a new instance of the client.
     */
    protected RestClient() {
        this(null);
    }

    /**
     * Creates a new instance of the client.
     *
     * @param baseRoute a base route for remote service.
     */
    protected RestClient(String baseRoute) {
        _baseRoute = baseRoute;
    }

    /**
     * Client retry strategy
     */
    private RetryPolicy