Package org.opennms.core.rpc.echo
Class EchoRpcModule
- java.lang.Object
-
- org.opennms.core.rpc.xml.AbstractXmlRpcModule<EchoRequest,EchoResponse>
-
- org.opennms.core.rpc.echo.EchoRpcModule
-
- All Implemented Interfaces:
RpcClient<EchoRequest,EchoResponse>
,RpcModule<EchoRequest,EchoResponse>
public class EchoRpcModule extends AbstractXmlRpcModule<EchoRequest,EchoResponse>
-
-
Field Summary
Fields Modifier and Type Field Description static EchoRpcModule
INSTANCE
static java.lang.String
RPC_MODULE_ID
-
Fields inherited from interface org.opennms.core.rpc.api.RpcModule
MINION_HEADERS_MODULE
-
-
Constructor Summary
Constructors Constructor Description EchoRpcModule()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beforeRun()
EchoResponse
createResponseWithException(java.lang.Throwable ex)
Called when theRpcModule
throws an exception while executing a request.java.util.concurrent.CompletableFuture<EchoResponse>
execute(EchoRequest request)
java.lang.String
getId()
Used to route the request/responses to the appropriate module.void
processRequest(EchoRequest request, java.util.concurrent.CompletableFuture<EchoResponse> future)
-
Methods inherited from class org.opennms.core.rpc.xml.AbstractXmlRpcModule
marshalRequest, marshalResponse, unmarshalRequest, unmarshalResponse
-
-
-
-
Field Detail
-
INSTANCE
public static final EchoRpcModule INSTANCE
-
RPC_MODULE_ID
public static final java.lang.String RPC_MODULE_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
beforeRun
public void beforeRun()
-
execute
public java.util.concurrent.CompletableFuture<EchoResponse> execute(EchoRequest request)
-
processRequest
public void processRequest(EchoRequest request, java.util.concurrent.CompletableFuture<EchoResponse> future)
-
getId
public java.lang.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 EchoResponse createResponseWithException(java.lang.Throwable ex)
Description copied from interface:RpcModule
Called when theRpcModule
throws an exception while executing a request. This function should return a newRpcResponse
that stores a string-based representation of the exception that occurred and make this available viaRpcResponse.getErrorMessage()
once un-marshaled.- Parameters:
ex
- the exception that occurred- Returns:
- a
RpcResponse
that stores the exception
-
-