eu.chargetime.ocpp

Class Communicator

java.lang.Object

eu.chargetime.ocpp.Communicator

public abstract class Communicator
extends Object

Abstract class. Handles basic communication: Pack and send messages. Receive and unpack messages.

Requires a Transmitter to send and receive messages. Must be overloaded to implement a specific format.

Field Summary

Fields

Modifier and Type	Field and Description
protected Radio	radio

Constructor Summary

Constructors

Constructor and Description
Communicator(Radio transmitter) Handle required injections.

Method Summary

Modifier and Type	Method and Description
void	accept(CommunicatorEvents events) Use the injected Transmitter to accept a client.
void	connect(String uri, CommunicatorEvents events) Use the injected Transmitter to connect to server.
void	disconnect() Close down the connection.
protected abstract Object	makeCall(String uniqueId, String action, Object payload) Create a call envelope to transmit to the server.
protected abstract Object	makeCallError(String uniqueId, String action, String errorCode, String errorDescription) Create a call error envelope to transmit.
protected abstract Object	makeCallResult(String uniqueId, String action, Object payload) Create a call result envelope to transmit.
abstract Object	packPayload(Object payload) Convert a Request/Confirmation into a formatted string.
protected abstract Message	parse(Object message) Identify an incoming call and parse it into one of the following: CallMessage a request.
void	sendCall(String uniqueId, String action, Request request) Send a new Request.
void	sendCallError(String uniqueId, String action, String errorCode, String errorDescription) Send an error.
void	sendCallResult(String uniqueId, String action, Confirmation confirmation) Send a Confirmation reply to a Request.
abstract <T> T	unpackPayload(Object payload, Class<T> type) Convert a formatted string into a Request/Confirmation.

Methods inherited from class java.lang.Object

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

Field Detail

radio

protected Radio radio

Constructor Detail

Communicator

public Communicator(Radio transmitter)

Handle required injections.

Parameters:

transmitter - Injected Transmitter

Method Detail

unpackPayload

public abstract <T> T unpackPayload(Object payload,
                                    Class<T> type)
                             throws Exception

Convert a formatted string into a Request/Confirmation. This is useful for call results, where the confirmation type isn't given.

Parameters:

payload - the raw formatted payload.

type - the expected return type.

Returns:

the unpacked payload.

Throws:

Exception - error occurred while converting.

packPayload

public abstract Object packPayload(Object payload)

Convert a Request/Confirmation into a formatted string.

Parameters:

payload - the payload model.

Returns:

the payload in the form of a formatted string.

makeCallResult

protected abstract Object makeCallResult(String uniqueId,
                                         String action,
                                         Object payload)

Create a call result envelope to transmit.

Parameters:

uniqueId - the id the receiver expects.

action - action name of the feature.

payload - packed payload.

Returns:

a fully packed message ready to send.

makeCall

protected abstract Object makeCall(String uniqueId,
                                   String action,
                                   Object payload)

Create a call envelope to transmit to the server.

Parameters:

uniqueId - the id the receiver must reply with.

action - action name of the feature.

payload - packed payload.

Returns:

a fully packed message ready to send.

makeCallError

protected abstract Object makeCallError(String uniqueId,
                                        String action,
                                        String errorCode,
                                        String errorDescription)

Create a call error envelope to transmit.

Parameters:

uniqueId - the id the receiver expects.

errorCode - an OCPP error code.

errorDescription - an associated error description.

Returns:

a fully packed message ready to send.

parse

protected abstract Message parse(Object message)

Identify an incoming call and parse it into one of the following: CallMessage a request. CallResultMessage a response.

Parameters:

message - the raw message

Returns:

CallMessage or CallResultMessage

connect

public void connect(String uri,
                    CommunicatorEvents events)

Use the injected Transmitter to connect to server.

Parameters:

uri - the url and port of the server.

events - handler for call back events.

accept

public void accept(CommunicatorEvents events)

Use the injected Transmitter to accept a client.

Parameters:

events - handler for call back events.

sendCall

public void sendCall(String uniqueId,
                     String action,
                     Request request)

Send a new Request. Stores transaction-related Requests if offline. New transaction-related Requests will be placed behind the queue of stored Requests.

Parameters:

uniqueId - the id the receiver should use to reply.

action - action name of the Feature.

request - the outgoing Request

sendCallResult

public void sendCallResult(String uniqueId,
                           String action,
                           Confirmation confirmation)

Send a Confirmation reply to a Request.

Parameters:

uniqueId - the id the receiver expects.

confirmation - the outgoing Confirmation

sendCallError

public void sendCallError(String uniqueId,
                          String action,
                          String errorCode,
                          String errorDescription)

Send an error. If offline, the message is thrown away.

Parameters:

uniqueId - the id the receiver expects a response to.

errorCode - an OCPP error Code

errorDescription - a associated error description.

disconnect

public void disconnect()

Close down the connection. Uses the Transmitter.