Package com.microstrategy.web.objects.admin.monitors

Interface CacheSource

All Superinterfaces:

IncrementalFetchSettings, MonitorSource

public interface CacheSource
extends IncrementalFetchSettings, MonitorSource

The interface CacheSource is the entry point to retrieve and manipulate caches.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
CacheResults	getCaches()	Retrieves the cache information.
CacheResultsOnServerLevel	getCachesOnServerLevel(java.lang.String nodeName, java.lang.String pollStateId)	THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
CacheManipulator	getManipulator()	Returns the CacheManipulator object to kill jobs.
void	purgeCache(int purgeFlag)	Purge caches of all the projects associated with the current session.
void	purgeCache(java.lang.String projectDSSID, int purgeFlag)	Purge caches of the specified project in the current session.

Methods inherited from interface com.microstrategy.web.objects.admin.monitors.IncrementalFetchSettings

getBlockBegin, getBlockCount, setBlockBegin, setBlockCount

Methods inherited from interface com.microstrategy.web.objects.admin.monitors.MonitorSource

getCountSettings, getFilter, getLevel, getSortCriteria, getType, reset, setLevel

Method Detail

getCaches

CacheResults getCaches()
                throws WebObjectsAdminException

Retrieves the cache information. notes: here fetching caches on project level.

Returns:

a list fo cache information.

Throws:

WebObjectsAdminException - thrown if there is any error occurred.

getCachesOnServerLevel

CacheResultsOnServerLevel getCachesOnServerLevel(java.lang.String nodeName,
                                                 java.lang.String pollStateId)
                                          throws WebObjectsAdminException

THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.

Retrieves certain server' cache information on IServer level. if specify the pollStateId, the IServer will also return the cube cache manipulation status info back.

Parameters:

nodeName - specify cluster node for fetching caches.

pollStateId - the poll state id related to the cache manipulation process.

Returns:

cube cache manipulation status CacheManipulationStatus in CacheResults.

Throws:

WebObjectsAdminException - thrown if there is any error occurred.

getManipulator

CacheManipulator getManipulator()

Returns the CacheManipulator object to kill jobs.

Returns:

the CacheManipulator object

purgeCache

void purgeCache(java.lang.String projectDSSID,
                int purgeFlag)
         throws WebObjectsAdminException

Purge caches of the specified project in the current session.

Parameters:

projectDSSID - the project DSSID.

purgeFlag - a value from EnumDSSXMLPurgeFlag

Throws:

WebObjectsAdminException - thrown if there is any error occurred.

purgeCache

void purgeCache(int purgeFlag)
         throws WebObjectsAdminException

Purge caches of all the projects associated with the current session.

Parameters:

purgeFlag - a value from EnumDSSXMLPurgeFlag

Throws:

WebObjectsAdminException - thrown if there is any error occurred.