javadoc

micro-boot/src/main/java/com/aol/micro/server/boot/config/Microboot.java

@@ -19,12 +19,42 @@
 public @interface Microboot{
 
 
+	/**
+	 * @return Spring auto-scan base packages
+	 */
 	String[] basePackages() default {};
+
+	/**
+	 * @return Classes to be passed to initial Spring context
+	 * e.g. Classes that have Spring @Configuration or @Component annotation
+	 * 
+	 */
 	Class[] classes() default {};
+
+	/**
+	 * @return Preconfigured collections of classes to be passed to initial Spring context
+	 * They  configure various useful pieces of functionality - such as property file loading,
+	 * datasources, scheduling etc
+	 */
 	Classes[] springClasses() default {};
+
+	/**
+	 * @return Property file name 
+	 * default value is 'application.properties'
+	 */
 	String propertiesName() default "application.properties";
+
+	/**
+	 * @return Hibernate entity scan packages
+	 */
 	String[] entityScan() default {};
+
+	/**
+	 * @return Properties to be injected into spring format is 
+	 * key,value,key,value comma separated list
+	 */
 	String[] properties() default {};
-	boolean isSpringBoot() default false;
+
+
 }
 

micro-boot/src/main/java/com/aol/micro/server/boot/config/MicrobootApp.java

@@ -36,7 +36,14 @@ public class MicrobootApp {
 		@Getter
 		private final ApplicationContext springContext;
 
-
+		/**
+		 * This will construct a Spring context, using Spring Boot for this Microboot instance.
+		 * The calling class will be used to determine the base package to auto-scan from for Spring Beans
+		 * It will attempt to pick up an @Microservice annotation first, if not present the package of the calling class
+		 * will be used.
+		 * 
+		 * @param modules Multiple Microservice end points that can be deployed within a single Spring context
+		 */
 		public MicrobootApp(Module...modules){
 			this.modules = Lists.newArrayList(modules);
 			springContext = new SpringContextFactory(new MicrobootConfigurator().buildConfig(extractClass()),extractClass(),
@@ -45,6 +52,16 @@ public MicrobootApp(Module...modules){
 
 		}
 
+
+		/**
+		 * This will construct a Spring context, using Spring Boot for this Microboot instance.
+		 * The provided class will be used to determine the base package to auto-scan from for Spring Beans
+		 * It will attempt to pick up an @Microservice annotation first, if not present the package of the provided class
+		 * will be used.
+		 * 
+		 * @param c Class used to configure Spring
+		 * @param modules Multiple Microservice end points that can be deployed within a single Spring context
+		 */
 		public MicrobootApp(Class c, Module... modules) {
 
 			this.modules = Lists.newArrayList(modules);
@@ -53,6 +70,13 @@ public MicrobootApp(Class c, Module... modules) {
 
 		}
 
+		/**
+		 *	This will construct a Spring context, using Spring Boot for this Microboot instance.
+		 * The provided Config object will be used to configure Spring
+		 * 
+		 * @param config Spring configuration
+		 * @param modules Multiple Microservice end points that can be deployed within a single Spring context
+		 */
 		public MicrobootApp(Config config, Module... modules) {
 
 			this.modules = Lists.newArrayList(modules);

micro-core/src/main/java/com/aol/micro/server/MicroserverApp.java

@@ -23,6 +23,13 @@
 import com.aol.simple.react.exceptions.ExceptionSoftener;
 import com.google.common.collect.Lists;
 
+/**
+ * 
+ * Startup class for Microserver instance
+ * 
+ * @author johnmcclean
+ *
+ */
 public class MicroserverApp {
 
 	private final Logger logger = LoggerFactory.getLogger(this.getClass());
@@ -34,29 +41,32 @@ public class MicroserverApp {
 	@Getter
 	private final ApplicationContext springContext;
 
+	/**
+	 * This will construct a Spring context for this Microserver instance.
+	 * The calling class will be used to determine the base package to auto-scan from for Spring Beans
+	 * It will attempt to pick up an @Microservice annotation first, if not present the package of the calling class
+	 * will be used.
+	 * 
+	 * @param modules Multiple Microservice end points that can be deployed within a single Spring context
+	 */
 	public MicroserverApp(Module... modules) {
 		this.modules = Lists.newArrayList(modules);
-		springContext = new SpringContextFactory(getConfigurer().buildConfig(
+		springContext = new SpringContextFactory(new MicroserverConfigurer().buildConfig(
 				extractClass()), extractClass(),
 				modules[0].getSpringConfigurationClasses())
 				.createSpringContext();
 
 	}
 
-	public Configurer getConfigurer() {
-		return new MicroserverConfigurer();
-	}
-
-	private Class extractClass() {
-		try {
-			return Class.forName(new Exception().getStackTrace()[2]
-					.getClassName());
-		} catch (ClassNotFoundException e) {
-			softener.throwSoftenedException(e);
-		}
-		return null; // unreachable normally
-	}
-
+	/**
+	 * This will construct a Spring context for this Microserver instance.
+	 * The provided class will be used to determine the base package to auto-scan from for Spring Beans
+	 * It will attempt to pick up an @Microservice annotation first, if not present the package of the provided class
+	 * will be used.
+	 * 
+	 * @param c Class used to configure Spring
+	 * @param modules Multiple Microservice end points that can be deployed within a single Spring context
+	 */
 	public MicroserverApp(Class c, Module... modules) {
 
 		this.modules = Lists.newArrayList(modules);
@@ -67,6 +77,13 @@ public MicroserverApp(Class c, Module... modules) {
 
 	}
 
+	/**
+	 * This will construct a Spring context for this Microserver instance.
+	 * The provided Config object will be used to configure Spring
+	 * 
+	 * @param config Spring configuration
+	 * @param modules Multiple Microservice end points that can be deployed within a single Spring context
+	 */
 	public MicroserverApp(Config config, Module... modules) {
 
 		this.modules = Lists.newArrayList(modules);
@@ -76,6 +93,20 @@ public MicroserverApp(Config config, Module... modules) {
 				.createSpringContext();
 
 	}
+
+
+
+	private Class extractClass() {
+		try {
+			return Class.forName(new Exception().getStackTrace()[2]
+					.getClassName());
+		} catch (ClassNotFoundException e) {
+			softener.throwSoftenedException(e);
+		}
+		return null; // unreachable normally
+	}
+
+
 
 	public void stop() {
 

micro-core/src/main/java/com/aol/micro/server/config/Classes.java

@@ -18,8 +18,22 @@
 import com.aol.micro.server.spring.metrics.CodahaleMetricsConfigurer;
 import com.aol.micro.server.spring.properties.PropertyFileConfig;
 
+/**
+ * 
+ * Collections of Spring configuration classes (Classes annotated with @Configuration)
+ * that configure various useful pieces of functionality - such as property file loading,
+ * datasources, scheduling etc
+ * 
+ * @author johnmcclean
+ *
+ */
 public enum Classes {
 
+	/**
+	 * CORE CLASSES are the Core Microserver Spring Configuration classes
+	 * Property support, Guava Event Bus, Spring AOP & Scheduling
+	 * Codahale Metrics, Event tracking etc
+	 */
 	CORE_CLASSES(PropertyFileConfig.class,
 				MiscellaneousConfig.class, AopConfig.class, CodahaleMetricsConfigurer.class,
 				ConfigureActiveJobsAspect.class, ScheduleAndAsyncConfig.class,ConfigureResources.class),

micro-core/src/main/java/com/aol/micro/server/config/Config.java

@@ -19,6 +19,13 @@
 
 
 
+/**
+ * 
+ * Class for configuring a Spring Context for Microserver
+ * 
+ * @author johnmcclean
+ *
+ */
 @AllArgsConstructor
 @Getter
 @Wither
@@ -66,13 +73,27 @@ public Config withEntityScanDataSource(String dataSource,String... packages){
 		newMap.put(dataSource,Arrays.asList(packages));
 		return this.withDataSources(ImmutableMap.copyOf(newMap));
 	}
+	/**
+	 * Define the packages that hibernate should scan for Hibernate entities
+	 * Should be used in conjunction Microserver Spring Configuration classes @See Classes#HIBERNATE_CLASSES
+	 * 
+	 * @param packages Packages to scan for hibernate entities
+	 * @return New Config object, with configured packages
+	 */
 	public Config withEntityScan(String... packages){
 		Map<String,List<String>> newMap = new HashMap<>(dataSources);
 		newMap.put(defaultDataSourceName,Arrays.asList(packages));
 		return this.withDataSources(ImmutableMap.copyOf(newMap));
 	}
 
 
+	/**
+	 * Add the provided Classes to initial Spring Context as well as
+	 *  @see Classes#DATASOURCE_CLASSES
+	 * 
+	 * @param c Array of additional Spring configuration classes
+	 * @return New Config object, with configured packages
+	 */
 	public Config withDefaultDataSource(Class... c){
 		 List<Class> result =Lists.newArrayList(Classes.DATASOURCE_CLASSES.getClasses());
 		 if(classes!=null)
@@ -82,6 +103,14 @@ public Config withDefaultDataSource(Class... c){
 	}
 
 
+	/**
+	 * 
+	 *  Add the provided Classes to initial Spring Context as well as
+	 *  @see Classes#JDBC_CLASSES
+	 * 
+	 * @param c Array of additional Spring configuration classes
+	 * @return New Config object, with configured packages
+	 */
 	public Config withJdbcClasses(Class... c){
 		 List<Class> result = Lists.newArrayList(Classes.JDBC_CLASSES.getClasses());
 		 result.addAll(Arrays.asList(Classes.SPRING_DATA_CLASSES.getClasses()));
@@ -91,6 +120,13 @@ public Config withJdbcClasses(Class... c){
 		 return this.withClasses(ImmutableSet.copyOf(result));
 	}
 
+	/**
+	 * Add the provided Classes to initial Spring Context as well as
+	 *  @see Classes#SPRING_DATA_CLASSES
+	 * 
+	 * @param c Array of additional Spring configuration classes
+	 * @return New Config object, with configured packages
+	 */
 	public Config withHibernateClasses(Class... c){
 		 Set<Class> result = Sets.newHashSet(Classes.HIBERNATE_CLASSES.getClasses());
 		 result.addAll(Arrays.asList(Classes.SPRING_DATA_CLASSES.getClasses()));

micro-core/src/main/java/com/aol/micro/server/config/Microserver.java

@@ -13,11 +13,41 @@
 public @interface Microserver {
 
 
+	/**
+	 * @return Spring auto-scan base packages
+	 */
 	String[] basePackages() default {};
+
+	/**
+	 * @return Classes to be passed to initial Spring context
+	 * e.g. Classes that have Spring @Configuration or @Component annotation
+	 * 
+	 */
 	Class[] classes() default {};
+
+	/**
+	 * @return Preconfigured collections of classes to be passed to initial Spring context
+	 * They  configure various useful pieces of functionality - such as property file loading,
+	 * datasources, scheduling etc
+	 */
 	Classes[] springClasses() default {};
+
+	/**
+	 * @return Property file name
+	 */
 	String propertiesName() default "application.properties";
+
+	/**
+	 * @return Hibernate entity scan packages
+	 */
 	String[] entityScan() default {};
+
+	/**
+	 * @return Properties to be injected into spring format is 
+	 * key,value,key,value comma separated list
+	 */
 	String[] properties() default {};
-	boolean isSpringBoot() default false;
+
+
+
 }