Package org.opennms.netmgt.snmp.proxy.common

Class SnmpProxyRpcModule

java.lang.Object

org.opennms.core.rpc.xml.AbstractXmlRpcModule<SnmpRequestDTO,SnmpMultiResponseDTO>

org.opennms.netmgt.snmp.proxy.common.SnmpProxyRpcModule

All Implemented Interfaces:

RpcClient<SnmpRequestDTO,SnmpMultiResponseDTO>, RpcModule<SnmpRequestDTO,SnmpMultiResponseDTO>

public class SnmpProxyRpcModule
extends AbstractXmlRpcModule<SnmpRequestDTO,SnmpMultiResponseDTO>

Executes SNMP requests locally using the current SnmpStrategy.

Author:

jwhite

Field Summary

Fields

Modifier and Type	Field	Description
static SnmpProxyRpcModule	INSTANCE
static String	RPC_MODULE_ID

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

MINION_HEADERS_MODULE

Constructor Summary

Constructors

Constructor	Description
SnmpProxyRpcModule()

Method Summary

Modifier and Type	Method	Description
SnmpMultiResponseDTO	createResponseWithException(Throwable ex)	Called when the RpcModule throws an exception while executing a request.
CompletableFuture<SnmpMultiResponseDTO>	execute(SnmpRequestDTO request)
String	getId()	Used to route the request/responses to the appropriate module.

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

INSTANCE

public static final SnmpProxyRpcModule INSTANCE

RPC_MODULE_ID

public static final String RPC_MODULE_ID

See Also:

Constant Field Values

Constructor Detail

SnmpProxyRpcModule

public SnmpProxyRpcModule()

Method Detail

execute

public CompletableFuture<SnmpMultiResponseDTO> execute(SnmpRequestDTO request)

createResponseWithException

public SnmpMultiResponseDTO 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.