org.opennms.netmgt.poller.client.rpc

Class PollerRequestDTO

java.lang.Object

org.opennms.netmgt.poller.client.rpc.PollerRequestDTO

All Implemented Interfaces:

RpcRequest, MonitoredService, PollerRequest

public class PollerRequestDTO
extends Object
implements RpcRequest, PollerRequest

Field Summary

Fields inherited from interface org.opennms.core.rpc.api.RpcRequest

TAG_CLASS_NAME, TAG_DESCRIPTION, TAG_IP_ADDRESS, TAG_NODE_ID, TAG_NODE_LABEL

Constructor Summary

Constructors

Constructor and Description
PollerRequestDTO()

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String key, Object value)
void	addAttributes(Map<String,Object> attributes)
void	addTracingInfo(String key, String value)
boolean	equals(Object other)
InetAddress	getAddress() Returns the InetAddress associated with the service
List<PollerAttributeDTO>	getAttributes()
String	getClassName()
String	getIpAddr() Returns the ipAddr string associated with this monitored service.
String	getLocation() Used to route the request to the appropriate location.
Map<String,Object>	getMonitorParameters()
int	getNodeId() Returns the nodeId of the node that this service is associated with.
String	getNodeLabel() Returns the label of the node that this service is associated with.
String	getNodeLocation() Returns the name of the location of the node that this service is associated with.
String	getServiceName()
io.opentracing.Span	getSpan()
String	getSvcName() Returns the svcName associated with this monitored service.
String	getSystemId() Used to route the request to a particular system at the given location.
Long	getTimeToLiveMs() When using JMS, the request will fail if no response was received in this many milliseconds.
Map<String,String>	getTracingInfo() RPC clients expose tracing info as tags there by giving more context to each RPC trace.
int	hashCode()
void	setAddress(InetAddress address)
void	setAttributes(List<PollerAttributeDTO> attributes)
void	setClassName(String className)
void	setLocation(String location)
void	setNodeId(int nodeId)
void	setNodeLabel(String nodeLabel)
void	setNodeLocation(String nodeLocation)
void	setServiceName(String serviceName)
void	setSystemId(String systemId)
void	setTimeToLiveMs(Long timeToLiveMs)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PollerRequestDTO

public PollerRequestDTO()

Method Detail

getLocation

public String getLocation()

Description copied from interface: RpcRequest

Used to route the request to the appropriate location.

Specified by:

getLocation in interface RpcRequest

setLocation

public void setLocation(String location)

setSystemId

public void setSystemId(String systemId)

getSystemId

public String getSystemId()

Description copied from interface: RpcRequest

Used to route the request to a particular system at the given location.

Specified by:

getSystemId in interface RpcRequest

getClassName

public String getClassName()

setClassName

public void setClassName(String className)

getServiceName

public String getServiceName()

getSvcName

public String getSvcName()

Description copied from interface: MonitoredService

Returns the svcName associated with this monitored service.

Specified by:

getSvcName in interface MonitoredService

Returns:

the svcName

setServiceName

public void setServiceName(String serviceName)

getAddress

public InetAddress getAddress()

Description copied from interface: MonitoredService

Returns the InetAddress associated with the service

Specified by:

getAddress in interface MonitoredService

Returns:

the InetAddress

setAddress

public void setAddress(InetAddress address)

getIpAddr

public String getIpAddr()

Description copied from interface: MonitoredService

Returns the ipAddr string associated with this monitored service.

Specified by:

getIpAddr in interface MonitoredService

Returns:

the ipAddr string

getNodeId

public int getNodeId()

Description copied from interface: MonitoredService

Returns the nodeId of the node that this service is associated with.

Specified by:

getNodeId in interface MonitoredService

Returns:

the nodeid

setNodeId

public void setNodeId(int nodeId)

getNodeLabel

public String getNodeLabel()

Description copied from interface: MonitoredService

Returns the label of the node that this service is associated with.

Specified by:

getNodeLabel in interface MonitoredService

Returns:

the nodelabel

setNodeLabel

public void setNodeLabel(String nodeLabel)

getNodeLocation

public String getNodeLocation()

Description copied from interface: MonitoredService

Returns the name of the location of the node that this service is associated with.

Specified by:

getNodeLocation in interface MonitoredService

Returns:

the nodelocation

setNodeLocation

public void setNodeLocation(String nodeLocation)

getAttributes

public List<PollerAttributeDTO> getAttributes()

setAttributes

public void setAttributes(List<PollerAttributeDTO> attributes)

addAttribute

public void addAttribute(String key,
                         Object value)

addAttributes

public void addAttributes(Map<String,Object> attributes)

getMonitorParameters

public Map<String,Object> getMonitorParameters()

Specified by:

getMonitorParameters in interface PollerRequest

Returns:

a map of configuration parameters for the ServiceMonitor.

setTimeToLiveMs

public void setTimeToLiveMs(Long timeToLiveMs)

getTimeToLiveMs

public Long getTimeToLiveMs()

Description copied from interface: RpcRequest

When using JMS, the request will fail if no response was received in this many milliseconds.

Specified by:

getTimeToLiveMs in interface RpcRequest

getTracingInfo

public Map<String,String> getTracingInfo()

Description copied from interface: RpcRequest

RPC clients expose tracing info as tags there by giving more context to each RPC trace. Implementations should add tags defined above if they are available.

Specified by:

getTracingInfo in interface RpcRequest

getSpan

public io.opentracing.Span getSpan()

Specified by:

getSpan in interface RpcRequest

addTracingInfo

public void addTracingInfo(String key,
                           String value)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object