com.haulmont.cuba.core.jmx

Interface PersistenceManagerMBean

All Known Implementing Classes:

PersistenceManager

@ManagedResource(description="Manages entity statistics and updates database")
public interface PersistenceManagerMBean

JMX interface for PersistenceManagerAPI.

Method Summary

Modifier and Type	Method and Description
java.lang.String	deleteStatistics(java.lang.String entityName)
java.lang.String	enterStatistics(java.lang.String entityName, java.lang.Long instanceCount, java.lang.Integer fetchUI, java.lang.Integer maxFetchUI, java.lang.Integer lazyCollectionThreshold, java.lang.Integer lookupScreenThreshold) Manually update statistics for an entity.
java.lang.String	findUpdateDatabaseScripts() Show database update scripts that will be executed on next update.
java.lang.String	flushStatisticsCache() Flush statistics cache.
java.lang.String	getDbmsType()
java.lang.String	getDbmsVersion()
int	getDefaultFetchUI()
int	getDefaultLazyCollectionThreshold()
int	getDefaultLookupScreenThreshold()
int	getDefaultMaxFetchUI()
java.lang.String	jpqlExecuteUpdate(java.lang.String queryString, boolean softDeletion) Execute a JPQL update statement.
java.lang.String	jpqlLoadList(java.lang.String queryString) Execute a JPQL query.
java.lang.String	printViewRepositoryDump()
java.lang.String	printViewRepositoryDumpHtml()
java.lang.String	refreshStatistics(java.lang.String entityName) Calculate and refresh statistics for the specified entity.
void	setDefaultFetchUI(int value)
void	setDefaultLazyCollectionThreshold(int value)
void	setDefaultLookupScreenThreshold(int value)
void	setDefaultMaxFetchUI(int value)
java.lang.String	showStatistics(java.lang.String entityName) Show current statistics for the specified entity.
java.lang.String	updateDatabase(java.lang.String token) Start the database update.

Method Detail

getDbmsType

java.lang.String getDbmsType()

getDbmsVersion

java.lang.String getDbmsVersion()

getDefaultLookupScreenThreshold

int getDefaultLookupScreenThreshold()

setDefaultLookupScreenThreshold

void setDefaultLookupScreenThreshold(int value)

getDefaultLazyCollectionThreshold

int getDefaultLazyCollectionThreshold()

setDefaultLazyCollectionThreshold

void setDefaultLazyCollectionThreshold(int value)

getDefaultFetchUI

int getDefaultFetchUI()

setDefaultFetchUI

void setDefaultFetchUI(int value)

getDefaultMaxFetchUI

int getDefaultMaxFetchUI()

setDefaultMaxFetchUI

void setDefaultMaxFetchUI(int value)

printViewRepositoryDump

@ManagedOperation(description="Show list of views with properties from ViewRepository")
java.lang.String printViewRepositoryDump()

printViewRepositoryDumpHtml

@ManagedOperation(description="Print list of views with properties from ViewRepository as HTML markup")
java.lang.String printViewRepositoryDumpHtml()

updateDatabase

@ManagedOperation(description="Start the database update")
 @ManagedOperationParameters(value=@ManagedOperationParameter(name="token",description="Enter \'update\' here"))
java.lang.String updateDatabase(java.lang.String token)

Start the database update.

Parameters:

token - 'update' string must be passed to avoid accidental invocation

Returns:

operation result

findUpdateDatabaseScripts

@ManagedOperation(description="Show database update scripts that will be executed on next update")
java.lang.String findUpdateDatabaseScripts()

Show database update scripts that will be executed on next update.

Returns:

operation result

jpqlLoadList

@ManagedOperation(description="Execute a JPQL query")
 @ManagedOperationParameters(value=@ManagedOperationParameter(name="queryString",description="May contain security-related parameters: session$userLogin, session$userId, session$userGroupId, session$<SESSION_ATTRIBUTE>"))
java.lang.String jpqlLoadList(java.lang.String queryString)

Execute a JPQL query.

The query may contain security-related parameters specified in PersistenceSecurity. This is a way to test some JPQL code in the real server environment

Parameters:

queryString - JPQL query string

Returns:

list of loaded entities as string

jpqlExecuteUpdate

@ManagedOperation(description="Execute a JPQL update statement")
 @ManagedOperationParameter(name="queryString",description="") @ManagedOperationParameter(name="softDeletion",description="")
java.lang.String jpqlExecuteUpdate(java.lang.String queryString,
                                                                                                                                                                                                                                  boolean softDeletion)

Execute a JPQL update statement.

Parameters:

queryString - JPQL update statement

softDeletion - soft deletion sign

Returns:

number of entity instances affected by update

refreshStatistics

@ManagedOperation(description="Calculate and refresh statistics for the specified entity")
 @ManagedOperationParameters(value=@ManagedOperationParameter(name="entityName",description="MetaClass name, e.g. \'sec$User\', or \'all\' to refresh for all entities"))
java.lang.String refreshStatistics(java.lang.String entityName)

Calculate and refresh statistics for the specified entity. This method updates statistics in the database table and in cache.

Parameters:

entityName - entity name or 'all' to refresh for all entities

Returns:

operation result

showStatistics

@ManagedOperation(description="Show current statistics for the specified entity")
 @ManagedOperationParameters(value=@ManagedOperationParameter(name="entityName",description="MetaClass name, e.g. sec$User"))
java.lang.String showStatistics(java.lang.String entityName)

Show current statistics for the specified entity.

Parameters:

entityName - entity name or blank to show all entities

Returns:

operation result

enterStatistics

@ManagedOperation(description="Enter statistics for the specified entity")
 @ManagedOperationParameter(name="entityName",description="MetaClass name, e.g. sec$User") @ManagedOperationParameter(name="instanceCount",description="") @ManagedOperationParameter(name="fetchUI",description="") @ManagedOperationParameter(name="maxFetchUI",description="") @ManagedOperationParameter(name="lazyCollectionThreshold",description="") @ManagedOperationParameter(name="lookupScreenThreshold",description="")
java.lang.String enterStatistics(java.lang.String entityName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                java.lang.Long instanceCount,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                java.lang.Integer fetchUI,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                java.lang.Integer maxFetchUI,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                java.lang.Integer lazyCollectionThreshold,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                java.lang.Integer lookupScreenThreshold)

Manually update statistics for an entity.

deleteStatistics

@ManagedOperation(description="Delete statistics for the specified entity")
 @ManagedOperationParameters(value=@ManagedOperationParameter(name="entityName",description="MetaClass name, e.g. sec$User"))
java.lang.String deleteStatistics(java.lang.String entityName)

flushStatisticsCache

@ManagedOperation(description="Flush statistics cache. It will be reloaded on a next request")
java.lang.String flushStatisticsCache()

Flush statistics cache. It will be loaded on a next request.

Returns:

operation result