com.actional.lg.plugin

Interface IMetricProvider

public interface IMetricProvider

Interface for Metric Providers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IMetricProvider.IGetMetricsOutput Interface used for returning statistical information upon calling IMetricProvider#getMetrics()
static interface	IMetricProvider.IManagedSiteStatistics Statistics of a managed site for which statistics are being made available
static interface	IMetricProvider.ISetStatusContext Context for IMetricProvider.setStatus
static interface	IMetricProvider.IStartServiceContext Context for IMetricProvider.startService.
static interface	IMetricProvider.IStopServiceContext Context for IMetricProvider.stopService (for future use)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SETTING_KEYID

Method Summary

Modifier and Type	Method and Description
void	setStatus(IMetricProvider.ISetStatusContext ctx) Provides information on the current status of the metric provider.
void	startService(IMetricProvider.IStartServiceContext ctx) Starts the metric provider.
void	stopService(IMetricProvider.IStopServiceContext ctx) Stops the metric provider, including any shutdown procedure and cleanup that may be required

Field Detail

SETTING_KEYID

static final java.lang.String SETTING_KEYID

See Also:

Constant Field Values

Method Detail

startService

void startService(IMetricProvider.IStartServiceContext ctx)
           throws java.lang.Exception

Starts the metric provider. This will be called whenever a new metric provider is being registered or when the server restarts.

Throws:

java.lang.Exception

stopService

void stopService(IMetricProvider.IStopServiceContext ctx)
          throws java.lang.Exception

Stops the metric provider, including any shutdown procedure and cleanup that may be required.

Throws:

java.lang.Exception

setStatus

void setStatus(IMetricProvider.ISetStatusContext ctx)

Provides information on the current status of the metric provider. Use this method to describe the current state of the metric provider and to propagate any errors that might occur.