org.opennms.netmgt.icmp.proxy

Class PingSweepRpcModule

java.lang.Object

org.opennms.core.rpc.xml.AbstractXmlRpcModule<PingSweepRequestDTO,PingSweepResponseDTO>

org.opennms.netmgt.icmp.proxy.PingSweepRpcModule

All Implemented Interfaces:

RpcClient<PingSweepRequestDTO,PingSweepResponseDTO>, RpcModule<PingSweepRequestDTO,PingSweepResponseDTO>

@Component
public class PingSweepRpcModule
extends AbstractXmlRpcModule<PingSweepRequestDTO,PingSweepResponseDTO>

Field Summary

Fields

Modifier and Type	Field and Description
static String	RPC_MODULE_ID

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

MINION_HEADERS_MODULE

Constructor Summary

Constructors

Constructor and Description
PingSweepRpcModule()

Method Summary

Modifier and Type	Method and Description
PingSweepResponseDTO	createResponseWithException(Throwable ex) Called when the RpcModule throws an exception while executing a request.
CompletableFuture<PingSweepResponseDTO>	execute(PingSweepRequestDTO request)
Iterable<IPPollAddress>	getAddresses(List<IPPollRange> ranges)
String	getId() Used to route the request/responses to the appropriate module.
void	setPingerFactory(PingerFactory pingerFactory)

Methods inherited from class org.opennms.core.rpc.xml.AbstractXmlRpcModule

marshalRequest, marshalResponse, unmarshalRequest, unmarshalResponse

Methods inherited from class java.lang.Object

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

Field Detail

RPC_MODULE_ID

public static final String RPC_MODULE_ID

See Also:

Constant Field Values

Constructor Detail

PingSweepRpcModule

public PingSweepRpcModule()

Method Detail

execute

public CompletableFuture<PingSweepResponseDTO> execute(PingSweepRequestDTO request)

createResponseWithException

public PingSweepResponseDTO createResponseWithException(Throwable ex)

Description copied from interface: RpcModule

Called when the RpcModule throws an exception while executing a request. This function should return a new RpcResponse that stores a string-based representation of the exception that occurred and make this available via RpcResponse.getErrorMessage() once un-marshaled.

Parameters:

ex - the exception that occurred

Returns:

a RpcResponse that stores the exception

getId

public String getId()

Description copied from interface: RpcModule

Used to route the request/responses to the appropriate module. This ID should be unique for every RpcModule implementation.

setPingerFactory

public void setPingerFactory(PingerFactory pingerFactory)

getAddresses

public Iterable<IPPollAddress> getAddresses(List<IPPollRange> ranges)