001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2014-2015 ForgeRock AS.
015 */
016
017package org.forgerock.http.spi;
018
019import org.forgerock.http.HttpApplicationException;
020import org.forgerock.util.Options;
021
022/**
023 * A provider interface for obtaining {@link HttpClient} instances. A
024 * {@link HttpClientProvider} is loaded during construction of a new HTTP
025 * {@link org.forgerock.http.Client Client}. A provider is selected and its
026 * {@link #newHttpClient(Options)} method invoked in order to construct and
027 * configure a new {@link HttpClient}.
028 */
029public interface HttpClientProvider {
030    /**
031     * Returns a new {@link HttpClient} configured using the provided set of
032     * options.
033     *
034     * @param options
035     *            The client options (never {@code null}).
036     * @return A new {@link HttpClient} configured using the provided set of
037     *         options.
038     * @throws HttpApplicationException
039     *             If the client implementation could not be configured using
040     *             the provided set of options.
041     */
042    HttpClient newHttpClient(Options options) throws HttpApplicationException;
043}