Package net.solarnetwork.ocpp.service

Interface ChargePointBroker

public interface ChargePointBroker
API for sending messages to Charge Points.
Version:
1.0
Author:
matt

  • Method Details

    • availableChargePointsIds

      Set<ChargePointIdentity> availableChargePointsIds()
      Get a complete set of Charge Point identifiers that are available, or otherwise know to this broker.
      Returns:
      the set of available charge point identifiers, never null

    • isChargePointAvailable

      boolean isChargePointAvailable(ChargePointIdentity identity)
      Test if a Charge Point is available, or otherwise known to this broker.
      Parameters:
      identity - the Charge Point ID to query
      Returns:
      true if this broker is aware of the given clientId and should be able to send messages to it via sendMessageToChargePoint(ActionMessage, ActionMessageResultHandler)

    • isMessageSupported

      boolean isMessageSupported(ActionMessage<?> message)
      Test if an ActionMessage is supported by this broker.

      A message is supported if the message Action is supported by this broker and the message clientId is available.

      Parameters:
      message - the message to test
      Returns:
      true if the message is supported

    • sendMessageToChargePoint

      <T, R> boolean sendMessageToChargePoint(ActionMessage<T> message, ActionMessageResultHandler<T,R> resultHandler)
      Send an ActionMessage to a Charge Point and provide the result to an ActionMessageResultHandler.
      Type Parameters:
      T - the message type
      R - the result type
      Parameters:
      message - the message to process, never null
      resultHandler - the handler to provider the results to
      Returns:
      true if the message client ID is known to the broker and the message has been or will be sent