com.yahoo.vespa.jaxrs.client.JerseyJaxRsClientFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxrs_client_utils Show documentation
There is a newer version: 7.579.27
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.jaxrs.client;

import com.yahoo.vespa.applicationmodel.HostName;
import org.glassfish.jersey.client.ClientProperties;
import org.glassfish.jersey.client.HttpUrlConnectorProvider;
import org.glassfish.jersey.client.proxy.WebResourceFactory;

import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLContext;
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.ClientRequestFilter;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.UriBuilder;
import java.util.Collections;

/**
 * Factory for creating Jersey clients from a JAX-RS resource interface.
 *
 * @author Oyvind Bakksjo
 */
public class JerseyJaxRsClientFactory implements JaxRsClientFactory {

    // Client is a heavy-weight object with a finalizer so we create only one and re-use it
    private final Client client;

    public JerseyJaxRsClientFactory() {
        this(null, null, null);
    }

    public JerseyJaxRsClientFactory(SSLContext sslContext, HostnameVerifier hostnameVerifier, String userAgent) {
        /*
         * Configure client with some workarounds for HTTP/JAX-RS/Jersey issues. See:
         *   https://jersey.java.net/apidocs/latest/jersey/org/glassfish/jersey/client/ClientProperties.html#SUPPRESS_HTTP_COMPLIANCE_VALIDATION
         *   https://jersey.java.net/apidocs/latest/jersey/org/glassfish/jersey/client/HttpUrlConnectorProvider.html#SET_METHOD_WORKAROUND
         */
        ClientBuilder builder = ClientBuilder.newBuilder()
                                             .property(ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION, true) // Allow empty PUT. TODO: Fix API.
                                             .property(HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true) // Allow e.g. PATCH method.
                                             .property(ClientProperties.FOLLOW_REDIRECTS, true);
        if (sslContext != null) {
            builder.sslContext(sslContext);
        }
        if (hostnameVerifier != null) {
            builder.hostnameVerifier(hostnameVerifier);
        }
        if (userAgent != null) {
            builder.register((ClientRequestFilter) context -> context.getHeaders().put(HttpHeaders.USER_AGENT, Collections.singletonList(userAgent)));
        }
        this.client = builder.build();
    }

    @Override
    public  T createClient(Params params) {
        WebTarget target = client.target(params.uri());
        target.property(ClientProperties.CONNECT_TIMEOUT, (int) params.connectTimeout().toMillis());
        target.property(ClientProperties.READ_TIMEOUT, (int) params.readTimeout().toMillis());
        return WebResourceFactory.newResource(params.apiClass(), target);
    }

    @Override
    public  T createClient(Class apiClass, HostName hostName, int port, String pathPrefix, String scheme) {
        UriBuilder uriBuilder = UriBuilder.fromPath(pathPrefix).host(hostName.s()).port(port).scheme(scheme);
        return createClient(new Params<>(apiClass, uriBuilder.build()));
    }
}