net.anotheria.moskito.webui.dashboards.api

Interface DashboardAPI

All Superinterfaces:

net.anotheria.anoplass.api.API, net.anotheria.anoprise.metafactory.Service

All Known Implementing Classes:

DashboardAPIImpl, RemoteDashboardAPIStub

@DistributeMe(agentsSupport=false,
              moskitoSupport=false)
 @SupportService
 @FailBy(strategyClass=org.distributeme.core.failing.RetryCallOnce.class)
public interface DashboardAPI
extends net.anotheria.anoplass.api.API, net.anotheria.anoprise.metafactory.Service

TODO comment this class

Since:

08.04.15 12:45

Author:

lrosenberg

Method Summary

Modifier and Type	Method and Description
void	addChartToDashboard(java.lang.String dashboardName, java.lang.String caption, java.lang.String[] accNames)
void	addGaugeToDashboard(java.lang.String dashboardName, java.lang.String gaugeName)
void	addProducerToDashboard(java.lang.String dashboardName, java.lang.String producerName)
void	addThresholdToDashboard(java.lang.String dashboardName, java.lang.String thresholdName)
void	createDashboard(java.lang.String dashboardName)
DashboardAO	getDashboard(java.lang.String name)
DashboardConfig	getDashboardConfig(java.lang.String name)
java.util.List<DashboardDefinitionAO>	getDashboardDefinitions()
java.util.List<java.lang.String>	getDashboardNames()
java.lang.String	getDashboardNamesWhichDoNotIncludeThisChart(java.lang.String chartName) Returns a comma separated list of dashboard names that do not include supplied chart yet.
java.lang.String	getDashboardNamesWhichDoNotIncludeThisGauge(java.lang.String gaugeName) Returns a comma separated list of dashboard names that do not include supplied gauge yet.
java.lang.String	getDashboardNamesWhichDoNotIncludeThisThreshold(java.lang.String thresholdName) Returns a comma separated list of dashboard names that do not include supplied threshold yet.
java.lang.String	getDefaultDashboardName()
void	removeChartFromDashboard(java.lang.String dashboardName, java.lang.String[] accNames)
void	removeDashboard(java.lang.String dashboardName)
void	removeGaugeFromDashboard(java.lang.String dashboardName, java.lang.String gaugeName)
void	removeProducerFromDashboard(java.lang.String dashboardName, java.lang.String producerName)
void	removeThresholdFromDashboard(java.lang.String dashboardName, java.lang.String thresholdName)

Methods inherited from interface net.anotheria.anoplass.api.API

deInit, init

Method Detail

getDefaultDashboardName

java.lang.String getDefaultDashboardName()
                                  throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

getDashboardConfig

DashboardConfig getDashboardConfig(java.lang.String name)
                            throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

getDashboardDefinitions

java.util.List<DashboardDefinitionAO> getDashboardDefinitions()
                                                       throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

getDashboard

DashboardAO getDashboard(java.lang.String name)
                  throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

getDashboardNames

java.util.List<java.lang.String> getDashboardNames()
                                            throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

createDashboard

void createDashboard(java.lang.String dashboardName)
              throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

removeDashboard

void removeDashboard(java.lang.String dashboardName)
              throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

addGaugeToDashboard

void addGaugeToDashboard(java.lang.String dashboardName,
                         java.lang.String gaugeName)
                  throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

removeGaugeFromDashboard

void removeGaugeFromDashboard(java.lang.String dashboardName,
                              java.lang.String gaugeName)
                       throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

addThresholdToDashboard

void addThresholdToDashboard(java.lang.String dashboardName,
                             java.lang.String thresholdName)
                      throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

removeThresholdFromDashboard

void removeThresholdFromDashboard(java.lang.String dashboardName,
                                  java.lang.String thresholdName)
                           throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

addChartToDashboard

void addChartToDashboard(java.lang.String dashboardName,
                         java.lang.String caption,
                         java.lang.String[] accNames)
                  throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

removeChartFromDashboard

void removeChartFromDashboard(java.lang.String dashboardName,
                              java.lang.String[] accNames)
                       throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

addProducerToDashboard

void addProducerToDashboard(java.lang.String dashboardName,
                            java.lang.String producerName)
                     throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

removeProducerFromDashboard

void removeProducerFromDashboard(java.lang.String dashboardName,
                                 java.lang.String producerName)
                          throws net.anotheria.anoplass.api.APIException

Throws:

net.anotheria.anoplass.api.APIException

getDashboardNamesWhichDoNotIncludeThisGauge

java.lang.String getDashboardNamesWhichDoNotIncludeThisGauge(java.lang.String gaugeName)
                                                      throws net.anotheria.anoplass.api.APIException

Returns a comma separated list of dashboard names that do not include supplied gauge yet. This is used for the "Add To Dashboard" dialogue.

Parameters:

gaugeName - the name of the gauge to check.

Returns:

comma separated list of dashboard names.

Throws:

net.anotheria.anoplass.api.APIException

getDashboardNamesWhichDoNotIncludeThisThreshold

java.lang.String getDashboardNamesWhichDoNotIncludeThisThreshold(java.lang.String thresholdName)
                                                          throws net.anotheria.anoplass.api.APIException

Returns a comma separated list of dashboard names that do not include supplied threshold yet. This is used for the "Add To Dashboard" dialogue.

Parameters:

thresholdName - the name of the threshold to check.

Returns:

comma separated list of dashboard names.

Throws:

net.anotheria.anoplass.api.APIException

getDashboardNamesWhichDoNotIncludeThisChart

java.lang.String getDashboardNamesWhichDoNotIncludeThisChart(java.lang.String chartName)
                                                      throws net.anotheria.anoplass.api.APIException

Returns a comma separated list of dashboard names that do not include supplied chart yet. This is used for the "Add To Dashboard" dialogue.

Parameters:

chartName - the name of the chart to check.

Returns:

comma separated list of dashboard names.

Throws:

net.anotheria.anoplass.api.APIException