org.jsondoc.JSONDocMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsondoc-maven-plugin Show documentation
The jsondoc maven plugin
There is a newer version: 1.2.23
package org.jsondoc;

import java.io.File;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.List;

import org.apache.commons.io.FileUtils;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.jsondoc.core.pojo.JSONDoc;
import org.jsondoc.core.pojo.JSONDoc.MethodDisplay;
import org.jsondoc.core.scanner.JSONDocScanner;

import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * Echos an object string to the output screen.
 * 
 * @goal generate
 * @requiresProject true
 * @configurator include-project-dependencies
 * @requiresDependencyResolution compile
 */
public class JSONDocMojo extends AbstractMojo {

	/**
	 * The maven project.
	 * 
	 * @parameter expression="${project}"
	 * @readonly
	 */
	private MavenProject project;

	/**
	 * @parameter expression="${jsondoc.version}"
	 * @required
	 */
	private String version;

	/**
	 * @parameter expression="${jsondoc.basePath}"
	 * @required
	 */
	private String basePath;

	/**
	 * @parameter expression="${jsondoc.packages}"
	 * @required
	 */
	private List packages;
	
	/**
	 * @parameter expression="${jsondoc.playgroundEnabled}"
	 * 
	 */
	private boolean playgroundEnabled = true;
	
	/**
	 * @parameter expression="${jsondoc.displayMethodAs}"
	 * 
	 */
	private MethodDisplay displayMethodAs = MethodDisplay.URI;

	/**
	 * @parameter expression="${jsondoc.outputFile}"
	 * @required
	 */
	private String outputFile;
	
	/**
	 * @parameter expression="${jsondoc.scanner}"
	 * @required
	 */
	private String scanner;
	
	private ObjectMapper mapper;
	
	private Log logger;

	@Override
	public void execute() throws MojoExecutionException, MojoFailureException {
		mapper = new ObjectMapper();
		logger = getLog();
		
		try {
			List runtimeClasspathElements = project.getRuntimeClasspathElements();
			URL[] runtimeClasspathElementsUrls = new URL[runtimeClasspathElements.size()];
			for (int i = 0; i < runtimeClasspathElementsUrls.length; i++) {
				runtimeClasspathElementsUrls[i] = new File(runtimeClasspathElements.get(i)).toURI().toURL();
			}
			
			URLClassLoader urlClassLoader = new URLClassLoader(runtimeClasspathElementsUrls, Thread.currentThread().getContextClassLoader());
			Thread.currentThread().setContextClassLoader(urlClassLoader);
			
			JSONDocScanner jsondocScanner = (JSONDocScanner) Class.forName(scanner).newInstance();
			JSONDoc apiDoc = jsondocScanner.getJSONDoc(version, basePath, packages, playgroundEnabled, displayMethodAs);
			String jsonApiDoc = mapper.writeValueAsString(apiDoc);
			FileUtils.writeStringToFile(new File(outputFile), jsonApiDoc);
			
		} catch (Exception e) {
			logger.error(e);
		}
		
	}
}