/*
 * Copyright (c) 2011-2016 The original author or authors
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 *      The Eclipse Public License is available at
 *      http://www.eclipse.org/legal/epl-v10.html
 *
 *      The Apache License v2.0 is available at
 *      http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.servicediscovery.types;

import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.http.HttpClient;
import io.vertx.core.json.JsonObject;
import io.vertx.ext.web.client.WebClient;
import io.vertx.servicediscovery.Record;
import io.vertx.servicediscovery.ServiceDiscovery;
import io.vertx.servicediscovery.spi.ServiceType;

import java.util.Objects;
import java.util.function.Function;

ServiceType for HTTP endpoint (REST api). Consumers receive a HTTP client configured with the host and port of the endpoint. 
Author:
Clement Escoffier/**
 * {@link ServiceType} for HTTP endpoint (REST api).
 * Consumers receive a HTTP client configured with the host and port of the endpoint.
 *
 * @author <a href="http://escoffier.me">Clement Escoffier</a>
 */
@VertxGen
public interface HttpEndpoint extends ServiceType {

  String TYPE = "http-endpoint";

  
Convenient method to create a record for a HTTP endpoint.
Params:
name –     the service name
host –     the host (IP or DNS name), it must be the _public_ IP / name
port –     the port, it must be the _public_ port
root –     the path of the service, "/" if not set
metadata – additional metadata
Returns:
the created record/**
   * Convenient method to create a record for a HTTP endpoint.
   *
   * @param name     the service name
   * @param host     the host (IP or DNS name), it must be the _public_ IP / name
   * @param port     the port, it must be the _public_ port
   * @param root     the path of the service, "/" if not set
   * @param metadata additional metadata
   * @return the created record
   */
  static Record createRecord(String name, String host, int port, String root, JsonObject metadata) {
    return createRecord(name, false, host, port, root, metadata);
  }

  
Same as createRecord(String, String, int, String, JsonObject) but let you configure whether or not the service is using https. 
Params:
name –     the service name
ssl –      whether or not the service is using HTTPS
host –     the host (IP or DNS name), it must be the _public_ IP / name
port –     the port, it must be the _public_ port
root –     the path of the service, "/" if not set
metadata – additional metadata
Returns:
the created record/**
   * Same as {@link #createRecord(String, String, int, String, JsonObject)} but let you configure whether or not the
   * service is using {@code https}.
   *
   * @param name     the service name
   * @param ssl      whether or not the service is using HTTPS
   * @param host     the host (IP or DNS name), it must be the _public_ IP / name
   * @param port     the port, it must be the _public_ port
   * @param root     the path of the service, "/" if not set
   * @param metadata additional metadata
   * @return the created record
   */
  static Record createRecord(String name, boolean ssl, String host, int port, String root, JsonObject metadata) {
    Objects.requireNonNull(name);
    Objects.requireNonNull(host);
    if (root == null) {
      root = "/";
    }
    Record record = new Record().setName(name)
      .setType(TYPE)
      .setLocation(new HttpLocation()
        .setSsl(ssl).setHost(host).setPort(port).setRoot(root).toJson());

    if (metadata != null) {
      record.setMetadata(metadata);
    }

    return record;
  }

  
Same as createRecord(String, String, int, String, JsonObject) but without metadata. 
Params:
name – the service name
host – the host, must be public
port – the port
root – the root, if not set "/" is used
Returns:
the created record/**
   * Same as {@link #createRecord(String, String, int, String, JsonObject)} but without metadata.
   *
   * @param name the service name
   * @param host the host, must be public
   * @param port the port
   * @param root the root, if not set "/" is used
   * @return the created record
   */
  static Record createRecord(String name, String host, int port, String root) {
    return createRecord(name, host, port, root, null);
  }

  
Same as createRecord(String, String, int, String, JsonObject) but without metadata, using the port 80 and using "/" as root. 
Params:
name – the name
host – the host
Returns:
the created record/**
   * Same as {@link #createRecord(String, String, int, String, JsonObject)} but without metadata, using the port 80
   * and using "/" as root.
   *
   * @param name the name
   * @param host the host
   * @return the created record
   */
  static Record createRecord(String name, String host) {
    return createRecord(name, host, 80, "/", null);
  }

  
Convenient method that looks for a HTTP endpoint and provides the configured HttpClient. The async result is marked as failed is there are no matching services, or if the lookup fails. 
Params:
discovery –     The service discovery instance
filter –        The filter, optional
resultHandler – The result handler/**
   * Convenient method that looks for a HTTP endpoint and provides the configured {@link HttpClient}. The async result
   * is marked as failed is there are no matching services, or if the lookup fails.
   *
   * @param discovery     The service discovery instance
   * @param filter        The filter, optional
   * @param resultHandler The result handler
   */
  static void getClient(ServiceDiscovery discovery, JsonObject filter, Handler<AsyncResult<HttpClient>>
    resultHandler) {
    getClient(discovery, filter).onComplete(resultHandler);
  }

  
Like getClient(ServiceDiscovery, JsonObject, Handler<AsyncResult<HttpClient>>) but returns a future of the result /**
   * Like {@link #getClient(ServiceDiscovery, JsonObject, Handler)} but returns a future of the result
   */
  static Future<HttpClient> getClient(ServiceDiscovery discovery, JsonObject filter) {
    return discovery.getRecord(filter).flatMap(res -> {
      if (res == null) {
        return Future.failedFuture("No matching records");
      } else {
        return Future.succeededFuture(discovery.getReference(res).get());
      }
    });
  }

  
Convenient method that looks for a HTTP endpoint and provides the configured {@linkWebClient}. The async result
is marked as failed is there are no matching services, or if the lookup fails.
Params:
discovery –     The service discovery instance
filter –        The filter, optional
resultHandler – The result handler/**
   * Convenient method that looks for a HTTP endpoint and provides the configured {@linkWebClient}. The async result
   * is marked as failed is there are no matching services, or if the lookup fails.
   *
   * @param discovery     The service discovery instance
   * @param filter        The filter, optional
   * @param resultHandler The result handler
   */
  static void getWebClient(ServiceDiscovery discovery, JsonObject filter, Handler<AsyncResult<WebClient>>
    resultHandler) {
    getWebClient(discovery, filter).onComplete(resultHandler);
  }

  
Like getWebClient(ServiceDiscovery, JsonObject, Handler<AsyncResult<WebClient>>) but returns a future of the result /**
   * Like {@link #getWebClient(ServiceDiscovery, JsonObject, Handler)} but returns a future of the result
   */
  static Future<WebClient> getWebClient(ServiceDiscovery discovery, JsonObject filter) {
    return discovery.getRecord(filter).flatMap(res -> {
      if (res == null) {
        return Future.failedFuture("No matching records");
      } else {
        return Future.succeededFuture(discovery.getReference(res).get());
      }
    });
  }

  
Convenient method that looks for a HTTP endpoint and provides the configured HttpClient. The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client 
Params:
discovery –     The service discovery instance
filter –        The filter, optional
conf –          the configuration of the client
resultHandler – The result handler/**
   * Convenient method that looks for a HTTP endpoint and provides the configured {@link HttpClient}. The async result
   * is marked as failed is there are no matching services, or if the lookup fails. This method accepts a
   * configuration for the HTTP client
   *
   * @param discovery     The service discovery instance
   * @param filter        The filter, optional
   * @param conf          the configuration of the client
   * @param resultHandler The result handler
   */
  static void getClient(ServiceDiscovery discovery, JsonObject filter, JsonObject conf, Handler<AsyncResult<HttpClient>>
    resultHandler) {
    getClient(discovery, filter, conf).onComplete(resultHandler);
  }

  
Like getClient(ServiceDiscovery, JsonObject, JsonObject, Handler<AsyncResult<HttpClient>>) but returns a future of the result /**
   * Like {@link #getClient(ServiceDiscovery, JsonObject, JsonObject, Handler)} but returns a future of the result
   */
  static Future<HttpClient> getClient(ServiceDiscovery discovery, JsonObject filter, JsonObject conf) {
    return discovery.getRecord(filter).flatMap(res -> {
      if (res == null) {
        return Future.failedFuture("No matching records");
      } else {
        return Future.succeededFuture(discovery.getReferenceWithConfiguration(res, conf).get());
      }
    });
  }

  
Convenient method that looks for a HTTP endpoint and provides the configured WebClient. The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client 
Params:
discovery –     The service discovery instance
filter –        The filter, optional
conf –          the configuration of the client
resultHandler – The result handler/**
   * Convenient method that looks for a HTTP endpoint and provides the configured {@link WebClient}. The async result
   * is marked as failed is there are no matching services, or if the lookup fails. This method accepts a
   * configuration for the HTTP client
   *
   * @param discovery     The service discovery instance
   * @param filter        The filter, optional
   * @param conf          the configuration of the client
   * @param resultHandler The result handler
   */
  static void getWebClient(ServiceDiscovery discovery, JsonObject filter, JsonObject conf,
                         Handler<AsyncResult<WebClient>>  resultHandler) {
    getWebClient(discovery, filter, conf).onComplete(resultHandler);
  }

  
Like getWebClient(ServiceDiscovery, JsonObject, JsonObject, Handler<AsyncResult<WebClient>>) but returns a future of the result /**
   * Like {@link #getWebClient(ServiceDiscovery, JsonObject, JsonObject, Handler)} but returns a future of the result
   */
  static Future<WebClient> getWebClient(ServiceDiscovery discovery, JsonObject filter, JsonObject conf) {
    return discovery.getRecord(filter).flatMap(res -> {
      if (res == null) {
        return Future.failedFuture("No matching records");
      } else {
        return Future.succeededFuture(discovery.getReferenceWithConfiguration(res, conf).getAs(WebClient.class));
      }
    });
  }

  
Convenient method that looks for a HTTP endpoint and provides the configured HttpClient. The async result is marked as failed is there are no matching services, or if the lookup fails. 
Params:
discovery –     The service discovery instance
filter –        The filter
resultHandler – The result handler/**
   * Convenient method that looks for a HTTP endpoint and provides the configured {@link HttpClient}. The async result
   * is marked as failed is there are no matching services, or if the lookup fails.
   *
   * @param discovery     The service discovery instance
   * @param filter        The filter
   * @param resultHandler The result handler
   */
  static void getClient(ServiceDiscovery discovery, Function<Record, Boolean> filter, Handler<AsyncResult<HttpClient>>
    resultHandler) {
    getClient(discovery, filter).onComplete(resultHandler);
  }

  
Like getClient(ServiceDiscovery, Function<Record,Boolean>, Handler<AsyncResult<HttpClient>>) but returns a future of the result /**
   * Like {@link #getClient(ServiceDiscovery, Function, Handler)} but returns a future of the result
   */
  static Future<HttpClient> getClient(ServiceDiscovery discovery, Function<Record, Boolean> filter) {
    return discovery.getRecord(filter).flatMap(res -> {
      if (res == null) {
        return Future.failedFuture("No matching records");
      } else {
        return Future.succeededFuture(discovery.getReference(res).get());
      }
    });
  }

  
Convenient method that looks for a HTTP endpoint and provides the configured WebClient. The async result is marked as failed is there are no matching services, or if the lookup fails. 
Params:
discovery –     The service discovery instance
filter –        The filter
resultHandler – The result handler/**
   * Convenient method that looks for a HTTP endpoint and provides the configured {@link WebClient}. The async result
   * is marked as failed is there are no matching services, or if the lookup fails.
   *
   * @param discovery     The service discovery instance
   * @param filter        The filter
   * @param resultHandler The result handler
   */
  static void getWebClient(ServiceDiscovery discovery, Function<Record, Boolean> filter,
                           Handler<AsyncResult<WebClient>> resultHandler) {
    getWebClient(discovery, filter).onComplete(resultHandler);
  }

  
Like getWebClient(ServiceDiscovery, Function<Record,Boolean>, Handler<AsyncResult<WebClient>>) but returns a future of the result /**
   * Like {@link #getWebClient(ServiceDiscovery, Function, Handler)} but returns a future of the result
   */
  static Future<WebClient> getWebClient(ServiceDiscovery discovery, Function<Record, Boolean> filter) {
    return discovery.getRecord(filter).flatMap(res -> {
      if (res == null) {
        return Future.failedFuture("No matching records");
      } else {
        return Future.succeededFuture(discovery.getReference(res).getAs(WebClient.class));
      }
    });
  }

  
Convenient method that looks for a HTTP endpoint and provides the configured HttpClient. The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client. 
Params:
discovery –     The service discovery instance
filter –        The filter
conf –          the configuration of the client
resultHandler – The result handler/**
   * Convenient method that looks for a HTTP endpoint and provides the configured {@link HttpClient}. The async result
   * is marked as failed is there are no matching services, or if the lookup fails. This method accepts a
   * configuration for the HTTP client.
   *
   * @param discovery     The service discovery instance
   * @param filter        The filter
   * @param conf          the configuration of the client
   * @param resultHandler The result handler
   */
  static void getClient(ServiceDiscovery discovery, Function<Record, Boolean> filter, JsonObject conf,
                        Handler<AsyncResult<HttpClient>> resultHandler) {
    getClient(discovery, filter, conf).onComplete(resultHandler);
  }

  
Like getClient(ServiceDiscovery, JsonObject, JsonObject, Handler<AsyncResult<HttpClient>>) but returns a future of the result /**
   * Like {@link #getClient(ServiceDiscovery, JsonObject, JsonObject, Handler)} but returns a future of the result
   */
  static Future<HttpClient> getClient(ServiceDiscovery discovery, Function<Record, Boolean> filter, JsonObject conf) {
    return discovery.getRecord(filter).flatMap(res -> {
      if (res == null) {
        return Future.failedFuture("No matching records");
      } else {
        return Future.succeededFuture(discovery.getReferenceWithConfiguration(res, conf).get());
      }
    });
  }

  
Convenient method that looks for a HTTP endpoint and provides the configured WebClient. The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client. 
Params:
discovery –     The service discovery instance
filter –        The filter
conf –          the configuration of the client
resultHandler – The result handler/**
   * Convenient method that looks for a HTTP endpoint and provides the configured {@link WebClient}. The async result
   * is marked as failed is there are no matching services, or if the lookup fails. This method accepts a
   * configuration for the HTTP client.
   *
   * @param discovery     The service discovery instance
   * @param filter        The filter
   * @param conf          the configuration of the client
   * @param resultHandler The result handler
   */
  static void getWebClient(ServiceDiscovery discovery, Function<Record, Boolean> filter, JsonObject conf,
                        Handler<AsyncResult<WebClient>> resultHandler) {
    getWebClient(discovery, filter, conf).onComplete(resultHandler);
  }

  
Like getWebClient(ServiceDiscovery, JsonObject, JsonObject, Handler<AsyncResult<WebClient>>) but returns a future of the result /**
   * Like {@link #getWebClient(ServiceDiscovery, JsonObject, JsonObject, Handler)} but returns a future of the result
   */
  static Future<WebClient> getWebClient(ServiceDiscovery discovery, Function<Record, Boolean> filter, JsonObject conf) {
    return discovery.getRecord(filter).flatMap(res -> {
      if (res == null) {
        return Future.failedFuture("No matching records");
      } else {
        return Future.succeededFuture(discovery.getReferenceWithConfiguration(res, conf).getAs(WebClient.class));
      }
    });
  }
}