net.anotheria.moskito.webui.shared.action

Class BaseMoskitoUIAction

java.lang.Object

net.anotheria.moskito.webui.shared.action.BaseMoskitoUIAction

All Implemented Interfaces:

net.anotheria.maf.action.Action

Direct Known Subclasses:

AnalyzeJourneyAction, BaseAccumulatorsAction, BaseAdditionalAction, BaseDashboardAction, BaseShowProducersAction, BaseThreadsAction, BaseThresholdsAction, DeleteJourneyAction, ForceIntervalUpdateAction, QuickConnectAction, SelectServerAction, ShowExplanationsAction, ShowGaugesAction, ShowJourneyAction, ShowJourneyCallAction, ShowJourneysAction, ShowProducerAction

public abstract class BaseMoskitoUIAction
extends Object
implements net.anotheria.maf.action.Action

BaseAction providing some common functionality for all moskitouiactions.

Author:

another

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_IS_NAV_MENU_COLLAPSED Attribute name for indication if menu navigation is collapsed or not.
static List<UnitBean>	AVAILABLE_UNITS_LIST List of the available units.
static String	BEAN_AUTORELOAD Currently set autoreload interval.
static String	BEAN_CHART_ENGINE Bean name for the session bean (been in http session) for chart engine selection.
static String	BEAN_INTERVAL Bean name for currently selected interval.
static String	BEAN_SORT_TYPE_PREFIX Stored sort type bean prefix name.
static String	BEAN_SORT_TYPE_SINGLE_PRODUCER_PREFIX Prefix for producer sort type session storage.
static String	BEAN_UNIT Bean name for currently selected unit.
static String	DEFAULT_FORWARD Default forward parameter if no forward has been specified.
static String	DEFAULT_INTERVAL Default interval name.
static String	DEFAULT_TITLE Default title string for the web page <title$gt; element.
static String	DEFAULT_UNIT Default unit.
static UnitBean	DEFAULT_UNIT_BEAN Default unit.
static String	PARAM_CATEGORY Parameter for producer category.
static String	PARAM_CHART_ENGINE Parameter name for the chart engine selection parameter.
static String	PARAM_FILTER_ZERO If set (to true) the zero request values will be removed from producer presentation.
static String	PARAM_FORWARD Constant for the forward parameter.
static String	PARAM_ID General id parameter, for example for accumulators or thresholds.
static String	PARAM_INTERVAL Parameter name for the interval.
static String	PARAM_PRODUCER_ID Parameter producer id.
static String	PARAM_RELOAD_INTERVAL Reload interval.
static String	PARAM_SORT_BY SortBy usually accompanied by an integer that defines the sort method.
static String	PARAM_SORT_ORDER Sort order, ASC or DESC.
static String	PARAM_SUBSYSTEM Parameter for producer subsystem.
static String	PARAM_UNIT Param for unit.
static char[]	WHITESPACES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseMoskitoUIAction() Creates a new action.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	exportSupported() Override and return true if your action supports csv/xml/json export.
protected AccumulatorAPI	getAccumulatorAPI()
protected AdditionalFunctionalityAPI	getAdditionalFunctionalityAPI()
protected String	getCurrentInterval(javax.servlet.http.HttpServletRequest req) Returns the currently selected interval, either as parameter or from session.
protected String	getCurrentInterval(javax.servlet.http.HttpServletRequest req, boolean saveToSession) Returns the currently selected interval, either as parameter or from session.
protected abstract NaviItem	getCurrentNaviItem() Returns the highlighted navigation item.
protected NaviItem	getCurrentSubNaviItem() Returns the highlighted sub navigation item, if subnavigation is active.
protected UnitBean	getCurrentUnit(javax.servlet.http.HttpServletRequest req) Returns the currently selected unit either from request or session.
protected UnitBean	getCurrentUnit(javax.servlet.http.HttpServletRequest req, boolean saveToSession) Returns the currently selected unit either from request or session.
protected DashboardAPI	getDashboardAPI()
protected static IDecoratorRegistry	getDecoratorRegistry()
protected String	getForward(javax.servlet.http.HttpServletRequest req) Returns the specified forward.
protected GaugeAPI	getGaugeAPI()
protected JourneyAPI	getJourneyAPI()
protected abstract String	getLinkToCurrentPage(javax.servlet.http.HttpServletRequest req) Returns the link to the current page.
protected String	getPageName()
protected ProducerAPI	getProducerAPI()
String	getProducerId()
String	getSubsystem()
protected String	getSubTitle()
protected ThresholdAPI	getThresholdAPI()
void	postProcess(net.anotheria.maf.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	preProcess(net.anotheria.maf.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
protected String	rebuildQueryStringWithoutParameter(String source, String... params) Rebuilds query string from source.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.anotheria.maf.action.Action

execute

Field Detail

PARAM_FORWARD

public static final String PARAM_FORWARD

Constant for the forward parameter.

See Also:

Constant Field Values

DEFAULT_FORWARD

public static final String DEFAULT_FORWARD

Default forward parameter if no forward has been specified.

See Also:

Constant Field Values

BEAN_INTERVAL

public static final String BEAN_INTERVAL

Bean name for currently selected interval.

See Also:

Constant Field Values

PARAM_INTERVAL

public static final String PARAM_INTERVAL

Parameter name for the interval.

See Also:

Constant Field Values

DEFAULT_INTERVAL

public static final String DEFAULT_INTERVAL

Default interval name.

See Also:

Constant Field Values

BEAN_UNIT

public static final String BEAN_UNIT

Bean name for currently selected unit.

See Also:

Constant Field Values

PARAM_UNIT

public static final String PARAM_UNIT

Param for unit.

See Also:

Constant Field Values

DEFAULT_UNIT

public static final String DEFAULT_UNIT

Default unit.

See Also:

Constant Field Values

PARAM_ID

public static final String PARAM_ID

General id parameter, for example for accumulators or thresholds.

See Also:

Constant Field Values

PARAM_PRODUCER_ID

public static final String PARAM_PRODUCER_ID

Parameter producer id.

See Also:

Constant Field Values

PARAM_CATEGORY

public static final String PARAM_CATEGORY

Parameter for producer category.

See Also:

Constant Field Values

PARAM_SUBSYSTEM

public static final String PARAM_SUBSYSTEM

Parameter for producer subsystem.

See Also:

Constant Field Values

PARAM_SORT_BY

public static final String PARAM_SORT_BY

SortBy usually accompanied by an integer that defines the sort method.

See Also:

Constant Field Values

PARAM_SORT_ORDER

public static final String PARAM_SORT_ORDER

Sort order, ASC or DESC.

See Also:

Constant Field Values

PARAM_FILTER_ZERO

public static final String PARAM_FILTER_ZERO

If set (to true) the zero request values will be removed from producer presentation.

See Also:

Constant Field Values

PARAM_RELOAD_INTERVAL

public static final String PARAM_RELOAD_INTERVAL

Reload interval.

See Also:

Constant Field Values

BEAN_AUTORELOAD

public static final String BEAN_AUTORELOAD

Currently set autoreload interval. Session attribute.

See Also:

Constant Field Values

PARAM_CHART_ENGINE

public static final String PARAM_CHART_ENGINE

Parameter name for the chart engine selection parameter.

See Also:

Constant Field Values

ATTR_IS_NAV_MENU_COLLAPSED

public static final String ATTR_IS_NAV_MENU_COLLAPSED

Attribute name for indication if menu navigation is collapsed or not.

See Also:

Constant Field Values

BEAN_CHART_ENGINE

public static final String BEAN_CHART_ENGINE

Bean name for the session bean (been in http session) for chart engine selection.

See Also:

Constant Field Values

DEFAULT_TITLE

public static final String DEFAULT_TITLE

Default title string for the web page <title$gt; element.

See Also:

Constant Field Values

DEFAULT_UNIT_BEAN

public static final UnitBean DEFAULT_UNIT_BEAN

Default unit.

AVAILABLE_UNITS_LIST

public static final List<UnitBean> AVAILABLE_UNITS_LIST

List of the available units.

BEAN_SORT_TYPE_PREFIX

public static final String BEAN_SORT_TYPE_PREFIX

Stored sort type bean prefix name.

See Also:

Constant Field Values

BEAN_SORT_TYPE_SINGLE_PRODUCER_PREFIX

public static final String BEAN_SORT_TYPE_SINGLE_PRODUCER_PREFIX

Prefix for producer sort type session storage.

See Also:

Constant Field Values

WHITESPACES

public static char[] WHITESPACES

Constructor Detail

BaseMoskitoUIAction

protected BaseMoskitoUIAction()

Creates a new action.

Method Detail

getSubsystem

public String getSubsystem()

getProducerId

public String getProducerId()

getForward

protected String getForward(javax.servlet.http.HttpServletRequest req)

Returns the specified forward.

Parameters:

req -

Returns:

getCurrentInterval

protected String getCurrentInterval(javax.servlet.http.HttpServletRequest req)

Returns the currently selected interval, either as parameter or from session.

Parameters:

req -

Returns:

getCurrentInterval

protected String getCurrentInterval(javax.servlet.http.HttpServletRequest req,
                        boolean saveToSession)

Returns the currently selected interval, either as parameter or from session.

Parameters:

req -

saveToSession - - if true the value from request will be stored to session.

Returns:

getCurrentUnit

protected UnitBean getCurrentUnit(javax.servlet.http.HttpServletRequest req)

Returns the currently selected unit either from request or session.

Parameters:

req -

Returns:

getCurrentUnit

protected UnitBean getCurrentUnit(javax.servlet.http.HttpServletRequest req,
                      boolean saveToSession)

Returns the currently selected unit either from request or session.

Parameters:

req -

saveToSession - - if true the request parameter will be saved into session.

Returns:

preProcess

public void preProcess(net.anotheria.maf.action.ActionMapping mapping,
              javax.servlet.http.HttpServletRequest req,
              javax.servlet.http.HttpServletResponse res)
                throws Exception

Specified by:

preProcess in interface net.anotheria.maf.action.Action

Throws:

Exception

postProcess

public void postProcess(net.anotheria.maf.action.ActionMapping mapping,
               javax.servlet.http.HttpServletRequest req,
               javax.servlet.http.HttpServletResponse res)
                 throws Exception

Specified by:

postProcess in interface net.anotheria.maf.action.Action

Throws:

Exception

getLinkToCurrentPage

protected abstract String getLinkToCurrentPage(javax.servlet.http.HttpServletRequest req)

Returns the link to the current page.

Parameters:

req -

Returns:

getDecoratorRegistry

protected static IDecoratorRegistry getDecoratorRegistry()

getCurrentNaviItem

protected abstract NaviItem getCurrentNaviItem()

Returns the highlighted navigation item.

Returns:

getCurrentSubNaviItem

protected NaviItem getCurrentSubNaviItem()

Returns the highlighted sub navigation item, if subnavigation is active. This method returns a string instead of naviitem, because we actually don't need

Returns:

rebuildQueryStringWithoutParameter

protected String rebuildQueryStringWithoutParameter(String source,
                                        String... params)

Rebuilds query string from source.

Parameters:

source - original source.

params - parameters that should be included in the query string.

Returns:

getPageName

protected String getPageName()

getProducerAPI

protected ProducerAPI getProducerAPI()

getThresholdAPI

protected ThresholdAPI getThresholdAPI()

getJourneyAPI

protected JourneyAPI getJourneyAPI()

getAccumulatorAPI

protected AccumulatorAPI getAccumulatorAPI()

getGaugeAPI

protected GaugeAPI getGaugeAPI()

getAdditionalFunctionalityAPI

protected AdditionalFunctionalityAPI getAdditionalFunctionalityAPI()

getDashboardAPI

protected DashboardAPI getDashboardAPI()

getSubTitle

protected String getSubTitle()

exportSupported

protected boolean exportSupported()

Override and return true if your action supports csv/xml/json export.

Returns: