IMonitoring (net.bluemind.parent 3.1.42685 API)

All Known Implementing Classes:

MonitoringService
```
@Path(value="/monitoring")
public interface IMonitoring
```
The Monitoring API.

Author:

vincent

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Config`	`getConfig()` TMP: fetches CPU and RAM information
`MethodInformation`	`getMethodInfo(java.lang.String plugin, java.lang.String service, java.lang.String method)` Fetches all information from a method belonging to a given service
`PluginInformation`	`getPluginInfo(java.lang.String plugin)` Fetches all information from a single given plugin
`PluginsList`	`getPluginsInfo()` Fetches a list of all information (plugin information, service information, method information, server information) from every monitoring plugin.
`ServerInformation`	`getServerInfo(java.lang.String plugin, java.lang.String service, java.lang.String method, java.lang.String server)` Fetches information from a given method belonging to a specific server
`ServiceInformation`	`getServiceInfo(java.lang.String plugin, java.lang.String service)` Fetches all information from a service belonging to a given plugin

Method Detail

getPluginsInfo
```
@GET
 @Path(value="_all")
PluginsList getPluginsInfo()
                                              throws java.lang.Exception
```
Fetches a list of all information (plugin information, service information, method information, server information) from every monitoring plugin.

Returns:

a plugins list with the complete list of information

Throws:

java.lang.Exception

getConfig

@GET
 @Path(value="_config")
Config getConfig()
                                       throws java.lang.Exception

TMP: fetches CPU and RAM information

Returns:
Throws:: java.lang.Exception

getPluginInfo

@GET
 @Path(value="{plugin}")
PluginInformation getPluginInfo(@PathParam(value="plugin")
                                                              java.lang.String plugin)
                                                       throws java.lang.Exception

Fetches all information from a single given plugin

Parameters:: plugin - the plugin from which the information must be fetched
Returns:: all information from the given plugin
Throws:: java.lang.Exception

getServiceInfo

@GET
 @Path(value="{plugin}/{service}")
ServiceInformation getServiceInfo(@PathParam(value="plugin")
                                                                          java.lang.String plugin,
                                                                          @PathParam(value="service")
                                                                          java.lang.String service)
                                                                   throws java.lang.Exception

Fetches all information from a service belonging to a given plugin

Parameters:: plugin - the plugin containing the service; service - the service from which the information must be fetched
Returns:: all the information from the given service
Throws:: java.lang.Exception

getMethodInfo

@GET
 @Path(value="{plugin}/{service}/{method}")
MethodInformation getMethodInfo(@PathParam(value="plugin")
                                                                                 java.lang.String plugin,
                                                                                 @PathParam(value="service")
                                                                                 java.lang.String service,
                                                                                 @PathParam(value="method")
                                                                                 java.lang.String method)
                                                                          throws java.lang.Exception

Fetches all information from a method belonging to a given service

Parameters:: plugin - the plugin containing the service; service - the service containing the method; method - the method from which the information must be fetched
Returns:: all the information from the given method
Throws:: java.lang.Exception

getServerInfo

@GET
 @Path(value="{plugin}/{service}/{method}/{server}")
ServerInformation getServerInfo(@PathParam(value="plugin")
                                                                                          java.lang.String plugin,
                                                                                          @PathParam(value="service")
                                                                                          java.lang.String service,
                                                                                          @PathParam(value="method")
                                                                                          java.lang.String method,
                                                                                          @PathParam(value="server")
                                                                                          java.lang.String server)
                                                                                   throws java.lang.Exception

Fetches information from a given method belonging to a specific server

Parameters:: plugin - the plugin containing the service; service - the service containing the method; method - the method to be used; server - the server from which the information must be fetched
Returns:: information from a given method belonging to a specific server
Throws:: java.lang.Exception

Interface IMonitoring