com.nsysmon.config.presentation

Interface APresentationPageDefinition

All Known Implementing Classes:

AAbstractNsysmonPerformancePageDef, ABottomUpPageDefinition, ADrillDownPageDefinition, AEnvVarPageDefinition, AJdbcPageDefinition, AMemGcPageDefinition, AScalarPageDefinition, AThreadDumpPageDefinition, ATracePageDefinition, CorrelationFlowPage, DataFileGenerator, LoadableServerDataFiles, LongestCallsPageDefinition, MonitorPageDefinition, OverviewDebuggingData, TimedScalarsPageDefinition

public interface APresentationPageDefinition

This interface represents the entire definition of one "view" in NSysMon's HTML interface. Everything else is done dynamically based on instances of this interface.

Author:

arno

Method Summary

Modifier and Type	Method and Description
String	getControllerName()
String	getFullLabel()
String	getHtmlFileName()
String	getId()
String	getShortLabel()
boolean	handleRestCall(String service, List<String> params, AJsonSerHelper json) This method must render the JSON response for a RESTful service call.
void	init(NSysMonApi sysMon) called once before any of the other methods is called.

Method Detail

getId

String getId()

Returns:

a logical ID that is used as a representation for this instance. It must be unique across all instances. It may contain only (ASCII) characters, digits, the underscore and the dash. It is case sensitive.

getShortLabel

String getShortLabel()

Returns:

a short human readable title of this instance, used e.g. for its menu entry.

getFullLabel

String getFullLabel()

Returns:

a (potentially) more verbose title for this instance, used e.g. in a heading on the page.

getHtmlFileName

String getHtmlFileName()

Returns:

the name of the (partial) HTML file used to render this page

getControllerName

String getControllerName()

Returns:

the name of the AngluarJS controller for this page

handleRestCall

boolean handleRestCall(String service,
                       List<String> params,
                       AJsonSerHelper json)
                throws Exception

This method must render the JSON response for a RESTful service call. Callers route calls to the appropriate page definition by its ID, so the method is called only for service calls intended for this instance.

Returns:

true iff the service could be handled

Throws:

Exception

init

void init(NSysMonApi sysMon)

called once before any of the other methods is called.