com.goldencode.p2j.compile

Class PostCompilationOpsDriver

java.lang.Object

com.goldencode.p2j.compile.PostCompilationOpsDriver

public class PostCompilationOpsDriver
extends java.lang.Object

Entry point used for extra operations at the end of the compilation stage. Currently used for: Generating at end of compilation stage the implementation classes for DMO interfaces and proxy classes for DMO buffer interfaces.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	classesDirectories The directories where all target .class files are located.
private static java.net.URLClassLoader	classLoader A URL class loader used for loading the DMO interface classes from any provided path.
private static java.lang.String	dmoBlacklistSeparator Character used to separate paths in the blacklist given as argument.
private static java.lang.String[]	dmoBufImplClassesDirectories The directories in which all the DMO implementation classes will be saved.
private static java.lang.String	dmoBufProxiesJarPath Path to the jar containing the DMO buffer proxy classes.
private static java.lang.String[]	dmoImplClassesDirectories The directories in which all the DMO implementation classes will be saved.
private static java.lang.String	dmoImplsJarPath Path to the jar containing the DMO implementations.
private static java.util.Set<java.lang.String>	dmoPathsBlacklist A set of folders to skip processing.
private static java.lang.String	dmosDirectory A relative path from a classesDirectories path to the folder containing the DMO classes.
private static CentralLogger	log Logger
private static boolean	LOG_FINE Do we log FINE-level events ?
private static boolean	LOG_WARNING Do we log WARNING-level events ?
private static java.util.Map<java.lang.String,java.lang.String>	proxyCache Cache mapping a string representation of a ProxyFactory.CacheKey to the name of a new proxy class.
private static java.io.File	proxyCacheFile The file/path where the proxyCache will be saved on disk.

Constructor Summary

Constructors

Constructor and Description
PostCompilationOpsDriver()

Method Summary

Modifier and Type	Method and Description
private static void	createImplementations() Method responsible for searching for all DMO interfaces and DMO buffer interfaces in the provided directory and attempt to create an implementation/proxy class and save that class to disk.
private static void	createJar(java.lang.String jarPath, java.lang.String[] classesFolders) Method used to create a jar from a given list of directories.
private static void	createJarHelper(java.io.File source, java.util.jar.JarOutputStream target, java.lang.Integer nameSubstringIndex, java.util.Set<java.lang.String> packages) Helper method for creating a jar.
private static DmoClass	generateImplementationDmo(java.lang.Class<? extends DataModelObject> dmoIface) This method is responsible for setting up objects needed to generate a DMO implementation class for a DMO interface provided, and use DmoClass to create and provide the DMO class object.
private static void	handleDmoBufInterface(java.lang.String dmoBufBinaryName, java.lang.String classDestination) This method is responsible for trying to create a proxy class for a DMO buffer interface.
private static void	handleDmoInterface(java.lang.String dmoBinaryName, java.lang.String classDestination) This method is responsible for attempting to load a DMO interface class with the given binary name (package name, with dot separator), generate for it an implementation class object and save the new class to a file on disk.
private static boolean	isDmoBufInterface(java.lang.String fileName, java.lang.String schemaDirectory) Check whether the name given respects a minimum of conditions to be considered the name of a DMO buffer interface.
private static boolean	isDmoInterface(java.lang.String fileName, java.lang.String schemaDirectory) Check whether the name given respects a minimum of conditions to be considered the name of a DMO interface.
static void	main(java.lang.String[] args) Main method of entry point where post compilation operations are started.
private static void	writeClassToDisk(java.lang.String internalName, byte[] code, java.lang.String destinationFolder) This method is used to write to disk the bytecode of a class, with all necessary information required given as parameter.
private static void	writeJarIndex(java.util.jar.JarOutputStream jos, java.util.Set<java.lang.String> packages) Writes the jar index to the jar file's META-INF directory.
private static void	writeProxyCacheToDisk() This method is responsible for writing to disk the proxyCache map object, meant to be retrieved by ProxyFactory at server runtime.

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final CentralLogger log

Logger

LOG_WARNING

private static final boolean LOG_WARNING

Do we log WARNING-level events ?

LOG_FINE

private static final boolean LOG_FINE

Do we log FINE-level events ?

classesDirectories

private static java.lang.String[] classesDirectories

The directories where all target .class files are located. Given at command line as one string with paths separated by ':'. Paths should be relative to the current working directory.

dmoImplClassesDirectories

private static java.lang.String[] dmoImplClassesDirectories

The directories in which all the DMO implementation classes will be saved.

dmoBufImplClassesDirectories

private static java.lang.String[] dmoBufImplClassesDirectories

The directories in which all the DMO implementation classes will be saved.

dmosDirectory

private static java.lang.String dmosDirectory

A relative path from a classesDirectories path to the folder containing the DMO classes.

dmoPathsBlacklist

private static java.util.Set<java.lang.String> dmoPathsBlacklist

A set of folders to skip processing.

dmoBlacklistSeparator

private static java.lang.String dmoBlacklistSeparator

Character used to separate paths in the blacklist given as argument.

classLoader

private static java.net.URLClassLoader classLoader

A URL class loader used for loading the DMO interface classes from any provided path.

proxyCache

private static java.util.Map<java.lang.String,java.lang.String> proxyCache

Cache mapping a string representation of a ProxyFactory.CacheKey to the name of a new proxy class.

proxyCacheFile

private static java.io.File proxyCacheFile

The file/path where the proxyCache will be saved on disk.

dmoImplsJarPath

private static java.lang.String dmoImplsJarPath

Path to the jar containing the DMO implementations.

dmoBufProxiesJarPath

private static java.lang.String dmoBufProxiesJarPath

Path to the jar containing the DMO buffer proxy classes.

Constructor Detail

PostCompilationOpsDriver

public PostCompilationOpsDriver()

Method Detail

main

public static void main(java.lang.String[] args)

Main method of entry point where post compilation operations are started. These operations include: Generating implementation classes of existing DMO interfaces and saving them to disk.

Parameters:

args - List of command line arguments. The arguments are as follow: args[0] - folders containing .class files, separated by : example: ${build.home}/classes/:${build.home}/classes2/:${build.home}/classes3/ args[1] - relative path from any of the folders in args[0] to a folder containing DMOs args[2] - blacklist paths, won't process these schema folders, separated by : args[3] - where to save all the dmo implementations args[4] - where to save all the dmo buf proxies args[5] - where to save the map file that helps associate a Proxy class file name to the interfaces/classes names that were used to generate it. args[6] - where the jar with the dmo implementations will be saved args[7] - where the jar with the dmo buffer proxies will be saved

createImplementations

private static void createImplementations()

Method responsible for searching for all DMO interfaces and DMO buffer interfaces in the provided directory and attempt to create an implementation/proxy class and save that class to disk.

createJar

private static void createJar(java.lang.String jarPath,
                              java.lang.String[] classesFolders)

Method used to create a jar from a given list of directories. The directories themselves will not be part of each jar entries path/name. If a jar with this path already exists, it will first be deleted. The classes directories will also be deleted when the files within are added to the jar.

Parameters:

jarPath - The path of the new jar.

classesFolders - The folders to be jarred.

writeJarIndex

private static void writeJarIndex(java.util.jar.JarOutputStream jos,
                                  java.util.Set<java.lang.String> packages)
                           throws java.io.IOException

Writes the jar index to the jar file's META-INF directory.

Parameters:

jos - The JarOutputStream to write the index to.

packages - The set of package names to include in the index.

Throws:

java.io.IOException - Exception that can be thrown by the JarOutputStream object, not handled here.

createJarHelper

private static void createJarHelper(java.io.File source,
                                    java.util.jar.JarOutputStream target,
                                    java.lang.Integer nameSubstringIndex,
                                    java.util.Set<java.lang.String> packages)
                             throws java.io.IOException

Helper method for creating a jar. Receives the file/directory to be added to the jar, and the stream used to write to the jar. Calls itself recursively for every directory in the source File, if that is a directory. Otherwise, it adds the source File to the jar.

Parameters:

source - The class file or directory containing class files that will be added to the jar.

target - The stream used to add files to the jar.

nameSubstringIndex - How much of the sources path name to skip when adding the new entry to the jar.

packages - The set to collect package names.

Throws:

java.io.IOException - Exception that can be thrown by the JarOutputStream object, not handled here.

handleDmoBufInterface

private static void handleDmoBufInterface(java.lang.String dmoBufBinaryName,
                                          java.lang.String classDestination)

This method is responsible for trying to create a proxy class for a DMO buffer interface. The steps include attempting to load the DMO buffer interface and the DMO interface, generating the proxy assembler, adding the new proxy class data to the cache and writing the code to a .class file on disk.

Parameters:

dmoBufBinaryName - The name of the DMO buffer interface, with dot separators between packages.

classDestination - The folder where the .class file and it's packages will be created.

handleDmoInterface

private static void handleDmoInterface(java.lang.String dmoBinaryName,
                                       java.lang.String classDestination)

This method is responsible for attempting to load a DMO interface class with the given binary name (package name, with dot separator), generate for it an implementation class object and save the new class to a file on disk.

Parameters:

dmoBinaryName - The name of a DMO buffer interface, with dot separators between packages.

classDestination - The folder where the .class file and it's packages will be created.

isDmoBufInterface

private static boolean isDmoBufInterface(java.lang.String fileName,
                                         java.lang.String schemaDirectory)

Check whether the name given respects a minimum of conditions to be considered the name of a DMO buffer interface.

Parameters:

fileName - The name of a class file, with the extension.

schemaDirectory - The name of the schema directory that contains this class file.

Returns:

True if it can be a DMO buffer interface name. False otherwise.

isDmoInterface

private static boolean isDmoInterface(java.lang.String fileName,
                                      java.lang.String schemaDirectory)

Check whether the name given respects a minimum of conditions to be considered the name of a DMO interface.

Parameters:

fileName - The name of a class file, with the extension.

schemaDirectory - The name of the schema directory that contains this class file.

Returns:

True if it can be a DMO interface name. False otherwise.

generateImplementationDmo

private static DmoClass generateImplementationDmo(java.lang.Class<? extends DataModelObject> dmoIface)

This method is responsible for setting up objects needed to generate a DMO implementation class for a DMO interface provided, and use DmoClass to create and provide the DMO class object.

Parameters:

dmoIface - The class of a DMO interface for which we generate an implementation class.

Returns:

An object representing the newly generated DMO implementation class.

writeProxyCacheToDisk

private static void writeProxyCacheToDisk()

This method is responsible for writing to disk the proxyCache map object, meant to be retrieved by ProxyFactory at server runtime.

writeClassToDisk

private static void writeClassToDisk(java.lang.String internalName,
                                     byte[] code,
                                     java.lang.String destinationFolder)

This method is used to write to disk the bytecode of a class, with all necessary information required given as parameter.

Parameters:

internalName - The internal name of the class to write to file, containing the class name and package with slash separators.

code - The bytecode of the class that needs to be written to file.

destinationFolder - The folder path where the new .class file will be saved. Additional directories will be created for the packages that appear in the internalName argument.