org.codehaus.enunciate.main
Class Enunciate

java.lang.Object
  org.codehaus.enunciate.main.Enunciate

public class Enunciate
extends Object

Main enunciate entry point.

Author:

Ryan Heaton

Nested Class Summary

static interface	Enunciate.FileVisitor File visitor interface used to visit files.
class	Enunciate.Stepper Mechansim for stepping through the Enunciate build process.
static class	Enunciate.Target The targets for the project.

Constructor Summary

protected	Enunciate() Protected to ensure the source files are set.
	Enunciate(List<String> sourceFiles) Construct an enunciate mechanism on the specified source files.
	Enunciate(String[] sourceFiles) Construct an enunciate mechanism on the specified source files.
	Enunciate(String[] sourceFiles, EnunciateConfiguration config) Construct an enunciate mechanism on the specified source files with the specified config.

Method Summary

void	addAdditionalSourceRoot(File root) Add an additional source root for Enunciate to process.
boolean	addArtifact(Artifact artifact) Adds the specified artifact.
void	addExport(String artifactId, File destination) Adds an export.
void	addWebAppFragment(WebAppFragment fragment) Add a webapp fragment for Enunciate to process.
protected void	buildFileList(List<File> list, File... dirs) Adds all files in specified directories to a list.
void	compileSources(File compileDir) Compile all sources and any additional (generated) sources to the specified directory.
void	copyDir(File from, File to, File... excludes) Copy an entire directory from one place to another.
void	copyFile(File from, File to) Copy a file from one location to another.
void	copyFile(File src, File fromDir, File toDir) Copy a file from one directory to another, preserving directory structure.
protected boolean	copyImportedClasses(Map<String,File> foundClasses2Sources, Map<String,File> classes2sources) Copy the relevant found classes that are imported to the specified map.
void	copyResource(String resource, File to) Copies a resource on the classpath to a file.
void	copyResource(URL url, File to) Copies a resource to a file.
File	createTempDir() Creates a temporary directory.
File	createTempFile(String baseName, String suffix) Creates a temporary file.
void	debug(String message, Object... formatArgs) Handle a debug-level message.
protected void	doBuild() Do the build logic.
protected void	doClose() Logic for handling the closing of the Enunciate mechanism.
protected void	doCompile() Do the compile logic.
protected void	doGenerate() Do the generate logic.
protected void	doInit() Do the initialization logic.
protected void	doPackage() Do the package logic.
void	execute() Execute the mechanism.
void	extractBase(InputStream baseIn, File toDir) Extracts the (zipped up) base to the specified directory.
Artifact	findArtifact(String artifactId) Finds the artifact of the given id.
Set<File>	getAdditionalSourceRoots() The additional source roots.
Set<Artifact>	getArtifacts() The artifacts exportable by enunciate.
String	getBuildClasspath() The build classpath.
File	getBuildDir() The directory to use to build the war.
File	getCompileDir() The destination directory for the compiled classes.
EnunciateConfiguration	getConfig()
File	getConfigFile() The enunciate config file.
String	getEnunciateBuildClasspath() The enunciate classpath to use when building the application.
String	getEnunciateRuntimeClasspath() The enunciate classpath to use when running the application (after being built).
Collection<String>	getFiles(File basedir, FileFilter filter) Finds all files in the specified base directory using the specified filter.
File	getGenerateDir() The preprocessor directory (-s).
Collection<String>	getJavaFiles(File basedir) Finds all java files in the specified base directory.
protected File	getOldest(List<File> files) Get the earliest modified file.
File	getPackageDir() The package directory.
Object	getProperty(String property) Get a property value.
String	getRuntimeClasspath() The runtime classpath.
File	getScratchDir() A scratch directory for Enunciate to use.
String[]	getSourceFiles() Get the source files for this enunciate mechanism.
Enunciate.Stepper	getStepper() Get a stepper that can be used to step through the Enunciate mechanism, which will be initialized.
Enunciate.Target	getTarget() The target.
String	getVersion() The version of the Enunciate mechanism.
Set<WebAppFragment>	getWebAppFragments() The webapp fragments.
protected File	getYoungest(List<File> files) Get the latest modified file.
void	info(String message, Object... formatArgs) Handle an info-level message.
protected void	initModules(Collection<DeploymentModule> deploymentModules) Initialize each module.
protected void	invokeApt(String[] sourceFiles, String... additionalApiClasses) Invokes APT on the specified source files.
void	invokeJavac(File compileDir, String[] sourceFiles) Invokes javac on the specified source files.
void	invokeJavac(String classpath, File compileDir, String[] sourceFiles) Invokes javac on the specified source files.
void	invokeJavac(String classpath, String version, File compileDir, List<String> additionalArgs, String[] sourceFiles) Invokes javac on the specified source files.
boolean	isCompileDebugInfo() Whether to compile with debug info.
boolean	isDebug() Whether to print debugging information.
boolean	isJavacCheck() Whether to do a javac check before invoking the Enunciate mechanism.
boolean	isModuleEnabled(String moduleName) Whether the specified module is enabled.
boolean	isUpToDate(File sourceFile, File destFile) Determines whether a destination file is newer than a source file.
protected boolean	isUpToDate(List<File> sourceFiles, File destFile) Whether a given destination file is newer than all the specified source files.
boolean	isUpToDateWithSources(File destDir) Whether all files in the specified directory are newer than all the source files.
boolean	isVerbose() Whether to be verbose.
protected EnunciateConfiguration	loadConfig() Reads the enunciate configuration from the specified file, if any.
protected String	lookupSourceEntry(File pathEntry) Lookup the source entry for the specified classpath entry.
static void	main(String[] args)
File	resolvePath(String filePath) Resolves a path relative to the Enunciate config file, if present, otherwise the file will be a relative file to the current user directory.
protected Map<String,File>	scanForClassesToImport() Scans the Enunciate classpath for classes to be imported.
void	setBuildClasspath(String buildClasspath) The build classpath.
void	setBuildDir(File buildDir) The directory to use to build the war.
void	setCompileDebugInfo(boolean compileDebugInfo) Whether to compile with debug info.
void	setCompileDir(File compileDir) The destination directory for the compiled classes.
void	setConfig(EnunciateConfiguration config) Set the configuration for the mechanism.
void	setConfigFile(File configFile) The enunciate config file.
void	setDebug(boolean debug) Whether to print debugging information.
void	setGenerateDir(File generateDir) The preprocessor directory (-s).
void	setJavacCheck(boolean javacCheck) Whether to do a javac check before invoking the Enunciate mechanism.
void	setPackageDir(File packageDir) The package directory.
void	setProperty(String property, Object value) Set a property value.
void	setRuntimeClasspath(String runtimeClasspath) The runtime classpath.
void	setScratchDir(File scratchDir) A scratch directory for Enunciate to use.
protected void	setSourceFiles(String[] sourceFiles) Protected to allow the source files to be set after construction.
void	setTarget(Enunciate.Target target) The target.
void	setVerbose(boolean verbose) Whether to be verbose.
void	warn(String message, Object... formatArgs) Handle a warn-level message.
protected void	writePackageSourceFile(InputStream bytecode, File packageSourceFile) Write the package-info.java source to the specified file.
void	zip(File toFile, File... dirs) zip up directories to a specified zip file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Enunciate

protected Enunciate()

Protected to ensure the source files are set.

Enunciate

public Enunciate(String[] sourceFiles)

Construct an enunciate mechanism on the specified source files.

Parameters:

sourceFiles - The source files.

Enunciate

public Enunciate(String[] sourceFiles,
                 EnunciateConfiguration config)

Construct an enunciate mechanism on the specified source files with the specified config.

Parameters:

sourceFiles - The source files.

config - The config

Enunciate

public Enunciate(List<String> sourceFiles)

Construct an enunciate mechanism on the specified source files.

Parameters:

sourceFiles - The source files.

Method Detail

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

setSourceFiles

protected void setSourceFiles(String[] sourceFiles)

Protected to allow the source files to be set after construction.

Parameters:

sourceFiles - The source files to enunciate.

getStepper

public Enunciate.Stepper getStepper()
                             throws EnunciateException,
                                    IOException

Get a stepper that can be used to step through the Enunciate mechanism, which will be initialized.

Returns:

A stepper.

Throws:

ConcurrentModificationException - If a stepper has already been retrieved.

EnunciateException - If there was an error initializing the Enunciate mechanism.

IOException - If there was an error initializing the Enunciate mechanism.

execute

public void execute()
             throws EnunciateException,
                    IOException

Execute the mechanism.

Throws:

EnunciateException

IOException

doClose

protected void doClose()
                throws EnunciateException,
                       IOException

Logic for handling the closing of the Enunciate mechanism. Closes the modules and exports the artifacts.

Throws:

EnunciateException

IOException

doPackage

protected void doPackage()
                  throws IOException,
                         EnunciateException

Do the package logic.

Throws:

IOException

EnunciateException

doBuild

protected void doBuild()
                throws IOException,
                       EnunciateException

Do the build logic.

Throws:

IOException

EnunciateException

doCompile

protected void doCompile()
                  throws IOException,
                         EnunciateException

Do the compile logic.

Throws:

IOException

EnunciateException

doGenerate

protected void doGenerate()
                   throws IOException,
                          EnunciateException

Do the generate logic.

Throws:

IOException

EnunciateException

scanForClassesToImport

protected Map<String,File> scanForClassesToImport()
                                           throws IOException

Scans the Enunciate classpath for classes to be imported.

Returns:

The classes to be imported, associated with their source file if it was found.

Throws:

IOException

lookupSourceEntry

protected String lookupSourceEntry(File pathEntry)

Lookup the source entry for the specified classpath entry. Default implementation returns null.

Parameters:

pathEntry - The path entry for which to lookup the source entry.

Returns:

The source entry, or null if not found.

writePackageSourceFile

protected void writePackageSourceFile(InputStream bytecode,
                                      File packageSourceFile)
                               throws IOException

Write the package-info.java source to the specified file.

Parameters:

bytecode - The bytecode for the package-info.class

packageSourceFile - The source file.

Throws:

IOException

copyImportedClasses

protected boolean copyImportedClasses(Map<String,File> foundClasses2Sources,
                                      Map<String,File> classes2sources)

Copy the relevant found classes that are imported to the specified map.

Parameters:

foundClasses2Sources - the found classes.

classes2sources - the target map.

Returns:

whether any of the found classes were imported.

doInit

protected void doInit()
               throws EnunciateException,
                      IOException

Do the initialization logic. Loads and initializes the deployment modules.

Throws:

EnunciateException

IOException

initModules

protected void initModules(Collection<DeploymentModule> deploymentModules)
                    throws EnunciateException,
                           IOException

Initialize each module.

Parameters:

deploymentModules - The deployment modules.

Throws:

EnunciateException

IOException

info

public void info(String message,
                 Object... formatArgs)

Handle an info-level message.

Parameters:

message - The info message.

formatArgs - The format args of the message.

debug

public void debug(String message,
                  Object... formatArgs)

Handle a debug-level message.

Parameters:

message - The debug message.

formatArgs - The format args of the message.

warn

public void warn(String message,
                 Object... formatArgs)

Handle a warn-level message.

Parameters:

message - The warn message.

formatArgs - The format args of the message.

createTempDir

public File createTempDir()
                   throws IOException

Creates a temporary directory.

Returns:

A temporary directory.

Throws:

IOException

createTempFile

public File createTempFile(String baseName,
                           String suffix)
                    throws IOException

Creates a temporary file. Same as File.createTempFile(String, String) but in the Enunciate scratch directory.

Parameters:

baseName - The base name of the file.

suffix - The suffix.

Returns:

The temp file.

Throws:

IOException

getSourceFiles

public String[] getSourceFiles()

Get the source files for this enunciate mechanism.

Returns:

The source files.

loadConfig

protected EnunciateConfiguration loadConfig()
                                     throws IOException

Reads the enunciate configuration from the specified file, if any.

Returns:

The configuration, or null if none is specified.

Throws:

IOException

getJavaFiles

public Collection<String> getJavaFiles(File basedir)

Finds all java files in the specified base directory.

Parameters:

basedir - The base directory.

Returns:

The collection of java files.

getFiles

public Collection<String> getFiles(File basedir,
                                   FileFilter filter)

Finds all files in the specified base directory using the specified filter.

Parameters:

basedir - The base directory.

filter - The filter to use.

Returns:

The collection of files.

getEnunciateRuntimeClasspath

public String getEnunciateRuntimeClasspath()

The enunciate classpath to use when running the application (after being built).

Returns:

The enunciate classpath to use when running the application (after being built).

getEnunciateBuildClasspath

public String getEnunciateBuildClasspath()

The enunciate classpath to use when building the application.

Returns:

The enunciate classpath to use when building the application.

invokeApt

protected void invokeApt(String[] sourceFiles,
                         String... additionalApiClasses)
                  throws IOException,
                         EnunciateException

Invokes APT on the specified source files.

Parameters:

sourceFiles - The source files.

additionalApiClasses - The FQNs of additional classes (should be found on the Enunciate classpath) that comprise the API.

Throws:

IOException

EnunciateException

compileSources

public void compileSources(File compileDir)
                    throws EnunciateException

Compile all sources and any additional (generated) sources to the specified directory.

Parameters:

compileDir - The compile directory.

Throws:

EnunciateException - If the compile fails.

invokeJavac

public void invokeJavac(File compileDir,
                        String[] sourceFiles)
                 throws EnunciateException

Invokes javac on the specified source files. The classpath will be the runtime classpath.

Parameters:

compileDir - The compile directory.

sourceFiles - The source files.

Throws:

EnunciateException - if the compile fails.

invokeJavac

public void invokeJavac(String classpath,
                        File compileDir,
                        String[] sourceFiles)
                 throws EnunciateException

Invokes javac on the specified source files.

Parameters:

classpath - The classpath.

compileDir - The compile directory.

sourceFiles - The source files.

Throws:

EnunciateException - if the compile fails.

invokeJavac

public void invokeJavac(String classpath,
                        String version,
                        File compileDir,
                        List<String> additionalArgs,
                        String[] sourceFiles)
                 throws EnunciateException

Invokes javac on the specified source files.

Parameters:

classpath - The classpath.

version - The Java version to compile to.

compileDir - The compile directory.

additionalArgs - Any additional arguments to the compiler.

sourceFiles - The source files. @throws EnunciateException if the compile fails.

Throws:

EnunciateException

copyDir

public void copyDir(File from,
                    File to,
                    File... excludes)
             throws IOException

Copy an entire directory from one place to another.

Parameters:

from - The source directory.

to - The destination directory.

excludes - The files to exclude from the copy

Throws:

IOException

extractBase

public void extractBase(InputStream baseIn,
                        File toDir)
                 throws IOException

Extracts the (zipped up) base to the specified directory.

Parameters:

baseIn - The stream to the base.

toDir - The directory to extract to.

Throws:

IOException

copyFile

public void copyFile(File src,
                     File fromDir,
                     File toDir)
              throws IOException

Copy a file from one directory to another, preserving directory structure.

Parameters:

src - The source file.

fromDir - The from directory.

toDir - The to directory.

Throws:

IOException

copyFile

public void copyFile(File from,
                     File to)
              throws IOException

Copy a file from one location to another.

Parameters:

from - The source file.

to - The destination file.

Throws:

IOException

copyResource

public void copyResource(String resource,
                         File to)
                  throws IOException

Copies a resource on the classpath to a file.

Parameters:

resource - The resource to copy.

to - The file to copy to.

Throws:

IOException

copyResource

public void copyResource(URL url,
                         File to)
                  throws IOException

Copies a resource to a file.

Parameters:

url - The url of the resource.

to - The file to copy to.

Throws:

IOException

zip

public void zip(File toFile,
                File... dirs)
         throws IOException

zip up directories to a specified zip file.

Parameters:

toFile - The file to zip to.

dirs - The directories to zip up.

Throws:

IOException

resolvePath

public File resolvePath(String filePath)

Resolves a path relative to the Enunciate config file, if present, otherwise the file will be a relative file to the current user directory.

Parameters:

filePath - The file path to resolve.

Returns:

The resolved file.

isUpToDate

public boolean isUpToDate(File sourceFile,
                          File destFile)

Determines whether a destination file is newer than a source file. If a source file is a directory, its timestamp is the timestamp of the latest file. If a destination file is a directory, its timestamp is the timestamp of the earliest file.

Parameters:

sourceFile - The source file.

destFile - The destination file.

Returns:

Whether the destination file is up-to-date.

isUpToDateWithSources

public boolean isUpToDateWithSources(File destDir)

Whether all files in the specified directory are newer than all the source files.

Parameters:

destDir - The directory.

Returns:

Whether the destination directory is up-to-date.

isUpToDate

protected boolean isUpToDate(List<File> sourceFiles,
                             File destFile)

Whether a given destination file is newer than all the specified source files. If the destination file is a directory its timestamp is the timestamp of the earliest-modified file.

Parameters:

sourceFiles - The specified source files.

destFile - The destination file.

Returns:

Whether the destination file is up-to-date.

getYoungest

protected File getYoungest(List<File> files)

Get the latest modified file.

Parameters:

files - The files.

Returns:

The latest modified.

getOldest

protected File getOldest(List<File> files)

Get the earliest modified file.

Parameters:

files - The files.

Returns:

The earliest modified.

buildFileList

protected void buildFileList(List<File> list,
                             File... dirs)

Adds all files in specified directories to a list.

Parameters:

list - The list.

dirs - The directories.

isVerbose

public boolean isVerbose()

Whether to be verbose.

Returns:

Whether to be verbose.

setVerbose

public void setVerbose(boolean verbose)

Whether to be verbose.

Parameters:

verbose - Whether to be verbose.

isDebug

public boolean isDebug()

Whether to print debugging information.

Returns:

Whether to print debugging information.

setDebug

public void setDebug(boolean debug)

Whether to print debugging information.

Parameters:

debug - Whether to print debugging information.

getVersion

public String getVersion()

The version of the Enunciate mechanism.

Returns:

The version of the Enunciate mechanism.

isJavacCheck

public boolean isJavacCheck()

Whether to do a javac check before invoking the Enunciate mechanism.

Returns:

Whether to do a javac check before invoking the Enunciate mechanism.

setJavacCheck

public void setJavacCheck(boolean javacCheck)

Whether to do a javac check before invoking the Enunciate mechanism.

Parameters:

javacCheck - Whether to do a javac check before invoking the Enunciate mechanism.

isCompileDebugInfo

public boolean isCompileDebugInfo()

Whether to compile with debug info.

Returns:

Whether to compile with debug info.

setCompileDebugInfo

public void setCompileDebugInfo(boolean compileDebugInfo)

Whether to compile with debug info.

Parameters:

compileDebugInfo - Whether to compile with debug info.

getConfigFile

public File getConfigFile()

The enunciate config file.

Returns:

The enunciate config file.

setConfigFile

public void setConfigFile(File configFile)

The enunciate config file.

Parameters:

configFile - The enunciate config file.

getCompileDir

public File getCompileDir()

The destination directory for the compiled classes.

Returns:

The destination directory for the compiled classes.

setCompileDir

public void setCompileDir(File compileDir)

The destination directory for the compiled classes.

Parameters:

compileDir - The destination directory for the compiled classes.

getBuildDir

public File getBuildDir()

The directory to use to build the war.

Returns:

The directory to use to build the war.

setBuildDir

public void setBuildDir(File buildDir)

The directory to use to build the war.

Parameters:

buildDir - The directory to use to build the war.

getPackageDir

public File getPackageDir()

The package directory.

Returns:

The package directory.

setPackageDir

public void setPackageDir(File packageDir)

The package directory.

Parameters:

packageDir - The package directory.

getScratchDir

public File getScratchDir()

A scratch directory for Enunciate to use.

Returns:

A scratch directory for Enunciate to use.

setScratchDir

public void setScratchDir(File scratchDir)

A scratch directory for Enunciate to use.

Parameters:

scratchDir - A scratch directory for Enunciate to use.

getGenerateDir

public File getGenerateDir()

The preprocessor directory (-s).

Returns:

The preprocessor directory (-s).

setGenerateDir

public void setGenerateDir(File generateDir)

The preprocessor directory (-s).

Parameters:

generateDir - The preprocessor directory (-s).

getRuntimeClasspath

public String getRuntimeClasspath()

The runtime classpath.

Returns:

The runtime classpath.

setRuntimeClasspath

public void setRuntimeClasspath(String runtimeClasspath)

The runtime classpath.

Parameters:

runtimeClasspath - The runtime classpath.

getBuildClasspath

public String getBuildClasspath()

The build classpath.

Returns:

The build classpath.

setBuildClasspath

public void setBuildClasspath(String buildClasspath)

The build classpath.

Parameters:

buildClasspath - The build classpath.

getTarget

public Enunciate.Target getTarget()

The target.

Returns:

The target.

setTarget

public void setTarget(Enunciate.Target target)

The target.

Parameters:

target - The target.

setProperty

public void setProperty(String property,
                        Object value)

Set a property value.

Parameters:

property - The property.

value - The value.

getArtifacts

public Set<Artifact> getArtifacts()

The artifacts exportable by enunciate.

Returns:

The artifacts exportable by enunciate.

findArtifact

public Artifact findArtifact(String artifactId)

Finds the artifact of the given id.

Parameters:

artifactId - The id of the artifact.

Returns:

The artifact, or null if the artifact wasn't found.

addArtifact

public boolean addArtifact(Artifact artifact)

Adds the specified artifact.

Parameters:

artifact - The artifact to add.

Returns:

Whether the artifact was successfully added.

addWebAppFragment

public void addWebAppFragment(WebAppFragment fragment)

Add a webapp fragment for Enunciate to process.

Parameters:

fragment - The fragment.

getWebAppFragments

public Set<WebAppFragment> getWebAppFragments()

The webapp fragments.

Returns:

The webapp fragments.

addAdditionalSourceRoot

public void addAdditionalSourceRoot(File root)

Add an additional source root for Enunciate to process.

Parameters:

root - The source root directory.

getAdditionalSourceRoots

public Set<File> getAdditionalSourceRoots()

The additional source roots.

Returns:

The additional source roots.

addExport

public void addExport(String artifactId,
                      File destination)

Adds an export.

Parameters:

artifactId - The id of the artifact to export.

destination - The file or directory to export the artifact to.

getProperty

public Object getProperty(String property)

Get a property value.

Parameters:

property - The property whose value to retrieve.

Returns:

The property value.

getConfig

public EnunciateConfiguration getConfig()

Returns:

The configuration.

isModuleEnabled

public boolean isModuleEnabled(String moduleName)

Whether the specified module is enabled.

Parameters:

moduleName - The name of the module.

Returns:

Whether the module is enabled.

setConfig

public void setConfig(EnunciateConfiguration config)

Set the configuration for the mechanism.

Parameters:

config - The configuration.