Package org.opennms.netmgt.provision.persist.rpc

Class RequisitionRpcModule

java.lang.Object

org.opennms.core.rpc.xml.AbstractXmlRpcModule<RequisitionRequestDTO,RequisitionResponseDTO>

org.opennms.netmgt.provision.persist.rpc.RequisitionRpcModule

All Implemented Interfaces:

RpcClient<RequisitionRequestDTO,RequisitionResponseDTO>, RpcModule<RequisitionRequestDTO,RequisitionResponseDTO>

public class RequisitionRpcModule
extends AbstractXmlRpcModule<RequisitionRequestDTO,RequisitionResponseDTO>

Field Summary

Fields

Modifier and Type	Field	Description
static String	RPC_MODULE_ID

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

MINION_HEADERS_MODULE

Constructor Summary

Constructors

Constructor	Description
RequisitionRpcModule()

Method Summary

Modifier and Type	Method	Description
RequisitionResponseDTO	createResponseWithException(Throwable ex)	Called when the RpcModule throws an exception while executing a request.
CompletableFuture<RequisitionResponseDTO>	execute(RequisitionRequestDTO request)
String	getId()	Used to route the request/responses to the appropriate module.
void	setExecutor(Executor executor)
void	setRegistry(RequisitionProviderRegistry registry)

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

RequisitionRpcModule

public RequisitionRpcModule()

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.

createResponseWithException

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

execute

public CompletableFuture<RequisitionResponseDTO> execute(RequisitionRequestDTO request)

setRegistry

public void setRegistry(RequisitionProviderRegistry registry)

setExecutor

public void setExecutor(Executor executor)