Interface CacheManipulator
-
- All Superinterfaces:
MonitorManipulator
public interface CacheManipulator extends MonitorManipulator
The interfaceCacheManipulator
contains operations to manage caches.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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.void
alter(java.util.Map<java.lang.String,MonitorFilter> filterMap, java.lang.String nodeName, int action)
Alters content caches associated with the specified projects on specific cluster node.MonitorFilter
newMonitorFilter()
Creates a newMonitorFilter
object, used in cache management.void
submit(java.lang.String nodeName)
Submits the request to the specified Intelligence Server to carry out the content cache monitoring operation All failures are packed together into an array ofMonitorManipulationFailure
objects.-
Methods inherited from interface com.microstrategy.web.objects.admin.monitors.MonitorManipulator
clear, submit
-
-
-
-
Method Detail
-
newMonitorFilter
MonitorFilter newMonitorFilter()
Creates a newMonitorFilter
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 fromEnumDSSXMLCacheAdminAction
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 fromEnumDSSXMLCacheAdminAction
filter
- a qualifying condition to filter cachesisAsync
- 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.
-
alter
void alter(java.util.Map<java.lang.String,MonitorFilter> filterMap, java.lang.String nodeName, int action) throws MonitorManipulationException, WebObjectsAdminException
Alters content caches associated with the specified projects on specific cluster node.- Parameters:
filterMap
- collection of qualifying condition to filter cachesnodeName
- Node name of the IServer where content cache manipulation to be performedaction
- cache administrative action, a value fromEnumDSSXMLContentCacheAdminAction
- Throws:
MonitorManipulationException
- thrown if there is any failure in managing content 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 fromEnumDSSXMLCacheAdminAction
filter
- a qualifying condition to filter caches
-
submit
void submit(java.lang.String nodeName) throws MonitorManipulationException, WebObjectsAdminException
Submits the request to the specified Intelligence Server to carry out the content cache monitoring operation All failures are packed together into an array ofMonitorManipulationFailure
objects.- Throws:
MonitorManipulationException
- thrown if there is any failure in content cache monitoring operationWebObjectsAdminException
- throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.
-
-