org.rhq.enterprise.gui.legacy.action.resource.common.monitor.visibility
Class MetricsDisplayFormPrepareAction

java.lang.Object
  org.apache.struts.action.Action
      org.apache.struts.tiles.actions.TilesAction
          org.rhq.enterprise.gui.legacy.action.resource.common.monitor.visibility.MetricsControlFormPrepareAction
              org.rhq.enterprise.gui.legacy.action.resource.common.monitor.visibility.MetricsDisplayFormPrepareAction

Direct Known Subclasses:

ResourceMetricsFormPrepareAction

public abstract class MetricsDisplayFormPrepareAction
extends MetricsControlFormPrepareAction

An Action that retrieves data from the BizApp to facilitate display of the various pages that provide metrics summaries.

Field Summary

protected int	groupId
protected static org.apache.commons.logging.Log	log

Fields inherited from class org.apache.struts.action.Action

defaultLocale, servlet

Constructor Summary

MetricsDisplayFormPrepareAction()

Method Summary

org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Long begin, Long end) Retrieve data needed to display a Metrics Display Form.
protected abstract List<org.rhq.core.domain.measurement.ui.MetricDisplaySummary>	getMetrics(javax.servlet.http.HttpServletRequest request, int[] resourceIds, long filters, String keyword, Long begin, Long end) Get from the Bizapp the set of metric summaries for the specified entities that will be displayed on the page.
protected Boolean	getShowBaseline() Do we show the baseline column on this page? The default answer is no, but subclasses can specify otherwise.
protected Boolean	getShowMetricSource() Do we show the metric source column on this page? The default answer is no, but subclasses can specify otherwise.
protected Boolean	getShowNumberCollecting() Do we show the number collecting column on this page? The default answer is no, but subclasses can specify otherwise.

Methods inherited from class org.rhq.enterprise.gui.legacy.action.resource.common.monitor.visibility.MetricsControlFormPrepareAction

prepareForm

Methods inherited from class org.apache.struts.tiles.actions.TilesAction

execute

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

groupId

protected int groupId

Constructor Detail

MetricsDisplayFormPrepareAction

public MetricsDisplayFormPrepareAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response,
                                                      Long begin,
                                                      Long end)
                                               throws Exception

Retrieve data needed to display a Metrics Display Form. Respond to certain button clicks that alter the form display.

Throws:

Exception

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Overrides:

execute in class MetricsControlFormPrepareAction

Throws:

Exception

getShowNumberCollecting

protected Boolean getShowNumberCollecting()

Do we show the number collecting column on this page? The default answer is no, but subclasses can specify otherwise.

getShowBaseline

protected Boolean getShowBaseline()

Do we show the baseline column on this page? The default answer is no, but subclasses can specify otherwise.

getShowMetricSource

protected Boolean getShowMetricSource()

Do we show the metric source column on this page? The default answer is no, but subclasses can specify otherwise.

getMetrics

protected abstract List<org.rhq.core.domain.measurement.ui.MetricDisplaySummary> getMetrics(javax.servlet.http.HttpServletRequest request,
                                                                                            int[] resourceIds,
                                                                                            long filters,
                                                                                            String keyword,
                                                                                            Long begin,
                                                                                            Long end)
                                                                                     throws Exception

Get from the Bizapp the set of metric summaries for the specified entities that will be displayed on the page. Returns a Map keyed by metric category.

Parameters:

request - the http request

resourceIds - the array of resource id of the currently viewed resource/group

begin - the time (in milliseconds since the epoch) that begins the timeframe for which the metrics are summarized

end - the time (in milliseconds since the epoch) that ends the timeframe for which the metrics are summarized

Returns:

Map keyed on the category (String), values are List's of MetricDisplaySummary beans

Throws:

Exception