org.sourcelab.http.rest.configuration.Configuration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of http-client-wrapper Show documentation
A library to abstract common patterns for building http rest clients.
There is a newer version: 0.2.1
/**
 * Copyright 2019 SourceLab.org https://github.com/SourceLabOrg/http-client-wrapper
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
 * persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package org.sourcelab.http.rest.configuration;

import org.sourcelab.http.rest.interceptor.RequestInterceptor;
import org.sourcelab.http.rest.request.RequestHeader;

import java.io.File;
import java.util.List;

/**
 * Configuration interface.
 */
public interface Configuration {

    /**
     * Proxy configuration properties if defined.
     * @return NULL if not configured, or Proxy configuration properties if defined.
     */
    ProxyConfiguration getProxyConfiguration();

    /**
     * Hostname to make API requests against.
     * @return Hostname to make API requests against.
     */
    String getApiHost();

    /**
     * Skip all validation of SSL Certificates.  This is insecure and highly discouraged!
     *
     * @return boolean if invalid SSL certificates should be allowed.
     */
    boolean getIgnoreInvalidSslCertificates();

    /**
     * (Optional) Supply a path to a JKS trust store to be used to validate SSL certificates with.  You'll need this
     * if you're using Self Signed certificates.
     *
     * Alternatively you can can explicitly add your certificate to the JVM's truststore using a command like:
     * keytool -importcert -keystore truststore.jks -file servercert.pem
     *
     * @return file path to truststore.
     */
    File getTrustStoreFile();

    /**
     * If set, the truststore password.
     * @return NULL if no password set.
     */
    String getTrustStorePassword();

    /**
     * Get the request timeout value, in seconds.
     * @return Request timeout value represented in seconds.
     */
    int getRequestTimeoutInSeconds();

    /**
     * Path to a JKS key store to be used for client validation.  If your requesting host
     * is configured to only accept requests from clients with a valid client certificate.
     * @return NULL if not configured, otherwise path to JKS keystore.
    */
    File getKeyStoreFile();

    /**
     * Password for keystore.
     * @return NULL if not configured, otherwise password for JKS keystore.
     */
    String getKeyStorePassword();

    /**
     * Basic Auth username.
     * @return NULL if not configured, otherwise basic auth username.
     */
    String getBasicAuthUsername();

    /**
     * Basic Auth password.
     * @return NULL if not configured, otherwise basic auth username.
     */
    String getBasicAuthPassword();

    /**
     * Implementation for intercepting requests.
     * @return instance.
     */
    List getRequestInterceptors();

    /**
     * Immutable list of request headers to be sent with every request.
     * @return Immutable list of request headers.
     */
    List getRequestHeaders();
}