RpcModule (OpenNMS 29.0.11 API)

All Superinterfaces:

RpcClient<S,T>

All Known Implementing Classes:

AbstractXmlRpcModule, CollectorClientRpcModule, DetectorClientRpcModule, DnsLookupClientRpcModule, EchoRpcModule, HealthTrackingEchoRpcModule, PingProxyRpcModule, PingSweepRpcModule, PollerClientRpcModule, RequisitionRpcModule, SnmpProxyRpcModule
```
public interface RpcModule<S extends RpcRequest,T extends RpcResponse>
extends RpcClient<S,T>
```
Provides the ability to execute the RPCs and defines how the requests/responses will be marshaled/unmarshaled over the wire.

Author:

jwhite

Field Summary

Fields
Modifier and Type Field Description

static String MINION_HEADERS_MODULE

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`T`	`createResponseWithException(Throwable ex)`	Called when the `RpcModule` throws an exception while executing a request.
`String`	`getId()`	Used to route the request/responses to the appropriate module.
`String`	`marshalRequest(S request)`	Marshals the request to a string.
`String`	`marshalResponse(T response)`	Marshals the response to a string.
`S`	`unmarshalRequest(String request)`	Unmarshals the request from a string.
`T`	`unmarshalResponse(String response)`	Unmarshals the response from a string.

Methods inherited from interface org.opennms.core.rpc.api.RpcClient
execute

- Field Detail
  - MINION_HEADERS_MODULE
```
static final String MINION_HEADERS_MODULE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
String getId()
```
    Used to route the request/responses to the appropriate module. This ID should be unique for every RpcModule implementation.
  - marshalRequest
```
String marshalRequest(S request)
```
    Marshals the request to a string.
  - unmarshalRequest
```
S unmarshalRequest(String request)
```
    Unmarshals the request from a string.
  - marshalResponse
```
String marshalResponse(T response)
```
    Marshals the response to a string.
  - unmarshalResponse
```
T unmarshalResponse(String response)
```
    Unmarshals the response from a string.
  - createResponseWithException
```
T createResponseWithException(Throwable ex)
```
    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