Package org.cyclos.services.system
Interface SystemMonitorService
-
- All Superinterfaces:
Service
- All Known Subinterfaces:
SystemMonitorServiceLocal
- All Known Implementing Classes:
SystemMonitorServiceImpl,SystemMonitorServiceSecurity
public interface SystemMonitorService extends Service
System monitor/status service. Only available for global admins in global mode
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SystemMonitorExportResultexport()Generates a PDF report containing the whole system information: general information, recurring tasks, background tasks, database upgrades, etc.SystemInformationDatagetSystemInformation(List<String> clusterMembers)Returns general information about Cyclos.List<BackgroundTaskData>listBackgroundTasks(BackgroundTaskQuery query)Lists all background tasks applying the given filterList<PollingTaskData>listPollingTasks(PollingTaskQuery query)Lists all polling tasks but applying the given filtervoidrebuildClosedAccountBalances()Schedules a rebuild of the all closed account balances.voidscheduleExecution(String taskType)Schedules a new execution to run as soon as possible for the given taskPage<DatabaseUpgradeData>searchDatabaseHistoryLogs(DatabaseUpgradeQuery query)Searches for the the database upgrades that were applied.voidvacuumDatabase()Executes a vacuum and an analyze of the database.
-
-
-
Method Detail
-
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
-
listPollingTasks
List<PollingTaskData> listPollingTasks(PollingTaskQuery query) throws FrameworkException
Lists all polling tasks but applying the given filter- Throws:
FrameworkException
-
rebuildClosedAccountBalances
void rebuildClosedAccountBalances() throws FrameworkExceptionSchedules 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 polling task
-
searchDatabaseHistoryLogs
Page<DatabaseUpgradeData> searchDatabaseHistoryLogs(DatabaseUpgradeQuery query) throws FrameworkException
Searches for the the database upgrades that were applied.- Throws:
FrameworkException
-
vacuumDatabase
void vacuumDatabase() throws FrameworkExceptionExecutes a vacuum and an analyze of the database.- Throws:
FrameworkException
-
-