com.rabbitmq.http.client.HttpLayer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of http-client Show documentation
Java client for the RabbitMQ HTTP API
The newest version!
/*
 * Copyright 2018-2020 the original author or 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 com.rabbitmq.http.client;

import java.net.URI;
import java.util.Map;

/**
 * HTTP layer abstraction for {@link Client}.
 *
 * This is considered a SPI and is susceptible to change at any time.
 *
 * 
Use the {@link JdkHttpClientHttpLayer#configure()} to configure and create the default implementation.
 *
 * @since 4.0.0
 */
public interface HttpLayer {

  /**
   * GET operation when the expected class does not use generics.
   *
   * @param uri
   * @param responseClass
   * @param 
   * @return
   */
   T get(URI uri, Class responseClass);

  /**
   * Get operation when the expected class uses generics, like List<T> or 
   * Page<T>.
   *
   * @param uri
   * @param typeReference
   * @param 
   * @return
   */
   T get(URI uri, ParameterizedTypeReference typeReference);

  /**
   * POST operation.
   *
   * 
Response class is optional.
   *
   * @param uri
   * @param requestBody
   * @param responseClass
   * @param 
   * @return
   */
   T post(URI uri, Object requestBody, Class responseClass);

  /**
   * PUT operation.
   *
   * @param uri
   * @param requestBody
   */
  void put(URI uri, Object requestBody);

  /**
   * DELETE operation.
   *
   * @param uri
   * @param headers
   */
  void delete(URI uri, Map headers);

  /**
   * Contract to create the {@link HttpLayer}.
   *
   * The {@link HttpLayer} usually requires credentials (username, password) that are available
   * once the {@link ClientParameters} instance is created. This explains the need for a factory
   * mechanism.
   *
   * @since 4.0.0
   */
  @FunctionalInterface
  interface HttpLayerFactory {

    HttpLayer create(ClientParameters parameters);

  }

}