Package org.opennms.netmgt.provision.detector.client.rpc

Class DetectorRequestDTO

java.lang.Object

org.opennms.netmgt.provision.detector.client.rpc.DetectorRequestDTO

All Implemented Interfaces:

RpcRequest, DetectRequest, PreDetectCallback

public class DetectorRequestDTO
extends java.lang.Object
implements DetectRequest, RpcRequest

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	Description
DetectorRequestDTO()

Method Summary

Modifier and Type	Method	Description
void	addDetectorAttribute(java.lang.String key, java.lang.String value)
void	addDetectorAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
void	addRuntimeAttribute(java.lang.String key, java.lang.String value)
void	addRuntimeAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
void	addTracingInfo(java.lang.String key, java.lang.String value)
boolean	equals(java.lang.Object obj)
java.net.InetAddress	getAddress()
java.util.Map<java.lang.String,java.lang.String>	getAttributeMap()
java.lang.String	getClassName()
java.util.List<DetectorAttributeDTO>	getDetectorAttributes()
java.lang.String	getLocation()	Used to route the request to the appropriate location.
java.util.Map<java.lang.String,java.lang.String>	getRuntimeAttributes()
io.opentracing.Span	getSpan()
java.lang.String	getSystemId()	Used to route the request to a particular system at the given location.
java.lang.Long	getTimeToLiveMs()	When using JMS, the request will fail if no response was received in this many milliseconds.
java.util.Map<java.lang.String,java.lang.String>	getTracingInfo()	RPC clients expose tracing info as tags there by giving more context to each RPC trace.
int	hashCode()
void	preDetect()
void	setAddress(java.net.InetAddress address)
void	setClassName(java.lang.String className)
void	setDetectorAttributes(java.util.List<DetectorAttributeDTO> attributes)
void	setLocation(java.lang.String location)
void	setPreDetectCallback(PreDetectCallback preDetectCallback)
void	setRuntimeAttributes(java.util.List<DetectorAttributeDTO> attributes)
void	setSpan(io.opentracing.Span span)
void	setSystemId(java.lang.String systemId)
void	setTimeToLiveMs(java.lang.Long timeToLive)

Methods inherited from class java.lang.Object

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

Constructor Detail

DetectorRequestDTO

public DetectorRequestDTO()

Method Detail

getLocation

public java.lang.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(java.lang.String location)

setSystemId

public void setSystemId(java.lang.String systemId)

getSystemId

public java.lang.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

getDetectorAttributes

public java.util.List<DetectorAttributeDTO> getDetectorAttributes()

setDetectorAttributes

public void setDetectorAttributes(java.util.List<DetectorAttributeDTO> attributes)

addDetectorAttribute

public void addDetectorAttribute(java.lang.String key,
                                 java.lang.String value)

addDetectorAttributes

public void addDetectorAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

getAttributeMap

public java.util.Map<java.lang.String,java.lang.String> getAttributeMap()

setRuntimeAttributes

public void setRuntimeAttributes(java.util.List<DetectorAttributeDTO> attributes)

addRuntimeAttribute

public void addRuntimeAttribute(java.lang.String key,
                                java.lang.String value)

addRuntimeAttributes

public void addRuntimeAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

getRuntimeAttributes

public java.util.Map<java.lang.String,java.lang.String> getRuntimeAttributes()

Specified by:

getRuntimeAttributes in interface DetectRequest

Returns:

additional attributes stored outside of the detector's configuration that may be required when running the detector.

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String className)

getAddress

public java.net.InetAddress getAddress()

Specified by:

getAddress in interface DetectRequest

Returns:

the address of the host against with the detector should be invoked.

setAddress

public void setAddress(java.net.InetAddress address)

getTimeToLiveMs

public java.lang.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

setTimeToLiveMs

public void setTimeToLiveMs(java.lang.Long timeToLive)

getTracingInfo

public java.util.Map<java.lang.String,java.lang.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

setSpan

public void setSpan(io.opentracing.Span span)

addTracingInfo

public void addTracingInfo(java.lang.String key,
                           java.lang.String value)

setPreDetectCallback

public void setPreDetectCallback(PreDetectCallback preDetectCallback)

preDetect

public void preDetect()

Specified by:

preDetect in interface PreDetectCallback

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object