Package org.cyclos.services.system

Interface SystemMonitorService

All Superinterfaces:

Service

All Known Subinterfaces:

SystemMonitorServiceLocal

public interface SystemMonitorService
extends Service

System monitor/status service. Only available for global admins in global mode

Method Summary

Modifier and Type	Method	Description
void	archiveData()	Starts the archiving process
void	clearCache(String name)	Clear a specific cache when given.
SystemMonitorExportResult	export()	Generates a PDF report containing the whole system information: general information, recurring tasks, background tasks, database upgrades, etc.
SystemInformationData	getSystemInformation(List<String> clusterMembers)	Returns general information about Cyclos.
List<BackgroundTaskData>	listBackgroundTasks(BackgroundTaskQuery query)	Lists all background tasks applying the given filter
List<CacheVO>	listCaches(CacheQuery query)	Lists all recurring tasks but applying the given filter
List<RecurringTaskData>	listRecurringTasks(RecurringTaskQuery query)	Lists all recurring tasks but applying the given filter
void	rebuildClosedAccountBalances()	Schedules a rebuild of the all closed account balances.
void	scheduleExecution(String taskType)	Schedules a new execution to run as soon as possible for the given task
Page<DatabaseUpgradeData>	searchDatabaseHistoryLogs(DatabaseUpgradeQuery query)	Searches for the the database upgrades that were applied.
void	vacuumDatabase()	Executes a vacuum and an analyze of the database.

Method Detail

archiveData

void archiveData()
          throws FrameworkException

Starts the archiving process

Throws:

FrameworkException

clearCache

void clearCache(String name)
         throws FrameworkException

Clear a specific cache when given. Otherwise when the cache name is null clear all the caches. We require a read-write transaction when scheduling cache operations.

Parameters:

name - the cahe's name

Throws:

FrameworkException

export

SystemMonitorExportResult export()
                          throws FrameworkException

Generates a PDF report containing the whole system information: general information, recurring tasks, background tasks, database upgrades, etc.

Throws:

FrameworkException

getSystemInformation

SystemInformationData getSystemInformation(List<String> clusterMembers)
                                    throws FrameworkException

Returns general information about Cyclos.

Parameters:

clusterMembers - the members whose information was already received by the client. Null for the first time the client request for information.

Throws:

FrameworkException

listBackgroundTasks

List<BackgroundTaskData> listBackgroundTasks(BackgroundTaskQuery query)
                                      throws FrameworkException

Lists all background tasks applying the given filter

Throws:

FrameworkException

listCaches

List<CacheVO> listCaches(CacheQuery query)
                  throws FrameworkException

Lists all recurring tasks but applying the given filter

Throws:

FrameworkException

listRecurringTasks

List<RecurringTaskData> listRecurringTasks(RecurringTaskQuery query)
                                    throws FrameworkException

Lists all recurring tasks but applying the given filter

Throws:

FrameworkException

rebuildClosedAccountBalances

void rebuildClosedAccountBalances()
                           throws FrameworkException

Schedules a rebuild of the all closed account balances.

Throws:

FrameworkException

scheduleExecution

void scheduleExecution(String taskType)

Schedules a new execution to run as soon as possible for the given task

Parameters:

taskType - the qualified class name of the recurring task

searchDatabaseHistoryLogs

Page<DatabaseUpgradeData> searchDatabaseHistoryLogs(DatabaseUpgradeQuery query)
                                             throws FrameworkException

Searches for the the database upgrades that were applied.

Throws:

FrameworkException

vacuumDatabase

void vacuumDatabase()
             throws FrameworkException

Executes a vacuum and an analyze of the database.

Throws:

FrameworkException