com.orchestranetworks.addon.mtrn

Interface Monitoring

public interface Monitoring

Defines an interface exposed for communication with the {addon.label} configuration.

Method Summary

Modifier and Type	Method and Description
List<Parameter>	getInputParameters(MonitoringKey key) Gets input parameter information.
com.onwbp.adaptation.AdaptationTable	getMonitoringTable() Returns the activity monitoring table.
List<Parameter>	getOutputParameters(MonitoringKey key) Gets output parameter information.
MonitoringStatus	getStatus(MonitoringKey key) Gets monitoring status based on MonitoringKey.
List<Parameter>	getWorkingParameters(MonitoringKey key) Gets working parameter information.
MonitoringStatus	restart(MonitoringKey key, RestartContext restartContext) Signals service restarts to monitoring.
MonitoringKey	start(StartContext startContext) Registers service into {addon.label}.
MonitoringStatus	stop(MonitoringKey key, StopContext stopContext) Signals service stop to monitoring.
MonitoringStatus	suspend(MonitoringKey key, SuspendContext suspendContext) Signals suspension of running service to monitoring.
MonitoringStatus	update(MonitoringKey key, UpdateContext updateContext) Updates monitoring information based on the MonitoringKey.

Method Detail

start

MonitoringKey start(StartContext startContext)
             throws MonitoringException

Registers service into {addon.label}. Returns a MonitoringKey for future updates.

Parameters:

startContext - the start context

Returns:

the monitoring key

Throws:

MonitoringException - the monitoring exception

update

MonitoringStatus update(MonitoringKey key,
                        UpdateContext updateContext)
                 throws MonitoringException

Updates monitoring information based on the MonitoringKey.

Parameters:

key - the key

updateContext - the update context

Returns:

the monitoring status

Throws:

MonitoringException - the monitoring exception

stop

MonitoringStatus stop(MonitoringKey key,
                      StopContext stopContext)
               throws MonitoringException

Signals service stop to monitoring.

Parameters:

key - the key

stopContext - the stop context

Returns:

the monitoring status

Throws:

MonitoringException - the monitoring exception

restart

MonitoringStatus restart(MonitoringKey key,
                         RestartContext restartContext)
                  throws MonitoringException

Signals service restarts to monitoring.

Parameters:

key - the key

restartContext - the restart context

Returns:

the monitoring status

Throws:

MonitoringException - the monitoring exception

suspend

MonitoringStatus suspend(MonitoringKey key,
                         SuspendContext suspendContext)
                  throws MonitoringException

Signals suspension of running service to monitoring.

Parameters:

key - the key

suspendContext - the suspend context

Returns:

the monitoring status

Throws:

MonitoringException - the monitoring exception

getStatus

MonitoringStatus getStatus(MonitoringKey key)
                    throws MonitoringException

Gets monitoring status based on MonitoringKey.

Parameters:

key - the key

Returns:

the status

Throws:

MonitoringException - the monitoring exception

getInputParameters

List<Parameter> getInputParameters(MonitoringKey key)
                            throws MonitoringException

Gets input parameter information.

Parameters:

key - the key

Returns:

the input parameters

Throws:

MonitoringException - the monitoring exception

getWorkingParameters

List<Parameter> getWorkingParameters(MonitoringKey key)
                              throws MonitoringException

Gets working parameter information.

Parameters:

key - the key

Returns:

the working parameters

Throws:

MonitoringException - the monitoring exception

getOutputParameters

List<Parameter> getOutputParameters(MonitoringKey key)
                             throws MonitoringException

Gets output parameter information.

Parameters:

key - the key

Returns:

the output parameters

Throws:

MonitoringException - the monitoring exception

getMonitoringTable

com.onwbp.adaptation.AdaptationTable getMonitoringTable()

Returns the activity monitoring table.

Returns:

the monitoring table

Since:

v1.1.0