io.ebean.enhance.common

Class EnhanceContext

java.lang.Object

io.ebean.enhance.common.EnhanceContext

public class EnhanceContext
extends Object

Used to hold meta data, arguments and log levels for the enhancement.

Constructor Summary

Constructors

Constructor and Description
EnhanceContext(ClassBytesReader classBytesReader, String agentArgs, AgentManifest manifest)
EnhanceContext(ClassBytesReader classBytesReader, String agentArgs, AgentManifest manifest, ClassMetaCache metaCache) Construct a context for enhancement.

Method Summary

Modifier and Type	Method and Description
void	addClassMeta(ClassMeta meta)
ClassMeta	createClassMeta() Create a new meta object for enhancing a class.
TransactionalMethodKey	createMethodKey(String className, String methodName, String methodDesc, int profileId) Create a TransactionalMethodKey with (maybe) a profileId.
boolean	detectEntityTransactionalEnhancement(String className) Return true if this class should be scanned for transactional enhancement.
boolean	detectQueryBeanEnhancement(String className) Return true if this class should be scanned for query bean enhancement.
ClassMeta	get(String className)
byte[]	getClassBytes(String className, ClassLoader classLoader)
ClassMeta	getInterfaceMeta(String interfaceClassName, ClassLoader classLoader) Read the class meta data for an interface.
int	getLogLevel() Return the log level.
ClassMeta	getSuperMeta(String superClassName, ClassLoader classLoader) Read the class meta data for a super class.
List<TransactionalMethodKey>	getTransactionProfilingKeys() Return the profiling transaction keys.
boolean	isCheckNullManyFields() Return true if we should add null checking on *ToMany fields.
boolean	isEnableProfileLocation() Return true if profile location enhancement is on.
boolean	isEnableQueryAutoLabel() Return true if enhancement should automatically set labels on queries.
boolean	isIgnoreClass(String className) Return true if this class should be ignored.
boolean	isLog(int level)
boolean	isQueryBean(String owner) Return true if the owner class is a type query bean.
boolean	isThrowOnError() Return true if transform should throw exception rather than log and return null.
boolean	isTransientInternalFields() Return true if internal ebean fields in entity classes should be transient.
void	log(int level, String className, String msg) Log some debug output.
void	log(String className, String msg)
void	log(Throwable e) Log an error.
void	setLogout(MessageOutput logout) Change the logout to something other than system out.
void	setThrowOnError(boolean throwOnError) Set to true if you want transform to throw exceptions rather than return null.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnhanceContext

public EnhanceContext(ClassBytesReader classBytesReader,
                      String agentArgs,
                      AgentManifest manifest)

EnhanceContext

public EnhanceContext(ClassBytesReader classBytesReader,
                      String agentArgs,
                      AgentManifest manifest,
                      ClassMetaCache metaCache)

Construct a context for enhancement.

Method Detail

getClassBytes

public byte[] getClassBytes(String className,
                            ClassLoader classLoader)

isQueryBean

public boolean isQueryBean(String owner)

Return true if the owner class is a type query bean.

If true typically means the caller needs to change GETFIELD calls to instead invoke the generated 'property access' methods.

isEnableProfileLocation

public boolean isEnableProfileLocation()

Return true if profile location enhancement is on.

isEnableQueryAutoLabel

public boolean isEnableQueryAutoLabel()

Return true if enhancement should automatically set labels on queries.

detectEntityTransactionalEnhancement

public boolean detectEntityTransactionalEnhancement(String className)

Return true if this class should be scanned for transactional enhancement.

detectQueryBeanEnhancement

public boolean detectQueryBeanEnhancement(String className)

Return true if this class should be scanned for query bean enhancement.

isIgnoreClass

public boolean isIgnoreClass(String className)

Return true if this class should be ignored. That is JDK classes and known libraries JDBC drivers etc can be skipped.

setLogout

public void setLogout(MessageOutput logout)

Change the logout to something other than system out.

createClassMeta

public ClassMeta createClassMeta()

Create a new meta object for enhancing a class.

getSuperMeta

public ClassMeta getSuperMeta(String superClassName,
                              ClassLoader classLoader)

Read the class meta data for a super class.

Typically used to read meta data for inheritance hierarchy.

getInterfaceMeta

public ClassMeta getInterfaceMeta(String interfaceClassName,
                                  ClassLoader classLoader)

Read the class meta data for an interface.

Typically used to check the interface to see if it is transactional.

addClassMeta

public void addClassMeta(ClassMeta meta)

get

public ClassMeta get(String className)

log

public void log(int level,
                String className,
                String msg)

Log some debug output.

log

public void log(String className,
                String msg)

isLog

public boolean isLog(int level)

log

public void log(Throwable e)

Log an error.

getLogLevel

public int getLogLevel()

Return the log level.

isTransientInternalFields

public boolean isTransientInternalFields()

Return true if internal ebean fields in entity classes should be transient.

isCheckNullManyFields

public boolean isCheckNullManyFields()

Return true if we should add null checking on *ToMany fields.

On getting a many that is null Ebean will create an empty List, Set or Map. If it is a ManyToMany it will turn on Modify listening.

createMethodKey

public TransactionalMethodKey createMethodKey(String className,
                                              String methodName,
                                              String methodDesc,
                                              int profileId)

Create a TransactionalMethodKey with (maybe) a profileId.

getTransactionProfilingKeys

public List<TransactionalMethodKey> getTransactionProfilingKeys()

Return the profiling transaction keys.

isThrowOnError

public boolean isThrowOnError()

Return true if transform should throw exception rather than log and return null.

setThrowOnError

public void setThrowOnError(boolean throwOnError)

Set to true if you want transform to throw exceptions rather than return null.