com.avaje.ebeaninternal.server.jmx

Class MAdminAutofetch

java.lang.Object

com.avaje.ebeaninternal.server.jmx.MAdminAutofetch

All Implemented Interfaces:

AdminAutofetch, MAdminAutofetchMBean

public class MAdminAutofetch
extends Object
implements MAdminAutofetchMBean, AdminAutofetch

Implementation of the AutoFetchControl.

This is accessible via EbeanServer.getAdminAutofetch() or via JMX MBeans.

Constructor Summary

Constructors

Constructor and Description
MAdminAutofetch(AutoFetchManager autoFetchListener)

Method Summary

Methods

Modifier and Type	Method and Description
int	clearProfilingInfo() Clear all the profiling information.
void	clearQueryStatistics() Clear the query execution statistics.
int	clearTunedQueryInfo() Clear all the tuned query info.
String	collectUsageViaGC() Fire a garbage collection (hint to the JVM).
String	getMode() This controls whether autoFetch is used when it has not been explicitly set on a query via Query#setAutoFetch(boolean).
String	getModeOptions() List of the valid implicit modes that can be used.
int	getProfilingBase() Return the max number of queries profiled (per query point).
int	getProfilingMin() Return the minimum number of queries profiled before autoFetch will start automatically tuning the queries.
double	getProfilingRate() Returns the rate which profiling is collected.
int	getTotalProfileSize() Return the size of the profile map.
int	getTotalTunedQueryCount() Return the number of queries tuned by AutoFetch.
int	getTotalTunedQuerySize() Return the size of the TuneQuery map.
boolean	isProfiling() Return true if profiling is enabled.
boolean	isQueryTuning() Return true if autoFetch is enabled.
void	setMode(String implicitMode) Set the auto fetch mode used when a query has not had Query#setAutoFetch(boolean).
void	setProfiling(boolean enable) Set to true to enable profiling.
void	setProfilingBase(int profilingMax) Set a max number of queries to profile per query point.
void	setProfilingMin(int profilingMin) Set the minimum number of queries profiled per query point before autoFetch will automatically tune the queries.
void	setProfilingRate(double rate) Set the rate at which profiling is collected after the base.
void	setQueryTuning(boolean enable) Set to true to enable autoFetch.
String	updateTunedQueryInfo() This will take the current profiling information and update the "tuned query detail".

Methods inherited from class java.lang.Object

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

Constructor Detail

MAdminAutofetch

public MAdminAutofetch(AutoFetchManager autoFetchListener)

Method Detail

isQueryTuning

public boolean isQueryTuning()

Description copied from interface: MAdminAutofetchMBean

Return true if autoFetch is enabled.

Specified by:

isQueryTuning in interface AdminAutofetch

Specified by:

isQueryTuning in interface MAdminAutofetchMBean

setQueryTuning

public void setQueryTuning(boolean enable)

Description copied from interface: MAdminAutofetchMBean

Set to true to enable autoFetch.

Specified by:

setQueryTuning in interface AdminAutofetch

Specified by:

setQueryTuning in interface MAdminAutofetchMBean

isProfiling

public boolean isProfiling()

Description copied from interface: MAdminAutofetchMBean

Return true if profiling is enabled.

Specified by:

isProfiling in interface AdminAutofetch

Specified by:

isProfiling in interface MAdminAutofetchMBean

setProfiling

public void setProfiling(boolean enable)

Description copied from interface: MAdminAutofetchMBean

Set to true to enable profiling.

Specified by:

setProfiling in interface AdminAutofetch

Specified by:

setProfiling in interface MAdminAutofetchMBean

getModeOptions

public String getModeOptions()

Description copied from interface: MAdminAutofetchMBean

List of the valid implicit modes that can be used.

Specified by:

getModeOptions in interface MAdminAutofetchMBean

getMode

public String getMode()

Description copied from interface: MAdminAutofetchMBean

This controls whether autoFetch is used when it has not been explicitly set on a query via Query#setAutoFetch(boolean).

Specified by:

getMode in interface MAdminAutofetchMBean

setMode

public void setMode(String implicitMode)

Description copied from interface: MAdminAutofetchMBean

Set the auto fetch mode used when a query has not had Query#setAutoFetch(boolean).

Specified by:

setMode in interface MAdminAutofetchMBean

collectUsageViaGC

public String collectUsageViaGC()

Description copied from interface: MAdminAutofetchMBean

Fire a garbage collection (hint to the JVM). Assuming garbage collection fires this will gather the usage profiling information.

Specified by:

collectUsageViaGC in interface AdminAutofetch

Specified by:

collectUsageViaGC in interface MAdminAutofetchMBean

getProfilingRate

public double getProfilingRate()

Description copied from interface: MAdminAutofetchMBean

Returns the rate which profiling is collected. This is an int between 0 and 100.

Specified by:

getProfilingRate in interface AdminAutofetch

Specified by:

getProfilingRate in interface MAdminAutofetchMBean

setProfilingRate

public void setProfilingRate(double rate)

Description copied from interface: MAdminAutofetchMBean

Set the rate at which profiling is collected after the base.

Specified by:

setProfilingRate in interface AdminAutofetch

Specified by:

setProfilingRate in interface MAdminAutofetchMBean

Parameters:

rate - a int between 0 and 100.

getProfilingMin

public int getProfilingMin()

Description copied from interface: MAdminAutofetchMBean

Return the minimum number of queries profiled before autoFetch will start automatically tuning the queries.

This could be one which means start autoFetch tuning after the first profiling information is collected.

Specified by:

getProfilingMin in interface AdminAutofetch

Specified by:

getProfilingMin in interface MAdminAutofetchMBean

getProfilingBase

public int getProfilingBase()

Description copied from interface: MAdminAutofetchMBean

Return the max number of queries profiled (per query point).

The number of queries profiled is collected per query point. Once a query point has profiled this number of queries it does not profile any more.

Specified by:

getProfilingBase in interface AdminAutofetch

Specified by:

getProfilingBase in interface MAdminAutofetchMBean

setProfilingMin

public void setProfilingMin(int profilingMin)

Description copied from interface: MAdminAutofetchMBean

Set the minimum number of queries profiled per query point before autoFetch will automatically tune the queries.

Increasing this number will mean more profiling is collected before autoFetch starts tuning the query.

Specified by:

setProfilingMin in interface AdminAutofetch

Specified by:

setProfilingMin in interface MAdminAutofetchMBean

setProfilingBase

public void setProfilingBase(int profilingMax)

Description copied from interface: MAdminAutofetchMBean

Set a max number of queries to profile per query point.

This number should provide a level of confidence that no more profiling is required for this query point.

Specified by:

setProfilingBase in interface AdminAutofetch

Specified by:

setProfilingBase in interface MAdminAutofetchMBean

updateTunedQueryInfo

public String updateTunedQueryInfo()

Description copied from interface: MAdminAutofetchMBean

This will take the current profiling information and update the "tuned query detail".

This is done periodically and can also be manually invoked.

Specified by:

updateTunedQueryInfo in interface AdminAutofetch

Specified by:

updateTunedQueryInfo in interface MAdminAutofetchMBean

Returns:

a summary of the updates that occurred

clearProfilingInfo

public int clearProfilingInfo()

Description copied from interface: MAdminAutofetchMBean

Clear all the profiling information.

This means the profiling information will need to be re-gathered.

Should only need do this for testing and playing around.

Specified by:

clearProfilingInfo in interface AdminAutofetch

Specified by:

clearProfilingInfo in interface MAdminAutofetchMBean

Returns:

the amount of profiled information cleared.

clearTunedQueryInfo

public int clearTunedQueryInfo()

Description copied from interface: MAdminAutofetchMBean

Clear all the tuned query info.

Should only need do this for testing and playing around.

Specified by:

clearTunedQueryInfo in interface AdminAutofetch

Specified by:

clearTunedQueryInfo in interface MAdminAutofetchMBean

Returns:

the amount of tuned query information cleared.

clearQueryStatistics

public void clearQueryStatistics()

Description copied from interface: AdminAutofetch

Clear the query execution statistics.

Specified by:

clearQueryStatistics in interface AdminAutofetch

getTotalProfileSize

public int getTotalProfileSize()

Description copied from interface: MAdminAutofetchMBean

Return the size of the profile map.

Specified by:

getTotalProfileSize in interface AdminAutofetch

Specified by:

getTotalProfileSize in interface MAdminAutofetchMBean

getTotalTunedQueryCount

public int getTotalTunedQueryCount()

Description copied from interface: MAdminAutofetchMBean

Return the number of queries tuned by AutoFetch.

Specified by:

getTotalTunedQueryCount in interface AdminAutofetch

Specified by:

getTotalTunedQueryCount in interface MAdminAutofetchMBean

getTotalTunedQuerySize

public int getTotalTunedQuerySize()

Description copied from interface: MAdminAutofetchMBean

Return the size of the TuneQuery map.

Specified by:

getTotalTunedQuerySize in interface AdminAutofetch

Specified by:

getTotalTunedQuerySize in interface MAdminAutofetchMBean