Package com.qfs.snl.rs

Interface IAgentRestService

All Known Implementing Classes:

AgentRestServiceController

@RequestMapping("/activeviam/sentinel/rest/v8/agents")
public interface IAgentRestService

The REST IAgentService Controller.

Author:

ActiveViam

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHECK_IN_PATH	The path of the checkIn method.
static final String	CHECK_OUT_PATH	The path of the checkOut method.
static final String	NAMESPACE	The namespace of the service in the REST API.

Method Summary

Modifier and Type	Method	Description
int	checkIn(AgentDescriptionDto agentDescriptionDto)	Register an agent to the ActiveMonitor server.
IRegisteredAgentDescription	checkOut(int id)	Unregister an agent from the ActiveMonitor server.
Collection<? extends IRegisteredAgentDescription>	getAvailableAgents()	Get the available ActiveMonitor agents.

Field Details

NAMESPACE

static final String NAMESPACE

The namespace of the service in the REST API.

See Also:

• Constant Field Values

CHECK_IN_PATH

static final String CHECK_IN_PATH

The path of the checkIn method.

See Also:

• Constant Field Values

CHECK_OUT_PATH

static final String CHECK_OUT_PATH

The path of the checkOut method.

See Also:

• Constant Field Values

Method Details

checkIn

@PostMapping("/checkIn")
int checkIn(@RequestBody
 AgentDescriptionDto agentDescriptionDto)
     throws ServiceException

Register an agent to the ActiveMonitor server.

Parameters:

agentDescriptionDto - the information about the agent that checks in.

Returns:

the identifier of the agent within the ActiveMonitor server (int)

Throws:

ServiceException - when any exception occurs

checkOut

@PostMapping("/checkOut")
IRegisteredAgentDescription checkOut(@RequestBody
 int id)
                              throws ServiceException

Unregister an agent from the ActiveMonitor server.

Parameters:

id - the identifier of the client to unregister

Returns:

the metadata about the unregistered agent

Throws:

ServiceException - when any exception occurs

getAvailableAgents

@GetMapping
Collection<? extends IRegisteredAgentDescription> getAvailableAgents()

Get the available ActiveMonitor agents.

Returns:

a collection of RegisteredAgentDescriptionDto