/*
* 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.Handler;
import io.vertx.core.Vertx;
import io.vertx.core.eventbus.Message;
import io.vertx.core.eventbus.MessageConsumer;
import io.vertx.core.eventbus.ReplyException;
import io.vertx.core.json.JsonObject;
import java.lang.reflect.Constructor;
import java.util.*;
import java.util.function.Function;
A binder for Service Proxies which state can be reused during the binder lifecycle.
Author: Paulo Lopes
/**
* A binder for Service Proxies which state can be reused during the binder lifecycle.
*
* @author <a href="mailto:plopes@redhat.com">Paulo Lopes</a>
*/
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<Function<Message<JsonObject>, Future<Message<JsonObject>>>> interceptors;
Creates a factory.
Params: - vertx – a non null instance of vertx.
/**
* 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.
Params: - address – an eventbus address
Returns: self
/**
* 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.
Params: - topLevel – true for top level (default: true)
Returns: self
/**
* 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.
Params: - timeoutSeconds – the default timeout (default: 5 minutes)
Returns: self
/**
* 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;
}
public ServiceBinder addInterceptor(Function<Message<JsonObject>, Future<Message<JsonObject>>> interceptor) {
if (interceptors == null) {
interceptors = new ArrayList<>();
}
interceptors.add(interceptor);
return this;
}
Registers a service on the event bus.
Params: - clazz – the service class (interface)
- service – the service object
Type parameters: - <T> – the type of the service interface
Returns: the consumer used to unregister the service
/**
* Registers a service on the event bus.
*
* @param clazz the service class (interface)
* @param service the service object
* @param <T> the type of the service interface
* @return the consumer used to unregister the service
*/
public <T> MessageConsumer<JsonObject> register(Class<T> clazz, T service) {
Objects.requireNonNull(address);
// register
return getProxyHandler(clazz, service).register(vertx.eventBus(), address, interceptors);
}
Registers a local service on the event bus.
The registration will not be propagated to other nodes in the cluster.
Params: - clazz – the service class (interface)
- service – the service object
Type parameters: - <T> – the type of the service interface
Returns: the consumer used to unregister the service
/**
* 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 <T> the type of the service interface
* @return the consumer used to unregister the service
*/
public <T> MessageConsumer<JsonObject> registerLocal(Class<T> clazz, T service) {
Objects.requireNonNull(address);
// register
return getProxyHandler(clazz, service).registerLocal(vertx.eventBus(), address, interceptors);
}
Unregisters a published service.
Params: - consumer – the consumer returned by
register(Class<Object>, Object)
.
/**
* Unregisters a published service.
*
* @param consumer the consumer returned by {@link #register(Class, Object)}.
*/
public void unregister(MessageConsumer<JsonObject> consumer) {
Objects.requireNonNull(consumer);
if (consumer instanceof ProxyHandler) {
((ProxyHandler) consumer).close();
} else {
// Fall back to plain unregister.
consumer.unregister();
}
}
private <T> ProxyHandler getProxyHandler(Class<T> clazz, T service) {
String handlerClassName = clazz.getName() + "VertxProxyHandler";
Class<?> handlerClass = loadClass(handlerClassName, clazz);
Constructor constructor = getConstructor(handlerClass, Vertx.class, clazz, boolean.class, long.class);
Object instance = createInstance(constructor, vertx, service, topLevel, timeoutSeconds);
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);
}
}
}