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

Interface CacheManipulator

All Superinterfaces:

MonitorManipulator

public interface CacheManipulator
extends MonitorManipulator

The interface CacheManipulator contains operations to manage caches.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
void	addManipualtionTask(java.lang.String projectDSSID, int action, MonitorFilter filter)	Adds to the task list for batch operation on caches.
void	alter(java.lang.String projectDSSID, int action, MonitorFilter filter)	Alters caches associated with the specified project.
java.util.Optional<java.lang.String>	alter(java.lang.String nodeName, java.lang.String projectDSSID, int action, MonitorFilter filter, boolean isAsync)	THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
MonitorFilter	newMonitorFilter()	Creates a new MonitorFilter object, used in cache management.

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

clear, submit

Method Detail

newMonitorFilter

MonitorFilter newMonitorFilter()

Creates a new MonitorFilter object, used in cache management.

Returns:

a new MonitorFilter object.

alter

void alter(java.lang.String projectDSSID,
           int action,
           MonitorFilter filter)
    throws MonitorManipulationException,
           WebObjectsAdminException

Alters caches associated with the specified project.

Parameters:

projectDSSID - the ID of a project.

action - cache administrative action, a value from EnumDSSXMLCacheAdminAction

filter - a qualifying condition to filter caches

Throws:

MonitorManipulationException - thrown if there is any failure in managing caches.

WebObjectsAdminException - throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.

alter

java.util.Optional<java.lang.String> alter(java.lang.String nodeName,
                                           java.lang.String projectDSSID,
                                           int action,
                                           MonitorFilter filter,
                                           boolean isAsync)
                                    throws MonitorManipulationException,
                                           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. Alters caches associated with the specified project on specific cluster node. notes: here can specify alteration behavior is asynchronous or not. if the manipulation is async, it will return manipulationInstanceId, if the manipulation is sync, it will return Optional.empty().

Parameters:

projectDSSID - the ID of a project.

action - cache administrative action, a value from EnumDSSXMLCacheAdminAction

filter - a qualifying condition to filter caches

isAsync - a flag to control alter behavior is async or not

Returns:

if the manipulation is async, it will return manipulationInstanceId, if sync, it will return Optional.empty().

Throws:

MonitorManipulationException - thrown if there is any failure in managing caches.

WebObjectsAdminException - throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.

addManipualtionTask

void addManipualtionTask(java.lang.String projectDSSID,
                         int action,
                         MonitorFilter filter)

Adds to the task list for batch operation on caches.

Parameters:

projectDSSID - the ID of a project.

action - cache administrative action, a value from EnumDSSXMLCacheAdminAction

filter - a qualifying condition to filter caches