org.opennms.netmgt.collection.client.rpc

Class CollectorClientRpcModule

java.lang.Object

org.opennms.core.rpc.xml.AbstractXmlRpcModule<CollectorRequestDTO,CollectorResponseDTO>

org.opennms.netmgt.collection.client.rpc.CollectorClientRpcModule

All Implemented Interfaces:

RpcClient<CollectorRequestDTO,CollectorResponseDTO>, RpcModule<CollectorRequestDTO,CollectorResponseDTO>

public class CollectorClientRpcModule
extends AbstractXmlRpcModule<CollectorRequestDTO,CollectorResponseDTO>

Used to perform collections via ServiceCollectors.

Author:

jwhite

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
CollectorClientRpcModule()

Method Summary

Modifier and Type	Method and Description
CollectorResponseDTO	createResponseWithException(Throwable ex) Called when the RpcModule throws an exception while executing a request.
CompletableFuture<CollectorResponseDTO>	execute(CollectorRequestDTO request)
String	getId() Used to route the request/responses to the appropriate module.
ServiceCollectorRegistry	getServiceCollectorRegistry()
void	setExecutor(Executor executor)
void	setServiceCollectorRegistry(ServiceCollectorRegistry serviceCollectorRegistry)

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

CollectorClientRpcModule

public CollectorClientRpcModule()

Method Detail

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.

execute

public CompletableFuture<CollectorResponseDTO> execute(CollectorRequestDTO request)

setServiceCollectorRegistry

public void setServiceCollectorRegistry(ServiceCollectorRegistry serviceCollectorRegistry)

getServiceCollectorRegistry

public ServiceCollectorRegistry getServiceCollectorRegistry()

setExecutor

public void setExecutor(Executor executor)

createResponseWithException

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