io.vertx.serviceproxy.ServiceBinder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-service-proxy Show documentation
There is a newer version: 5.0.0.CR3
/*
 * Copyright 2014 Red Hat, Inc.
 *
 *  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.serviceproxy;

import io.vertx.core.Future;
import io.vertx.core.Vertx;
import io.vertx.core.eventbus.Message;
import io.vertx.core.eventbus.MessageConsumer;
import io.vertx.core.json.JsonObject;
import io.vertx.serviceproxy.impl.InterceptorHolder;

import java.lang.reflect.Constructor;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;

import static io.vertx.serviceproxy.impl.utils.InterceptorUtils.checkInterceptorOrder;

/**
 * A binder for Service Proxies which state can be reused during the binder lifecycle.
 *
 * @author Paulo Lopes
 */
public class ServiceBinder {

  public static final long DEFAULT_CONNECTION_TIMEOUT = 5 * 60; // 5 minutes

  private final Vertx vertx;

  private String address;
  private boolean topLevel = true;
  private long timeoutSeconds = DEFAULT_CONNECTION_TIMEOUT;
  private List interceptorHolders;
  private boolean includeDebugInfo = false;

  /**
   * Creates a factory.
   *
   * @param vertx a non null instance of vertx.
   */
  public ServiceBinder(Vertx vertx) {
    Objects.requireNonNull(vertx);

    this.vertx = vertx;
  }

  /**
   * Set the address to use on the subsequent proxy creations or service registrations.
   *
   * @param address an eventbus address
   * @return self
   */
  public ServiceBinder setAddress(String address) {
    this.address = address;
    return this;
  }

  /**
   * Set if the services to create are a top level services.
   *
   * @param topLevel true for top level (default: true)
   * @return self
   */
  public ServiceBinder setTopLevel(boolean topLevel) {
    this.topLevel = topLevel;
    return this;
  }

  /**
   * Set the default timeout in seconds while waiting for a reply.
   *
   * @param timeoutSeconds the default timeout (default: 5 minutes)
   * @return self
   */
  public ServiceBinder setTimeoutSeconds(long timeoutSeconds) {
    this.timeoutSeconds = timeoutSeconds;
    return this;
  }

  /**
   * When an exception is thrown by the service or the underlying handler, include
   * debugging info in the ServiceException, that you can access with {@link ServiceException#getDebugInfo()}
   *
   * @param includeDebugInfo the parameter
   * @return self
   */
  public ServiceBinder setIncludeDebugInfo(boolean includeDebugInfo) {
    this.includeDebugInfo = includeDebugInfo;
    return this;
  }

  public ServiceBinder addInterceptor(String action, ServiceInterceptor interceptor) {
    checkAndAddInterceptor(action, interceptor);
    return this;
  }

  /**
   * Wrapper method, remove when old interceptors will be removed
   *
   * @param interceptor interceptor to add
   * @return self
   */
  @Deprecated
  public ServiceBinder addInterceptor(Function, Future>> interceptor) {
    ServiceInterceptor serviceInterceptor = (vertx, context, msg) -> interceptor.apply(msg);
    checkAndAddInterceptor(serviceInterceptor);
    return this;
  }

  /**
   * Wrapper method, remove when old interceptors will be removed
   *
   * @param interceptor interceptor to add
   * @return self
   */
  @Deprecated
  public ServiceBinder addInterceptor(String action,
                                      Function, Future>> interceptor) {
    ServiceInterceptor serviceInterceptor = (vertx, context, msg) -> interceptor.apply(msg);
    checkAndAddInterceptor(action, serviceInterceptor);
    return this;
  }

  public ServiceBinder addInterceptor(ServiceInterceptor interceptor) {
    checkAndAddInterceptor(interceptor);
    return this;
  }

  /**
   * Registers a service on the event bus.
   *
   * @param clazz   the service class (interface)
   * @param service the service object
   * @param      the type of the service interface
   * @return the consumer used to unregister the service
   */
  public  MessageConsumer register(Class clazz, T service) {
    Objects.requireNonNull(address);
    // register
    return getProxyHandler(clazz, service).register(vertx, address, getInterceptorHolders());
  }

  /**
   * Registers a local service on the event bus.
   * The registration will not be propagated to other nodes in the cluster.
   *
   * @param clazz   the service class (interface)
   * @param service the service object
   * @param      the type of the service interface
   * @return the consumer used to unregister the service
   */
  public  MessageConsumer registerLocal(Class clazz, T service) {
    Objects.requireNonNull(address);
    // register
    return getProxyHandler(clazz, service).registerLocal(vertx, address, getInterceptorHolders());
  }

  /**
   * Unregisters a published service.
   *
   * @param consumer the consumer returned by {@link #register(Class, Object)}.
   */
  public void unregister(MessageConsumer consumer) {
    Objects.requireNonNull(consumer);

    if (consumer instanceof ProxyHandler) {
      ((ProxyHandler) consumer).close();
    } else {
      // Fall back to plain unregister.
      consumer.unregister();
    }
  }

  /**
   * Checks current interceptors correct order and adds a new one if it's OK
   *
   * @param action      interceptor's action
   * @param interceptor interceptor to add
   */
  private void checkAndAddInterceptor(String action,
                                      ServiceInterceptor interceptor) {
    List currentInterceptorHolders = getInterceptorHolders();
    checkInterceptorOrder(currentInterceptorHolders, interceptor);
    currentInterceptorHolders.add(new InterceptorHolder(action, interceptor));
  }

  /**
   * Checks current interceptors correct order and adds a new one if it's OK
   *
   * @param interceptor interceptor to add
   */
  private void checkAndAddInterceptor(ServiceInterceptor interceptor) {
    List currentInterceptorHolders = getInterceptorHolders();
    checkInterceptorOrder(currentInterceptorHolders, interceptor);
    currentInterceptorHolders.add(new InterceptorHolder(interceptor));
  }

  private  ProxyHandler getProxyHandler(Class clazz, T service) {
    String handlerClassName = clazz.getName() + "VertxProxyHandler";
    Class handlerClass = loadClass(handlerClassName, clazz);
    Constructor constructor = getConstructor(
      handlerClass, Vertx.class, clazz, boolean.class, long.class, boolean.class
    );
    Object instance = createInstance(constructor, vertx, service, topLevel, timeoutSeconds, includeDebugInfo);
    return (ProxyHandler) instance;
  }

  private static Class loadClass(String name, Class origin) {
    try {
      return origin.getClassLoader().loadClass(name);
    } catch (ClassNotFoundException e) {
      throw new IllegalStateException("Cannot find proxyClass: " + name, e);
    }
  }

  private static Constructor getConstructor(Class clazz, Class... types) {
    try {
      return clazz.getDeclaredConstructor(types);
    } catch (NoSuchMethodException e) {
      throw new IllegalStateException("Cannot find constructor on: " + clazz.getName(), e);
    }
  }

  private static Object createInstance(Constructor constructor, Object... args) {
    try {
      return constructor.newInstance(args);
    } catch (Exception e) {
      throw new IllegalStateException("Failed to call constructor on", e);
    }
  }

  private List getInterceptorHolders() {
    if (interceptorHolders == null) {
      interceptorHolders = new ArrayList<>();
    }
    return interceptorHolders;
  }
}