org.opennms.netmgt.icmp.proxy

Class PingProxyRpcModule

java.lang.Object

org.opennms.core.rpc.xml.AbstractXmlRpcModule<PingRequestDTO,PingResponseDTO>

org.opennms.netmgt.icmp.proxy.PingProxyRpcModule

All Implemented Interfaces:

RpcClient<PingRequestDTO,PingResponseDTO>, RpcModule<PingRequestDTO,PingResponseDTO>

@Component
public class PingProxyRpcModule
extends AbstractXmlRpcModule<PingRequestDTO,PingResponseDTO>

Field Summary

Fields

Modifier and Type	Field and Description
static String	RPC_MODULE_ID

Constructor Summary

Constructors

Constructor and Description
PingProxyRpcModule()

Method Summary

Modifier and Type	Method and Description
PingResponseDTO	createResponseWithException(Throwable ex) Called when the RpcModule throws an exception while executing a request.
CompletableFuture<PingResponseDTO>	execute(PingRequestDTO request)
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

PingProxyRpcModule

public PingProxyRpcModule()

Method Detail

execute

public CompletableFuture<PingResponseDTO> execute(PingRequestDTO request)

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)

createResponseWithException

public PingResponseDTO 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