/*
* The MIT License (MIT)
* Copyright © 2013 Englishtown <opensource@englishtown.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the “Software”), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.englishtown.vertx.hk2;
import org.glassfish.hk2.api.DynamicConfiguration;
import org.glassfish.hk2.api.DynamicConfigurationService;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.hk2.api.ServiceLocatorFactory;
import org.glassfish.hk2.utilities.Binder;
import org.vertx.java.core.Future;
import org.vertx.java.core.json.JsonObject;
import org.vertx.java.platform.Verticle;
import org.vertx.java.platform.impl.java.CompilingClassLoader;
/**
* HK2 Verticle to lazy load the real verticle with DI
*/
public class HK2VerticleLoader extends Verticle {
private final String main;
private final ClassLoader cl;
private Verticle realVerticle;
private ServiceLocator locator;
public static final String CONFIG_BOOTSTRAP_BINDER_NAME = "hk2_binder";
public static final String BOOTSTRAP_BINDER_NAME = "com.englishtown.vertx.hk2.BootstrapBinder";
public HK2VerticleLoader(String main, ClassLoader cl) {
this.main = main;
this.cl = cl;
}
/**
* Override this method to signify that start is complete sometime _after_ the start() method has returned
* This is useful if your verticle deploys other verticles or modules and you don't want this verticle to
* be considered started until the other modules and verticles have been started.
*
* @param startedResult When you are happy your verticle is started set the result
*/
@Override
public void start(Future<Void> startedResult) {
// Create the real verticle
try {
realVerticle = createRealVerticle();
} catch (Exception e) {
startedResult.setFailure(e);
return;
}
// Start the real verticle
realVerticle.start(startedResult);
}
/**
* Vert.x calls the stop method when the verticle is undeployed.
* Put any cleanup code for your verticle in here
*/
@Override
public void stop() {
// Stop the real verticle
if (realVerticle != null) {
realVerticle.stop();
realVerticle = null;
}
// Shutdown the service locator
if (locator != null) {
locator.shutdown();
locator = null;
}
}
public Verticle createRealVerticle() throws Exception {
String className = main;
Class<?> clazz;
if (isJavaSource(main)) {
// TODO - is this right???
// Don't we want one CompilingClassLoader per instance of this?
CompilingClassLoader compilingLoader = new CompilingClassLoader(cl, main);
className = compilingLoader.resolveMainClassName();
clazz = compilingLoader.loadClass(className);
} else {
clazz = cl.loadClass(className);
}
Verticle verticle = createRealVerticle(clazz);
verticle.setVertx(vertx);
verticle.setContainer(container);
return verticle;
}
private Verticle createRealVerticle(Class<?> clazz) throws Exception {
JsonObject config = container.config();
String bootstrapName = config.getString(CONFIG_BOOTSTRAP_BINDER_NAME, BOOTSTRAP_BINDER_NAME);
Binder bootstrap = null;
try {
Class bootstrapClass = cl.loadClass(bootstrapName);
Object obj = bootstrapClass.newInstance();
if (obj instanceof Binder) {
bootstrap = (Binder) obj;
} else {
container.logger().error("Class " + bootstrapName
+ " does not implement Binder.");
}
} catch (ClassNotFoundException e) {
container.logger().error("HK2 bootstrap binder class " + bootstrapName
+ " was not found. Are you missing injection bindings?");
}
// Each verticle factory will have it's own service locator instance
ServiceLocatorFactory factory = ServiceLocatorFactory.getInstance();
locator = factory.create(null);
bind(locator, new VertxBinder(vertx, container));
if (bootstrap != null) {
bind(locator, bootstrap);
}
return (Verticle) locator.createAndInitialize(clazz);
}
private boolean isJavaSource(String main) {
return main.endsWith(".java");
}
private static void bind(ServiceLocator locator, Binder binder) {
DynamicConfigurationService dcs = locator.getService(DynamicConfigurationService.class);
DynamicConfiguration dc = dcs.createDynamicConfiguration();
locator.inject(binder);
binder.bind(dc);
dc.commit();
}
}