http://micronaut.io: Natively Cloud Native
  • Graeme Rocher 
/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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 io.micronaut.http.client;

import edu.umd.cs.findbugs.annotations.Nullable;

import java.net.URL;


Factory interface for creating clients.

Author:graemerocher
Since:2.0
/**
 * Factory interface for creating clients.
 *
 * @author graemerocher
 * @since 2.0
 */
public interface RxHttpClientFactory {
    
Create a new HttpClient. Note that this method should only be used outside of the context of an application. Within Micronaut use Inject to inject a client instead 
Params:
  • url – The base URL
Returns:The client
/**
     * Create a new {@link HttpClient}. Note that this method should only be used outside of the context of an application. Within Micronaut use
     * {@link javax.inject.Inject} to inject a client instead
     *
     * @param url The base URL
     * @return The client
     */
    RxHttpClient createClient(@Nullable URL url);

    
Create a new HttpClient with the specified configuration. Note that this method should only be used outside of the context of an application. Within Micronaut use Inject to inject a client instead 
Params:
  • url – The base URL
  • configuration – the client configuration
Returns:The client
Since:2.2.0
/**
     * Create a new {@link HttpClient} with the specified configuration. Note that this method should only be used
     * outside of the context of an application. Within Micronaut use {@link javax.inject.Inject} to inject a client instead
     *
     * @param url The base URL
     * @param configuration the client configuration
     * @return The client
     * @since 2.2.0
     */
    RxHttpClient createClient(@Nullable URL url, HttpClientConfiguration configuration);

    
Create a new HttpClient. Note that this method should only be used outside of the context of an application. Within Micronaut use Inject to inject a client instead 
Params:
  • url – The base URL
Returns:The client
/**
     * Create a new {@link HttpClient}. Note that this method should only be used outside of the context of an application. Within Micronaut use
     * {@link javax.inject.Inject} to inject a client instead
     *
     * @param url The base URL
     * @return The client
     */
    RxStreamingHttpClient createStreamingClient(@Nullable URL url);

    
Create a new HttpClient with the specified configuration. Note that this method should only be used outside of the context of an application. Within Micronaut use Inject to inject a client instead 
Params:
  • url – The base URL
  • configuration – The client configuration
Returns:The client
Since:2.2.0
/**
     * Create a new {@link HttpClient} with the specified configuration. Note that this method should only be used
     * outside of the context of an application. Within Micronaut use {@link javax.inject.Inject} to inject a client instead
     *
     * @param url The base URL
     * @param configuration The client configuration
     * @return The client
     * @since 2.2.0
     */
    RxStreamingHttpClient createStreamingClient(@Nullable URL url, HttpClientConfiguration configuration);
}