Package com.qfs.snl.dtos

Class AgentDescriptionDto

java.lang.Object

com.qfs.snl.dtos.AgentDescriptionDto

All Implemented Interfaces:

IAgentDescription, Serializable

Direct Known Subclasses:

RegisteredAgentDescriptionDto

public class AgentDescriptionDto
extends Object
implements IAgentDescription, Serializable

Data transfer object for IAgentDescription.

Author:

ActiveViam

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AgentDescriptionDto()	Empty constructor.
AgentDescriptionDto(String agentName, String agentType, AgentConnectionDetailsDto connectionDetails, List<String> sites)	Constructor.
AgentDescriptionDto(String agentName, String agentType, String agentUrl, String liveUrl, List<String> sites)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAgentName()	Get the name of the ActiveMonitor agent.
String	getAgentType()	Get the type of the ActiveMonitor agent.
AgentConnectionDetailsDto	getConnectionDetails()	Get the connection details about the agent.
List<String>	getSites()	Get the available sites for an agent.
int	hashCode()
AgentDescriptionDto	setAgentConnectionDetails(AgentConnectionDetailsDto agentConnectionDetails)	Sets agent connection details.
AgentDescriptionDto	setAgentName(String agentName)	Set the name of the agent.
AgentDescriptionDto	setAgentType(String agentType)	Set the type of the agent.
AgentDescriptionDto	setConnectionDetails(AgentConnectionDetailsDto connectionDetails)	Set the connection details about the agent.
AgentDescriptionDto	setSites(List<String> sites)	Sets the sites that the agent observes.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AgentDescriptionDto

public AgentDescriptionDto()

Empty constructor.

AgentDescriptionDto

public AgentDescriptionDto(String agentName,
 String agentType,
 AgentConnectionDetailsDto connectionDetails,
 List<String> sites)

Constructor.

Parameters:

agentName - the name of the agent

agentType - the type of the agent

connectionDetails - the connection details about the agent

sites - the list of sites available on this agent

AgentDescriptionDto

public AgentDescriptionDto(String agentName,
 String agentType,
 String agentUrl,
 String liveUrl,
 List<String> sites)

Constructor.

Parameters:

agentName - the name of the agent

agentType - the type of the agent

agentUrl - the url of the agent

liveUrl - the url of live to use to query data on this agent

sites - the list of sites available on this agent

Method Details

getAgentName

public String getAgentName()

Description copied from interface: IAgentDescription

Get the name of the ActiveMonitor agent.

Specified by:

getAgentName in interface IAgentDescription

Returns:

the name of the ActiveMonitor agent

getAgentType

public String getAgentType()

Description copied from interface: IAgentDescription

Get the type of the ActiveMonitor agent.

Specified by:

getAgentType in interface IAgentDescription

Returns:

the type of the ActiveMonitor agent

getConnectionDetails

public AgentConnectionDetailsDto getConnectionDetails()

Description copied from interface: IAgentDescription

Get the connection details about the agent.

Specified by:

getConnectionDetails in interface IAgentDescription

Returns:

the agent's connection details

setAgentName

public AgentDescriptionDto setAgentName(String agentName)

Set the name of the agent.

Parameters:

agentName - the name to set

Returns:

this

setAgentType

public AgentDescriptionDto setAgentType(String agentType)

Set the type of the agent.

Parameters:

agentType - the type to set

Returns:

this

setConnectionDetails

public AgentDescriptionDto setConnectionDetails(AgentConnectionDetailsDto connectionDetails)

Set the connection details about the agent.

Parameters:

connectionDetails - the connection details to set

Returns:

this

setSites

public AgentDescriptionDto setSites(List<String> sites)

Sets the sites that the agent observes.

Parameters:

sites - list of sites

Returns:

this

setAgentConnectionDetails

public AgentDescriptionDto setAgentConnectionDetails(AgentConnectionDetailsDto agentConnectionDetails)

Sets agent connection details.

Parameters:

agentConnectionDetails - details

Returns:

this

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSites

public List<String> getSites()

Description copied from interface: IAgentDescription

Get the available sites for an agent.

Specified by:

getSites in interface IAgentDescription

Returns:

the sites of the agent