net.anotheria.moskito.webui.dashboards.api

Class DashboardAPIImpl

java.lang.Object

net.anotheria.anoplass.api.AbstractAPIImpl

net.anotheria.moskito.webui.shared.api.AbstractMoskitoAPIImpl

net.anotheria.moskito.webui.dashboards.api.DashboardAPIImpl

All Implemented Interfaces:

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

public class DashboardAPIImpl
extends AbstractMoskitoAPIImpl
implements DashboardAPI

Implementation of the DashboardAPI.

Since:

08.04.15 12:46

Author:

lrosenberg

Field Summary

Fields inherited from class net.anotheria.anoplass.api.AbstractAPIImpl

DAY, HOUR, log, MINUTE

Constructor Summary

Constructors

Constructor and Description
DashboardAPIImpl()

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	init()
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 class net.anotheria.moskito.webui.shared.api.AbstractMoskitoAPIImpl

getConfiguration

Methods inherited from class net.anotheria.anoplass.api.AbstractAPIImpl

addValidationError, addValidationError, checkValidationAndThrowException, deInit, getApiConfig, getAttributeFromSession, getCallContext, getCurrentLocale, getCurrentUserId, getDefaultExpirePeriodForAttribute, getExpirePeriodForAttribute, getLoggedInUserId, getPrivateAttributeName, getSession, removeAttributeFromSession, setAttributeInSession, setAttributeInSession, setAttributeInSession, setAttributeInSession

Methods inherited from class java.lang.Object

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

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

deInit

Constructor Detail

DashboardAPIImpl

public DashboardAPIImpl()

Method Detail

init

public void init()
          throws net.anotheria.anoplass.api.APIInitException

Specified by:

init in interface net.anotheria.anoplass.api.API

Overrides:

init in class net.anotheria.anoplass.api.AbstractAPIImpl

Throws:

net.anotheria.anoplass.api.APIInitException

getDefaultDashboardName

public java.lang.String getDefaultDashboardName()

Specified by:

getDefaultDashboardName in interface DashboardAPI

getDashboardConfig

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

Specified by:

getDashboardConfig in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

createDashboard

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

Specified by:

createDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

removeDashboard

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

Specified by:

removeDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

addGaugeToDashboard

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

Specified by:

addGaugeToDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

removeGaugeFromDashboard

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

Specified by:

removeGaugeFromDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

addThresholdToDashboard

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

Specified by:

addThresholdToDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

removeThresholdFromDashboard

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

Specified by:

removeThresholdFromDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

addChartToDashboard

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

Specified by:

addChartToDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

removeChartFromDashboard

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

Specified by:

removeChartFromDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

addProducerToDashboard

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

Specified by:

addProducerToDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

removeProducerFromDashboard

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

Specified by:

removeProducerFromDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

getDashboardDefinitions

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

Specified by:

getDashboardDefinitions in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

getDashboard

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

Specified by:

getDashboard in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

getDashboardNames

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

Specified by:

getDashboardNames in interface DashboardAPI

Throws:

net.anotheria.anoplass.api.APIException

getDashboardNamesWhichDoNotIncludeThisGauge

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

Description copied from interface: DashboardAPI

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

Specified by:

getDashboardNamesWhichDoNotIncludeThisGauge in interface DashboardAPI

Parameters:

gaugeName - the name of the gauge to check.

Returns:

comma separated list of dashboard names.

Throws:

net.anotheria.anoplass.api.APIException

getDashboardNamesWhichDoNotIncludeThisThreshold

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

Description copied from interface: DashboardAPI

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

Specified by:

getDashboardNamesWhichDoNotIncludeThisThreshold in interface DashboardAPI

Parameters:

thresholdName - the name of the threshold to check.

Returns:

comma separated list of dashboard names.

Throws:

net.anotheria.anoplass.api.APIException

getDashboardNamesWhichDoNotIncludeThisChart

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

Description copied from interface: DashboardAPI

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

Specified by:

getDashboardNamesWhichDoNotIncludeThisChart in interface DashboardAPI

Parameters:

chartName - the name of the chart to check.

Returns:

comma separated list of dashboard names.

Throws:

net.anotheria.anoplass.api.APIException