com.opsmatters.newrelic.httpclient.ApiKeyHttpClientProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of newrelic-api Show documentation

Java client library for the New Relic REST APIs built using Jersey and Gson. The library includes over 110 operations across all of the available 35 New Relic services. It can be used by applications to automate the configuration of New Relic Monitoring, Alerting and Dashboards, but can also be used for extracting incident and metric data, executing Insights queries, and uploading plugin metrics.

There is a newer version: 1.0.12

Show newest version

/*
 * Copyright 2018 Gerald Curley
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.opsmatters.newrelic.httpclient;

import java.util.logging.Level;
import java.util.logging.Logger;
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.core.Configuration;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.HttpUrlConnectorProvider;
import org.glassfish.jersey.logging.LoggingFeature;
import com.opsmatters.newrelic.httpclient.filters.ApiKeyFilter;

/**
 * HTTP client provider to attach an API key used for authentication.
 * 
 * @author Gerald Curley (opsmatters)
 */
public class ApiKeyHttpClientProvider implements HttpClientProvider
{
    private static final Logger logger = Logger.getLogger(ApiKeyHttpClientProvider.class.getName());

    private String apiKey;
    
    /**
     * Constructor that takes an API key.
     * @param apiKey The API key
     */
    public ApiKeyHttpClientProvider(String apiKey)
    {    
        this.apiKey = apiKey;
    }

    /**
     * Returns true if the provider should use https.
     * @return true if the provider should use https
     */
    @Override
    public boolean useSsl()
    {
        return true;
    }

    /**
     * Returns the HTTP client.
     * @return The HTTP client
     */
    @Override
    public Client getClient()
    {
        ClientConfig config = new ClientConfig();
        config.register(GsonMessageBodyHandler.class);   
        Client client = ClientBuilder.newClient(config);
        client.property(HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true); // To support PATCH method
        client.register(new ApiKeyFilter(this.apiKey));
        if(logger.isLoggable(Level.FINE))
            client.register(new LoggingFeature(logger, Level.FINE, LoggingFeature.Verbosity.PAYLOAD_TEXT, 8192));
        return client;
    }
}