com.citytechinc.cq.component.maven.util

Class ComponentMojoUtil

java.lang.Object

com.citytechinc.cq.component.maven.util.ComponentMojoUtil

public class ComponentMojoUtil
extends Object

Method Summary

Modifier and Type	Method and Description
static void	buildArchiveFileForProjectAndClassList(List<javassist.CtClass> classList, WidgetRegistry widgetRegistry, TouchUIWidgetRegistry touchUIWidgetRegistry, InPlaceEditorRegistry inPlaceEditorRegistry, ClassLoader classLoader, javassist.ClassPool classPool, File buildDirectory, String componentPathBase, String defaultComponentPathSuffix, String defaultComponentGroup, File existingArchiveFile, File tempArchiveFile, ComponentNameTransformer transformer, boolean generateTouchUiDialogs, boolean useCoral3Dialogs, boolean generateClassicUiDialogs) Add files to the already constructed Archive file by creating a new Archive file, appending the contents of the existing Archive file to it, and then adding additional entries for the newly constructed artifacts.
protected static String	classNameFromFilePath(String filePath, String rootPath) Constructs a fully qualified class name based on the path to the class file
static List<javassist.CtField>	collectFields(javassist.CtClass ctClass)
static List<javassist.CtField>	collectFields(javassist.CtClass ctClass, boolean suppressInheritedFields) Constructs a list of all fields contained in the provided CtClass and any of its parent classes.
static List<javassist.CtMethod>	collectMethods(javassist.CtClass ctClass)
static List<javassist.CtMethod>	collectMethods(javassist.CtClass ctClass, boolean suppressInheritedMethods)
protected static void	deleteTemporaryComponentOutputDirectory(File buildDirectory) Deletes the temporary output directory which is created as part of the build process to temporarily hold the generated files for components.
static List<javassist.CtClass>	getAllComponentAnnotations(javassist.ClassPool classPool, org.reflections.Reflections reflections, Set<String> excludedClasses) Retrieves a List of all classes which are annotated as Components and are within the scope of the provided Reflections purview.
static List<TouchUIWidgetConfigHolder>	getAllTouchUIWidgetAnnotations(javassist.ClassPool classPool, ClassLoader classLoader, org.reflections.Reflections reflections)
static Map<String,ComponentNameTransformer>	getAllTransformers(javassist.ClassPool classPool, org.reflections.Reflections reflections) Retrieves a List of all classes which are annotated as Transformers and are within the scope of the provided Reflections purview.
static List<WidgetConfigHolder>	getAllWidgetAnnotations(javassist.ClassPool classPool, ClassLoader classLoader, org.reflections.Reflections reflections) Constructs a list of widget configurations based on the information provided by classes annotated as Widgets.
protected static File	getArchiveFileForProject(org.apache.maven.project.MavenProject project) Finds and retrieves the constructed CQ Package archive file for the project
static ClassLoader	getClassLoader(List<String> paths, ClassLoader mojoClassLoader) Constructs a Class Loader based on a list of paths to classes and a parent Class Loader
static javassist.ClassPool	getClassPool(ClassLoader loader) Constructs as Javassist ClassPool which pulls resources based on the paths provided by the passed in ClassLoader
static String	getComponentBasePathForComponentClass(javassist.CtClass componentClass, String componentPathBase)
static String	getComponentNameForComponentClass(ComponentNameTransformer transformer, javassist.CtClass componentClass) Determines the name of the component class for use in constructing file paths
static String	getComponentPathSuffixForComponentClass(javassist.CtClass componentClass, String defaultComponentPathSuffix) Determines the suffix portion of the path leading to the artifacts of a particular component
static List<InPlaceEditorConfigHolder>	getInPlaceEditorAnnotations(javassist.ClassPool classPool, ClassLoader classLoader, org.reflections.Reflections reflections)
static LogSingleton	getLog()
static File	getOutputDirectoryForComponentClass(ComponentNameTransformer transformer, javassist.CtClass componentClass, File buildDirectory, String componentPathBase, String defaultComponentPathSuffix) Determine the appropriate output directory for a component's artifacts based on the component class as well as POM configuration.
static org.reflections.Reflections	getReflections(ClassLoader classLoader) Constructs a Reflections object suitable for reflecting on classes accessible via the provided ClassLoader
protected static File	getTempArchiveFileForProject(org.apache.maven.project.MavenProject project) Create a temporary archive file which will live alongside the constructed project CQ5 Package archive.
static void	writeElementToArchiveFile(ComponentNameTransformer transformer, File file, javassist.CtClass componentClass, org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream archiveStream, Set<String> reservedNames, String componentPathBase, String defaultComponentPathSuffix, String path) Writes a provided file to a provided archive output stream at a path determined by the class of the component.
static File	writeElementToFile(ComponentNameTransformer transformer, AbstractXmlElement xmlElement, javassist.CtClass componentClass, File buildDirectory, String componentPathBase, String defaultComponentPathSuffix, String path) Determines the name of the edit file to be written and writes the the file which the provided EditConfig object represents to that determined file.

Methods inherited from class java.lang.Object

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

Method Detail

getLog

public static final LogSingleton getLog()

getClassLoader

public static ClassLoader getClassLoader(List<String> paths,
                                         ClassLoader mojoClassLoader)
                                  throws MalformedURLException

Constructs a Class Loader based on a list of paths to classes and a parent Class Loader

Parameters:

paths -

mojoClassLoader -

Returns:

The constructed ClassLoader

Throws:

MalformedURLException

getClassPool

public static javassist.ClassPool getClassPool(ClassLoader loader)

Constructs as Javassist ClassPool which pulls resources based on the paths provided by the passed in ClassLoader

Returns:

The constructed ClassPool

Throws:

javassist.NotFoundException

classNameFromFilePath

protected static String classNameFromFilePath(String filePath,
                                              String rootPath)

Constructs a fully qualified class name based on the path to the class file

Parameters:

filePath -

rootPath -

Returns:

The constructed class name

buildArchiveFileForProjectAndClassList

public static void buildArchiveFileForProjectAndClassList(List<javassist.CtClass> classList,
                                                          WidgetRegistry widgetRegistry,
                                                          TouchUIWidgetRegistry touchUIWidgetRegistry,
                                                          InPlaceEditorRegistry inPlaceEditorRegistry,
                                                          ClassLoader classLoader,
                                                          javassist.ClassPool classPool,
                                                          File buildDirectory,
                                                          String componentPathBase,
                                                          String defaultComponentPathSuffix,
                                                          String defaultComponentGroup,
                                                          File existingArchiveFile,
                                                          File tempArchiveFile,
                                                          ComponentNameTransformer transformer,
                                                          boolean generateTouchUiDialogs,
                                                          boolean useCoral3Dialogs,
                                                          boolean generateClassicUiDialogs)
                                                   throws OutputFailureException,
                                                          IOException,
                                                          InvalidComponentClassException,
                                                          InvalidComponentFieldException,
                                                          ParserConfigurationException,
                                                          TransformerException,
                                                          ClassNotFoundException,
                                                          javassist.CannotCompileException,
                                                          javassist.NotFoundException,
                                                          SecurityException,
                                                          NoSuchFieldException,
                                                          IllegalArgumentException,
                                                          IllegalAccessException,
                                                          InvocationTargetException,
                                                          NoSuchMethodException,
                                                          InstantiationException,
                                                          TouchUIDialogWriteException,
                                                          TouchUIDialogGenerationException

Add files to the already constructed Archive file by creating a new Archive file, appending the contents of the existing Archive file to it, and then adding additional entries for the newly constructed artifacts.

Parameters:

classList -

classLoader -

classPool -

buildDirectory -

componentPathBase -

defaultComponentPathSuffix -

defaultComponentGroup -

existingArchiveFile -

tempArchiveFile -

Throws:

OutputFailureException

IOException

InvalidComponentClassException

InvalidComponentFieldException

ParserConfigurationException

TransformerException

ClassNotFoundException

javassist.CannotCompileException

javassist.NotFoundException

SecurityException

NoSuchFieldException

IllegalArgumentException

IllegalAccessException

InvocationTargetException

NoSuchMethodException

InstantiationException

TouchUIDialogWriteException

TouchUIDialogGenerationException

getArchiveFileForProject

protected static File getArchiveFileForProject(org.apache.maven.project.MavenProject project)

Finds and retrieves the constructed CQ Package archive file for the project

Parameters:

project -

Returns:

The archive file found for the project

getTempArchiveFileForProject

protected static File getTempArchiveFileForProject(org.apache.maven.project.MavenProject project)

Create a temporary archive file which will live alongside the constructed project CQ5 Package archive.

Parameters:

project -

Returns:

The temporary archive file

getOutputDirectoryForComponentClass

public static File getOutputDirectoryForComponentClass(ComponentNameTransformer transformer,
                                                       javassist.CtClass componentClass,
                                                       File buildDirectory,
                                                       String componentPathBase,
                                                       String defaultComponentPathSuffix)
                                                throws OutputFailureException,
                                                       ClassNotFoundException

Determine the appropriate output directory for a component's artifacts based on the component class as well as POM configuration.

Parameters:

componentClass -

componentPathBase -

Returns:

The determined output directory

Throws:

OutputFailureException

ClassNotFoundException

getComponentBasePathForComponentClass

public static String getComponentBasePathForComponentClass(javassist.CtClass componentClass,
                                                           String componentPathBase)
                                                    throws ClassNotFoundException

Throws:

ClassNotFoundException

deleteTemporaryComponentOutputDirectory

protected static void deleteTemporaryComponentOutputDirectory(File buildDirectory)
                                                       throws IOException

Deletes the temporary output directory which is created as part of the build process to temporarily hold the generated files for components.

Parameters:

buildDirectory -

Throws:

IOException

getComponentPathSuffixForComponentClass

public static String getComponentPathSuffixForComponentClass(javassist.CtClass componentClass,
                                                             String defaultComponentPathSuffix)
                                                      throws ClassNotFoundException

Determines the suffix portion of the path leading to the artifacts of a particular component

Parameters:

componentClass -

defaultComponentPathSuffix -

Returns:

The determined suffix

Throws:

ClassNotFoundException

getComponentNameForComponentClass

public static String getComponentNameForComponentClass(ComponentNameTransformer transformer,
                                                       javassist.CtClass componentClass)
                                                throws ClassNotFoundException

Determines the name of the component class for use in constructing file paths

Parameters:

componentClass -

Returns:

The determined name

Throws:

ClassNotFoundException

getAllWidgetAnnotations

public static List<WidgetConfigHolder> getAllWidgetAnnotations(javassist.ClassPool classPool,
                                                               ClassLoader classLoader,
                                                               org.reflections.Reflections reflections)
                                                        throws ClassNotFoundException,
                                                               javassist.NotFoundException,
                                                               MalformedURLException

Constructs a list of widget configurations based on the information provided by classes annotated as Widgets.

Parameters:

classPool -

classLoader -

reflections -

Returns:

The constructed widget configurations

Throws:

ClassNotFoundException

javassist.NotFoundException

MalformedURLException

getAllTouchUIWidgetAnnotations

public static List<TouchUIWidgetConfigHolder> getAllTouchUIWidgetAnnotations(javassist.ClassPool classPool,
                                                                             ClassLoader classLoader,
                                                                             org.reflections.Reflections reflections)
                                                                      throws javassist.NotFoundException,
                                                                             ClassNotFoundException

Throws:

javassist.NotFoundException

ClassNotFoundException

getInPlaceEditorAnnotations

public static List<InPlaceEditorConfigHolder> getInPlaceEditorAnnotations(javassist.ClassPool classPool,
                                                                          ClassLoader classLoader,
                                                                          org.reflections.Reflections reflections)
                                                                   throws javassist.NotFoundException,
                                                                          ClassNotFoundException

Throws:

javassist.NotFoundException

ClassNotFoundException

getAllComponentAnnotations

public static List<javassist.CtClass> getAllComponentAnnotations(javassist.ClassPool classPool,
                                                                 org.reflections.Reflections reflections,
                                                                 Set<String> excludedClasses)
                                                          throws ClassNotFoundException,
                                                                 javassist.NotFoundException,
                                                                 MalformedURLException

Retrieves a List of all classes which are annotated as Components and are within the scope of the provided Reflections purview.

Parameters:

classPool -

reflections -

Returns:

A List of classes annotated as Components

Throws:

ClassNotFoundException

javassist.NotFoundException

MalformedURLException

getAllTransformers

public static Map<String,ComponentNameTransformer> getAllTransformers(javassist.ClassPool classPool,
                                                                      org.reflections.Reflections reflections)
                                                               throws ClassNotFoundException,
                                                                      javassist.NotFoundException,
                                                                      MalformedURLException,
                                                                      InstantiationException,
                                                                      IllegalAccessException

Retrieves a List of all classes which are annotated as Transformers and are within the scope of the provided Reflections purview.

Parameters:

classPool -

reflections -

Returns:

A Map of transformer names to transformers

Throws:

ClassNotFoundException

javassist.NotFoundException

MalformedURLException

IllegalAccessException

InstantiationException

collectFields

public static List<javassist.CtField> collectFields(javassist.CtClass ctClass,
                                                    boolean suppressInheritedFields)
                                             throws javassist.NotFoundException

Constructs a list of all fields contained in the provided CtClass and any of its parent classes.

Parameters:

ctClass -

Returns:

The constructed list of fields

Throws:

javassist.NotFoundException

collectFields

public static List<javassist.CtField> collectFields(javassist.CtClass ctClass)
                                             throws javassist.NotFoundException

Throws:

javassist.NotFoundException

collectMethods

public static List<javassist.CtMethod> collectMethods(javassist.CtClass ctClass,
                                                      boolean suppressInheritedMethods)

collectMethods

public static List<javassist.CtMethod> collectMethods(javassist.CtClass ctClass)

getReflections

public static org.reflections.Reflections getReflections(ClassLoader classLoader)

Constructs a Reflections object suitable for reflecting on classes accessible via the provided ClassLoader

Parameters:

classLoader - The ClassLoader containing classes to be reflected upon

Returns:

The constructed Reflections object

writeElementToArchiveFile

public static void writeElementToArchiveFile(ComponentNameTransformer transformer,
                                             File file,
                                             javassist.CtClass componentClass,
                                             org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream archiveStream,
                                             Set<String> reservedNames,
                                             String componentPathBase,
                                             String defaultComponentPathSuffix,
                                             String path)
                                      throws IOException,
                                             ClassNotFoundException

Writes a provided file to a provided archive output stream at a path determined by the class of the component.

Parameters:

file -

componentClass -

archiveStream -

reservedNames - A list of files which already exist within the Zip Archive. If a file already exists for a particular component, it is left untouched.

componentPathBase -

Throws:

IOException

ClassNotFoundException

writeElementToFile

public static File writeElementToFile(ComponentNameTransformer transformer,
                                      AbstractXmlElement xmlElement,
                                      javassist.CtClass componentClass,
                                      File buildDirectory,
                                      String componentPathBase,
                                      String defaultComponentPathSuffix,
                                      String path)
                               throws TransformerException,
                                      ParserConfigurationException,
                                      IOException,
                                      OutputFailureException,
                                      ClassNotFoundException,
                                      IllegalArgumentException,
                                      SecurityException,
                                      IllegalAccessException,
                                      InvocationTargetException,
                                      NoSuchMethodException

Determines the name of the edit file to be written and writes the the file which the provided EditConfig object represents to that determined file.

Parameters:

xmlElement -

componentClass -

Returns:

The file written

Throws:

TransformerException

ParserConfigurationException

IOException

OutputFailureException

ClassNotFoundException

NoSuchMethodException

InvocationTargetException

IllegalAccessException

SecurityException

IllegalArgumentException