org.broadleafcommerce.common.extensibility.jpa.copy

Class DirectCopyClassTransformer

java.lang.Object

org.broadleafcommerce.common.extensibility.jpa.copy.AbstractClassTransformer

org.broadleafcommerce.common.extensibility.jpa.copy.DirectCopyClassTransformer

All Implemented Interfaces:

javax.persistence.spi.ClassTransformer, BroadleafClassTransformer, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

OptionalDirectCopyClassTransformer

public class DirectCopyClassTransformer
extends AbstractClassTransformer
implements BroadleafClassTransformer

This class transformer will copy fields, methods, and interface definitions from a source class to a target class, based on the xformTemplates map. It will fail if it encounters any duplicate definitions.

Author:

Andre Azzolini (apazzolini), Jeff Fischer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DirectCopyClassTransformer.XFormParams

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<String>	annotationTransformedClasses
protected ConditionalDirectCopyTransformersManager	conditionalDirectCopyTransformersManager
protected List<DirectCopyIgnorePattern>	ignorePatterns
protected String	moduleName
protected Boolean	renameMethodOverlaps
protected String	renameMethodPrefix
protected Boolean	skipOverlaps
protected Map<String,String>	templateTokens
protected static List<String>	transformedMethods
protected Map<String,String>	xformTemplates

Fields inherited from class org.broadleafcommerce.common.extensibility.jpa.copy.AbstractClassTransformer

alreadyLoadedClasses, preLoadClassNamePatterns

Constructor Summary

Constructors

Constructor and Description
DirectCopyClassTransformer(String moduleName)

Method Summary

Modifier and Type	Method and Description
DirectCopyClassTransformer	addXformTemplate(String classToTransform, String contributingClass)
protected void	buildClassCacheAnnotation(javassist.bytecode.ClassFile classFile, javassist.bytecode.ClassFile templateClassFile, javassist.bytecode.ConstPool constantPool) Allows replacing of Cache annotations at the class level
protected void	buildClassLevelAnnotations(javassist.bytecode.ClassFile classFile, javassist.bytecode.ClassFile templateClassFile, javassist.bytecode.ConstPool constantPool)
protected void	buildEntityListenerAnnotations(javassist.bytecode.ClassFile classFile, javassist.bytecode.ClassFile templateClassFile, javassist.bytecode.ConstPool constantPool)
protected javassist.bytecode.annotation.Annotation	cloneIndexAnnotation(javassist.bytecode.annotation.Annotation annotation, javassist.bytecode.ConstPool constantPool)
protected javassist.bytecode.annotation.Annotation	cloneUniqueAnnotation(javassist.bytecode.annotation.Annotation annotation, javassist.bytecode.ConstPool constantPool)
protected DirectCopyClassTransformer.XFormParams	combineXFormParams(DirectCopyClassTransformer.XFormParams defaultParams, DirectCopyClassTransformer.XFormParams conditionalParams) Combines two DirectCopyClassTransformer.XFormParams together with first passed in xformParama supercedes the second passed in parameter.
void	compileJPAProperties(Properties props, Object key)
protected javassist.bytecode.annotation.Annotation	getEntityListeners(javassist.bytecode.ConstPool constantPool, javassist.bytecode.annotation.Annotation existingEntityListeners, javassist.bytecode.annotation.Annotation templateEntityListeners)
List<DirectCopyIgnorePattern>	getIgnorePatterns()
protected String	getImplementationType(String className) This method will do its best to return an implementation type for a given classname.
protected javassist.bytecode.annotation.Annotation	getIndexes(javassist.bytecode.ConstPool constantPool, javassist.bytecode.annotation.Annotation existingTable, javassist.bytecode.annotation.Annotation templateTable)
protected javassist.bytecode.annotation.Annotation	getNewCacheAnnotation(javassist.bytecode.ConstPool constantPool, javassist.bytecode.annotation.Annotation annotation)
Boolean	getRenameMethodOverlaps()
String	getRenameMethodPrefix()
Boolean	getSkipOverlaps()
Map<String,String>	getTemplateTokens()
Map<String,String>	getXformTemplates()
protected String	methodDescription(javassist.CtMethod method)
protected DirectCopyClassTransformer.XFormParams	reviewConditionalDirectCopyTransforms(String convertedClassName, List<DirectCopyIgnorePattern> matchedPatterns) Retrieves DirectCopyTransformTypes that are conditionally/optionally included via properties file.
protected DirectCopyClassTransformer.XFormParams	reviewDirectCopyTransformAnnotations(javassist.CtClass clazz, boolean mySkipOverlaps, boolean myRenameMethodOverlaps, List<DirectCopyIgnorePattern> matchedPatterns) Retrieves DirectCopyTransformTypes that are placed as annotations on classes.
protected List<String>	reviewTemplateTokens(List<DirectCopyIgnorePattern> matchedPatterns, String val)
void	setIgnorePatterns(List<DirectCopyIgnorePattern> ignorePatterns)
void	setRenameMethodOverlaps(Boolean renameMethodOverlaps)
void	setRenameMethodPrefix(String renameMethodPrefix)
void	setSkipOverlaps(Boolean skipOverlaps)
void	setTemplateTokens(Map<String,String> templateTokens)
void	setXformTemplates(Map<String,String> xformTemplates)
byte[]	transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer)
protected void	transformIndexAnnotations(javassist.bytecode.ClassFile classFile, javassist.bytecode.ClassFile templateClassFile, javassist.bytecode.ConstPool constantPool)

Methods inherited from class org.broadleafcommerce.common.extensibility.jpa.copy.AbstractClassTransformer

afterPropertiesSet, setPreLoadClassNamePatterns

Methods inherited from class java.lang.Object

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

Field Detail

transformedMethods

protected static List<String> transformedMethods

annotationTransformedClasses

protected static List<String> annotationTransformedClasses

moduleName

protected String moduleName

xformTemplates

protected Map<String,String> xformTemplates

renameMethodOverlaps

protected Boolean renameMethodOverlaps

renameMethodPrefix

protected String renameMethodPrefix

skipOverlaps

protected Boolean skipOverlaps

templateTokens

protected Map<String,String> templateTokens

ignorePatterns

protected List<DirectCopyIgnorePattern> ignorePatterns

conditionalDirectCopyTransformersManager

protected ConditionalDirectCopyTransformersManager conditionalDirectCopyTransformersManager

Constructor Detail

DirectCopyClassTransformer

public DirectCopyClassTransformer(String moduleName)

Method Detail

compileJPAProperties

public void compileJPAProperties(Properties props,
                                 Object key)
                          throws Exception

Specified by:

compileJPAProperties in interface BroadleafClassTransformer

Throws:

Exception

transform

public byte[] transform(ClassLoader loader,
                        String className,
                        Class<?> classBeingRedefined,
                        ProtectionDomain protectionDomain,
                        byte[] classfileBuffer)
                 throws IllegalClassFormatException

Specified by:

transform in interface javax.persistence.spi.ClassTransformer

Throws:

IllegalClassFormatException

combineXFormParams

protected DirectCopyClassTransformer.XFormParams combineXFormParams(DirectCopyClassTransformer.XFormParams defaultParams,
                                                                    DirectCopyClassTransformer.XFormParams conditionalParams)

Combines two DirectCopyClassTransformer.XFormParams together with first passed in xformParama supercedes the second passed in parameter.

Parameters:

defaultParams -

conditionalParams -

Returns:

reviewDirectCopyTransformAnnotations

protected DirectCopyClassTransformer.XFormParams reviewDirectCopyTransformAnnotations(javassist.CtClass clazz,
                                                                                      boolean mySkipOverlaps,
                                                                                      boolean myRenameMethodOverlaps,
                                                                                      List<DirectCopyIgnorePattern> matchedPatterns)

Retrieves DirectCopyTransformTypes that are placed as annotations on classes.

Parameters:

clazz -

mySkipOverlaps -

myRenameMethodOverlaps -

matchedPatterns -

Returns:

reviewConditionalDirectCopyTransforms

protected DirectCopyClassTransformer.XFormParams reviewConditionalDirectCopyTransforms(String convertedClassName,
                                                                                       List<DirectCopyIgnorePattern> matchedPatterns)

Retrieves DirectCopyTransformTypes that are conditionally/optionally included via properties file.

Parameters:

convertedClassName -

matchedPatterns -

Returns:

See Also:

ConditionalDirectCopyTransformersManager

reviewTemplateTokens

protected List<String> reviewTemplateTokens(List<DirectCopyIgnorePattern> matchedPatterns,
                                            String val)

transformIndexAnnotations

protected void transformIndexAnnotations(javassist.bytecode.ClassFile classFile,
                                         javassist.bytecode.ClassFile templateClassFile,
                                         javassist.bytecode.ConstPool constantPool)
                                  throws javassist.NotFoundException

Throws:

javassist.NotFoundException

getIndexes

protected javassist.bytecode.annotation.Annotation getIndexes(javassist.bytecode.ConstPool constantPool,
                                                              javassist.bytecode.annotation.Annotation existingTable,
                                                              javassist.bytecode.annotation.Annotation templateTable)

cloneIndexAnnotation

protected javassist.bytecode.annotation.Annotation cloneIndexAnnotation(javassist.bytecode.annotation.Annotation annotation,
                                                                        javassist.bytecode.ConstPool constantPool)

cloneUniqueAnnotation

protected javassist.bytecode.annotation.Annotation cloneUniqueAnnotation(javassist.bytecode.annotation.Annotation annotation,
                                                                         javassist.bytecode.ConstPool constantPool)

buildClassLevelAnnotations

protected void buildClassLevelAnnotations(javassist.bytecode.ClassFile classFile,
                                          javassist.bytecode.ClassFile templateClassFile,
                                          javassist.bytecode.ConstPool constantPool)
                                   throws javassist.NotFoundException

Throws:

javassist.NotFoundException

buildEntityListenerAnnotations

protected void buildEntityListenerAnnotations(javassist.bytecode.ClassFile classFile,
                                              javassist.bytecode.ClassFile templateClassFile,
                                              javassist.bytecode.ConstPool constantPool)
                                       throws javassist.NotFoundException

Throws:

javassist.NotFoundException

getEntityListeners

protected javassist.bytecode.annotation.Annotation getEntityListeners(javassist.bytecode.ConstPool constantPool,
                                                                      javassist.bytecode.annotation.Annotation existingEntityListeners,
                                                                      javassist.bytecode.annotation.Annotation templateEntityListeners)

buildClassCacheAnnotation

protected void buildClassCacheAnnotation(javassist.bytecode.ClassFile classFile,
                                         javassist.bytecode.ClassFile templateClassFile,
                                         javassist.bytecode.ConstPool constantPool)
                                  throws javassist.NotFoundException

Allows replacing of Cache annotations at the class level

Parameters:

classFile -

templateClassFile -

constantPool -

Throws:

javassist.NotFoundException

getNewCacheAnnotation

protected javassist.bytecode.annotation.Annotation getNewCacheAnnotation(javassist.bytecode.ConstPool constantPool,
                                                                         javassist.bytecode.annotation.Annotation annotation)

getImplementationType

protected String getImplementationType(String className)

This method will do its best to return an implementation type for a given classname. This will allow weaving template classes to have initialized values. We provide default implementations for List, Map, and Set, and will attempt to utilize a default constructor for other classes. If the className contains an '[', we will return null.

methodDescription

protected String methodDescription(javassist.CtMethod method)

getXformTemplates

public Map<String,String> getXformTemplates()

addXformTemplate

public DirectCopyClassTransformer addXformTemplate(String classToTransform,
                                                   String contributingClass)

Parameters:

classToTransform - the class that will be transformed at runtime

contributingClass - the class that should be bytecode-merged into classToTransform

Returns:

setXformTemplates

public void setXformTemplates(Map<String,String> xformTemplates)

getRenameMethodOverlaps

public Boolean getRenameMethodOverlaps()

setRenameMethodOverlaps

public void setRenameMethodOverlaps(Boolean renameMethodOverlaps)

getRenameMethodPrefix

public String getRenameMethodPrefix()

setRenameMethodPrefix

public void setRenameMethodPrefix(String renameMethodPrefix)

getSkipOverlaps

public Boolean getSkipOverlaps()

setSkipOverlaps

public void setSkipOverlaps(Boolean skipOverlaps)

getTemplateTokens

public Map<String,String> getTemplateTokens()

setTemplateTokens

public void setTemplateTokens(Map<String,String> templateTokens)

getIgnorePatterns

public List<DirectCopyIgnorePattern> getIgnorePatterns()

setIgnorePatterns

public void setIgnorePatterns(List<DirectCopyIgnorePattern> ignorePatterns)