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:

AddTagAction, AnalyzeJourneyAction, AnalyzeJourneyByMethodAction, BaseAccumulatorsAction, BaseAdditionalAction, BaseDashboardAction, BaseErrorAction, BaseLoadFactorsAction, BaseNowRunningAction, BasePluginAction, BaseShowProducersAction, BaseThreadsAction, BaseThresholdsAction, BaseTracersAction, DeleteJourneyAction, DisableProducerLoggingAction, EnableProducerLoggingAction, ForceIntervalUpdateAction, QuickConnectAction, SelectServerAction, ShowCumulatedProducersAction, ShowExplanationsAction, ShowGaugesAction, ShowJourneyAction, ShowJourneyCallAction, ShowJourneysAction, ShowProducerAction, ShowTagsAction

public abstract class BaseMoskitoUIAction
extends java.lang.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 java.lang.String	ATTR_IS_NAV_MENU_COLLAPSED Attribute name for indication if menu navigation is collapsed or not.
static java.util.List<UnitBean>	AVAILABLE_UNITS_LIST List of the available units.
static java.lang.String	BEAN_AUTORELOAD Currently set autoreload interval.
static java.lang.String	BEAN_INTERVAL Bean name for currently selected interval.
static java.lang.String	BEAN_SORT_TYPE_PREFIX Stored sort type bean prefix name.
static java.lang.String	BEAN_SORT_TYPE_SINGLE_PRODUCER_PREFIX Prefix for producer sort type session storage.
static java.lang.String	BEAN_UNIT Bean name for currently selected unit.
static java.lang.String	CUMULATED_STAT_NAME_VALUE Cumulated caption value.
static java.lang.String	DEFAULT_FORWARD Default forward parameter if no forward has been specified.
static java.lang.String	DEFAULT_INTERVAL Default interval name.
static java.lang.String	DEFAULT_TITLE Default title string for the web page <title$gt; element.
static java.lang.String	DEFAULT_UNIT Default unit.
static UnitBean	DEFAULT_UNIT_BEAN Default unit.
static java.lang.String	PARAM_CATEGORY Parameter for producer category.
static java.lang.String	PARAM_DECORATOR Parameter for producer's decorator.
static java.lang.String	PARAM_FILTER_ZERO If set (to true) the zero request values will be removed from producer presentation.
static java.lang.String	PARAM_FILTERING If set to off the configured filtering of producer names will be switched off.
static java.lang.String	PARAM_FORWARD Constant for the forward parameter.
static java.lang.String	PARAM_ID General id parameter, for example for accumulators or thresholds.
static java.lang.String	PARAM_INTERVAL Parameter name for the interval.
static java.lang.String	PARAM_PRODUCER_ID Parameter producer id.
static java.lang.String	PARAM_RELOAD_INTERVAL Reload interval.
static java.lang.String	PARAM_SORT_BY SortBy usually accompanied by an integer that defines the sort method.
static java.lang.String	PARAM_SORT_ORDER Sort order, ASC or DESC.
static java.lang.String	PARAM_SUBSYSTEM Parameter for producer subsystem.
static java.lang.String	PARAM_UNIT Param for unit.
static java.lang.String	PARAM_VALUE_FILTER_OFF Value that switches filtering feature off.
static char[]	WHITESPACES

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addAlert(AlertBean bean)
protected void	addInfoMessage(java.lang.String message)
protected boolean	exportSupported() Override and return true if your action supports csv/xml/json export.
protected AccumulatorAPI	getAccumulatorAPI()
protected AdditionalFunctionalityAPI	getAdditionalFunctionalityAPI()
protected java.lang.String	getCurrentInterval(javax.servlet.http.HttpServletRequest req) Returns the currently selected interval, either as parameter or from session.
protected java.lang.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 java.lang.String	getForward(javax.servlet.http.HttpServletRequest req) Returns the specified forward.
protected GaugeAPI	getGaugeAPI()
protected java.lang.String	getInfoMessage() Returns a previously set info message or null if no message has been set.
protected JourneyAPI	getJourneyAPI()
protected abstract java.lang.String	getLinkToCurrentPage(javax.servlet.http.HttpServletRequest req) Returns the link to the current page.
protected LoadFactorsAPI	getLoadFactorsAPI()
protected NowRunningAPI	getNowRunningAPI()
protected java.lang.String	getPageName()
protected ProducerAPI	getProducerAPI()
java.lang.String	getProducerId()
java.lang.String	getProducerIdParameter(javax.servlet.http.HttpServletRequest request)
java.lang.String	getSubsystem()
protected java.lang.String	getSubTitle()
protected TagAPI	getTagAPI()
protected ThresholdAPI	getThresholdAPI()
protected TracerAPI	getTracerAPI()
void	postProcess(net.anotheria.maf.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
protected void	prepareBasics(javax.servlet.http.HttpServletRequest req)
void	preProcess(net.anotheria.maf.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
protected java.lang.String	rebuildQueryStringWithoutParameter(java.lang.String source, java.lang.String... params) Rebuilds query string from source.
protected void	setInfoMessage(java.lang.String message) Sets an info message that can be shown on next screen.

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 java.lang.String PARAM_FORWARD

Constant for the forward parameter.

See Also:

Constant Field Values

DEFAULT_FORWARD

public static final java.lang.String DEFAULT_FORWARD

Default forward parameter if no forward has been specified.

See Also:

Constant Field Values

BEAN_INTERVAL

public static final java.lang.String BEAN_INTERVAL

Bean name for currently selected interval.

See Also:

Constant Field Values

PARAM_INTERVAL

public static final java.lang.String PARAM_INTERVAL

Parameter name for the interval.

See Also:

Constant Field Values

DEFAULT_INTERVAL

public static final java.lang.String DEFAULT_INTERVAL

Default interval name.

See Also:

Constant Field Values

BEAN_UNIT

public static final java.lang.String BEAN_UNIT

Bean name for currently selected unit.

See Also:

Constant Field Values

PARAM_UNIT

public static final java.lang.String PARAM_UNIT

Param for unit.

See Also:

Constant Field Values

DEFAULT_UNIT

public static final java.lang.String DEFAULT_UNIT

Default unit.

See Also:

Constant Field Values

PARAM_ID

public static final java.lang.String PARAM_ID

General id parameter, for example for accumulators or thresholds.

See Also:

Constant Field Values

PARAM_PRODUCER_ID

public static final java.lang.String PARAM_PRODUCER_ID

Parameter producer id.

See Also:

Constant Field Values

PARAM_CATEGORY

public static final java.lang.String PARAM_CATEGORY

Parameter for producer category.

See Also:

Constant Field Values

PARAM_SUBSYSTEM

public static final java.lang.String PARAM_SUBSYSTEM

Parameter for producer subsystem.

See Also:

Constant Field Values

PARAM_DECORATOR

public static final java.lang.String PARAM_DECORATOR

Parameter for producer's decorator.

See Also:

Constant Field Values

PARAM_SORT_BY

public static final java.lang.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 java.lang.String PARAM_SORT_ORDER

Sort order, ASC or DESC.

See Also:

Constant Field Values

PARAM_FILTER_ZERO

public static final java.lang.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 java.lang.String PARAM_RELOAD_INTERVAL

Reload interval.

See Also:

Constant Field Values

BEAN_AUTORELOAD

public static final java.lang.String BEAN_AUTORELOAD

Currently set autoreload interval. Session attribute.

See Also:

Constant Field Values

ATTR_IS_NAV_MENU_COLLAPSED

public static final java.lang.String ATTR_IS_NAV_MENU_COLLAPSED

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

See Also:

Constant Field Values

DEFAULT_TITLE

public static final java.lang.String DEFAULT_TITLE

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

See Also:

Constant Field Values

PARAM_FILTERING

public static final java.lang.String PARAM_FILTERING

If set to off the configured filtering of producer names will be switched off.

See Also:

Constant Field Values

PARAM_VALUE_FILTER_OFF

public static final java.lang.String PARAM_VALUE_FILTER_OFF

Value that switches filtering feature off.

See Also:

Constant Field Values

CUMULATED_STAT_NAME_VALUE

public static final java.lang.String CUMULATED_STAT_NAME_VALUE

Cumulated caption value.

See Also:

Constant Field Values

DEFAULT_UNIT_BEAN

public static final UnitBean DEFAULT_UNIT_BEAN

Default unit.

AVAILABLE_UNITS_LIST

public static final java.util.List<UnitBean> AVAILABLE_UNITS_LIST

List of the available units.

BEAN_SORT_TYPE_PREFIX

public static final java.lang.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 java.lang.String BEAN_SORT_TYPE_SINGLE_PRODUCER_PREFIX

Prefix for producer sort type session storage.

See Also:

Constant Field Values

WHITESPACES

public static final char[] WHITESPACES

Constructor Detail

BaseMoskitoUIAction

protected BaseMoskitoUIAction()

Creates a new action.

Method Detail

getSubsystem

public java.lang.String getSubsystem()

getProducerId

public java.lang.String getProducerId()

getForward

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

Returns the specified forward.

Parameters:

req -

Returns:

getCurrentInterval

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

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

Parameters:

req -

Returns:

getCurrentInterval

protected java.lang.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:

prepareBasics

protected void prepareBasics(javax.servlet.http.HttpServletRequest req)

preProcess

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

Specified by:

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

Throws:

java.lang.Exception

postProcess

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

Specified by:

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

Throws:

java.lang.Exception

getLinkToCurrentPage

protected abstract java.lang.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 java.lang.String rebuildQueryStringWithoutParameter(java.lang.String source,
                                                              java.lang.String... params)

Rebuilds query string from source.

Parameters:

source - original source.

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

Returns:

getPageName

protected java.lang.String getPageName()

getProducerAPI

protected ProducerAPI getProducerAPI()

getThresholdAPI

protected ThresholdAPI getThresholdAPI()

getLoadFactorsAPI

protected LoadFactorsAPI getLoadFactorsAPI()

getNowRunningAPI

protected NowRunningAPI getNowRunningAPI()

getJourneyAPI

protected JourneyAPI getJourneyAPI()

getAccumulatorAPI

protected AccumulatorAPI getAccumulatorAPI()

getGaugeAPI

protected GaugeAPI getGaugeAPI()

getAdditionalFunctionalityAPI

protected AdditionalFunctionalityAPI getAdditionalFunctionalityAPI()

getDashboardAPI

protected DashboardAPI getDashboardAPI()

getTracerAPI

protected TracerAPI getTracerAPI()

getTagAPI

protected TagAPI getTagAPI()

getSubTitle

protected java.lang.String getSubTitle()

exportSupported

protected boolean exportSupported()

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

Returns:

setInfoMessage

protected void setInfoMessage(java.lang.String message)

Sets an info message that can be shown on next screen. The info message is readable exactly once.

Parameters:

message - the info message.

getInfoMessage

protected java.lang.String getInfoMessage()

Returns a previously set info message or null if no message has been set.

Returns:

addInfoMessage

protected void addInfoMessage(java.lang.String message)

addAlert

protected void addAlert(AlertBean bean)

getProducerIdParameter

public java.lang.String getProducerIdParameter(javax.servlet.http.HttpServletRequest request)