org.wso2.carbon.analytics.messageconsole

Class MessageConsoleService

java.lang.Object

org.wso2.carbon.core.AbstractAdmin

org.wso2.carbon.analytics.messageconsole.MessageConsoleService

public class MessageConsoleService
extends org.wso2.carbon.core.AbstractAdmin

This class is the service class for message console. This represent all the message console backend operation.

Field Summary

Fields inherited from class org.wso2.carbon.core.AbstractAdmin

axisConfig, configurationContext

Constructor Summary

Constructors

Constructor and Description
MessageConsoleService()

Method Summary

Methods

Modifier and Type	Method and Description
PermissionBean	getAvailablePermissions() This method will return PermissionBean that contains permissions regarding message console operations for logged in user.
ScheduleTaskInfo	getDataPurgingDetails(String table) Get already schedule information for given table
protected String	getUsername() This method is use to get logged in username with tenant domain
void	scheduleDataPurging(String table, String cronString, int retentionPeriod) Scheduling data purging task for given table

Methods inherited from class org.wso2.carbon.core.AbstractAdmin

getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageConsoleService

public MessageConsoleService()

Method Detail

getAvailablePermissions

public PermissionBean getAvailablePermissions()
                                       throws MessageConsoleException

This method will return PermissionBean that contains permissions regarding message console operations for logged in user.

Returns:

PermissionBean instance

Throws:

MessageConsoleException

getUsername

protected String getUsername()

This method is use to get logged in username with tenant domain

Overrides:

getUsername in class org.wso2.carbon.core.AbstractAdmin

Returns:

Username with tenant domain

scheduleDataPurging

public void scheduleDataPurging(String table,
                       String cronString,
                       int retentionPeriod)
                         throws MessageConsoleException

Scheduling data purging task for given table

Parameters:

table - Table name that need to purge

cronString - Task cron schedule information

retentionPeriod - Data retention period

Throws:

MessageConsoleException

getDataPurgingDetails

public ScheduleTaskInfo getDataPurgingDetails(String table)
                                       throws MessageConsoleException

Get already schedule information for given table

Parameters:

table - Table name that need to get task information

Returns:

ScheduleTaskInfo instance

Throws:

MessageConsoleException