Package org.opennms.core.rpc.api
Interface RpcRequest
-
- All Known Implementing Classes:
CollectorRequestDTO
,DetectorRequestDTO
,DnsLookupRequestDTO
,EchoRequest
,PingRequestDTO
,PingSweepRequestDTO
,PollerRequestDTO
,RequisitionRequestDTO
,SnmpRequestDTO
public interface RpcRequest
The request of an RPC call.- Author:
- jwhite
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TAG_CLASS_NAME
static java.lang.String
TAG_DESCRIPTION
static java.lang.String
TAG_IP_ADDRESS
static java.lang.String
TAG_NODE_ID
static java.lang.String
TAG_NODE_LABEL
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getLocation()
Used to route the request to the appropriate location.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.
-
-
-
Field Detail
-
TAG_NODE_ID
static final java.lang.String TAG_NODE_ID
- See Also:
- Constant Field Values
-
TAG_NODE_LABEL
static final java.lang.String TAG_NODE_LABEL
- See Also:
- Constant Field Values
-
TAG_CLASS_NAME
static final java.lang.String TAG_CLASS_NAME
- See Also:
- Constant Field Values
-
TAG_IP_ADDRESS
static final java.lang.String TAG_IP_ADDRESS
- See Also:
- Constant Field Values
-
TAG_DESCRIPTION
static final java.lang.String TAG_DESCRIPTION
- See Also:
- Constant Field Values
-
-
Method Detail
-
getLocation
java.lang.String getLocation()
Used to route the request to the appropriate location.
-
getSystemId
java.lang.String getSystemId()
Used to route the request to a particular system at the given location.
-
getTimeToLiveMs
java.lang.Long getTimeToLiveMs()
When using JMS, the request will fail if no response was received in this many milliseconds.
-
getTracingInfo
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. Implementations should add tags defined above if they are available.
-
getSpan
io.opentracing.Span getSpan()
-
-