Package net.solarnetwork.ocpp.util

Class OcppInstructionUtils

java.lang.Object

net.solarnetwork.ocpp.util.OcppInstructionUtils

public final class OcppInstructionUtils
extends Object

Utilities for OCPP instruction handling.

Version:

1.0

Author:

matt

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OcppInstructionUtils.JsonOcppInstructionMessageHandler<T>	API for handling the results of decoding a JSON OCPP instruction.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OCPP_ACTION_PARAM	A node instruction parameter name for an OCPP action name.
static final String	OCPP_CHARGE_POINT_ID_PARAM	A node instruction parameter name for an OCPP ChargePoint entity ID.
static final String	OCPP_CHARGER_IDENTIFIER_PARAM	A node instruction parameter name for an OCPP ChargePoint identifier.
static final String	OCPP_MESSAGE_PARAM	A node instruction parameter name for an OCPP message (e.g.
static final String	OCPP_V16_TOPIC	A node instruction topic for OCPP v1.6 actions.

Constructor Summary

Constructors

Constructor	Description
OcppInstructionUtils()

Method Summary

Modifier and Type	Method	Description
static <T> T	decodeJsonOcppInstructionMessage(com.fasterxml.jackson.databind.ObjectMapper objectMapper, ocpp.domain.Action action, Map<String,String> params, ocpp.json.ActionPayloadDecoder chargePointActionPayloadDecoder, OcppInstructionUtils.JsonOcppInstructionMessageHandler<T> handler)	Decode a JSON OCPP instruction message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

OCPP_V16_TOPIC

public static final String OCPP_V16_TOPIC

A node instruction topic for OCPP v1.6 actions.

See Also:

• Constant Field Values

OCPP_ACTION_PARAM

public static final String OCPP_ACTION_PARAM

A node instruction parameter name for an OCPP action name.

See Also:

• Constant Field Values

OCPP_CHARGER_IDENTIFIER_PARAM

public static final String OCPP_CHARGER_IDENTIFIER_PARAM

A node instruction parameter name for an OCPP ChargePoint identifier.

See Also:

• Constant Field Values

OCPP_CHARGE_POINT_ID_PARAM

public static final String OCPP_CHARGE_POINT_ID_PARAM

A node instruction parameter name for an OCPP ChargePoint entity ID.

See Also:

• Constant Field Values

OCPP_MESSAGE_PARAM

public static final String OCPP_MESSAGE_PARAM

A node instruction parameter name for an OCPP message (e.g. JSON).

See Also:

• Constant Field Values

Constructor Details

OcppInstructionUtils

public OcppInstructionUtils()

Method Details

decodeJsonOcppInstructionMessage

public static <T> T decodeJsonOcppInstructionMessage(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 ocpp.domain.Action action,
 Map<String,String> params,
 ocpp.json.ActionPayloadDecoder chargePointActionPayloadDecoder,
 OcppInstructionUtils.JsonOcppInstructionMessageHandler<T> handler)

Decode a JSON OCPP instruction message.

This method will decode the Instruction parameters of a JSON OCPP action message into an OCPP message instance. If params contains a OCPP_MESSAGE_PARAM value, that will be treated as an OCPP JSON message and decoded directly. Otherwise the keys of params will be used as JavaBean style property values for the OCPP message.

Type Parameters:

T - the return type

Parameters:

objectMapper - the mapper to use

action - the message action to decode

params - the instruction parameters

chargePointActionPayloadDecoder - the action decoder to use

handler - a handler for the results

Returns:

the handler result