metricapp.service.repository

Class BusApprovedElementRepository

java.lang.Object

metricapp.service.repository.BusApprovedElementRepository

All Implemented Interfaces:

BusApprovedElementInterface

@Service
public class BusApprovedElementRepository
extends java.lang.Object
implements BusApprovedElementInterface

This repository offers method to send and grab our Elements to and from BUS.

Supported items:

• Metric
• Question
• MeasurementGoal

Bus Storage contains only Approved Elements, and only Approved Elements can be sent to Bus.

Field Summary

Fields

Modifier and Type	Field and Description
private BusInterface	busRepository
private static BusApprovedElementRepository	instance
private JacksonMapper	mapper

Constructor Summary

Constructors

Constructor and Description
BusApprovedElementRepository() Spring implementation of Singleton Pattern

Method Summary

Methods

Modifier and Type	Method and Description
RichPointerBus	fromElementToRichPointerBus(Element element) This method maps Element to RichPointerBus to send it to bus, with a create or a update.
Element	fromRichPointerBusToElement(RichPointerBus pointer) this method gets from RichPointerBus, typically received from the bus after an Update or a create action, and maps it to an Element like MeasurementGoal, Metric, Question.
<T extends Element> T	getApprovedElement(PointerBus pointerBus, java.lang.Class<T> clazz) This function gathers Elements like MeasurementGoal, Metric and Question from the bus.
<T extends Element> java.util.ArrayList<T>	getApprovedElements(PointerBus pointerBus, java.lang.Class<T> clazz) This function gathers an Array of Elements like MeasurementGoal, Metric and Question from the bus.
static BusApprovedElementRepository	getInstance() this getter has to be used only when is not possible the IoD of Spring, like commands of State Transition Utils.
<T extends Element> T	getLastApprovedElement(java.lang.String id, java.lang.Class<T> clazz, Entity typeObj) this function returns the last approved version of element with a id in the bus
<T extends Element> Element	sendApprovedElement(Element element, java.lang.Class<T> clazz) This function send an approved Element like to Bus.

Methods inherited from class java.lang.Object

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

Field Detail

busRepository

@Autowired
private BusInterface busRepository

mapper

@Autowired
private JacksonMapper mapper

instance

@Autowired
private static BusApprovedElementRepository instance

Constructor Detail

BusApprovedElementRepository

public BusApprovedElementRepository()

Spring implementation of Singleton Pattern

Method Detail

getInstance

public static BusApprovedElementRepository getInstance()

this getter has to be used only when is not possible the IoD of Spring, like commands of State Transition Utils.

Returns:

sendApprovedElement

public <T extends Element> Element sendApprovedElement(@Nonnull
                                              Element element,
                                              java.lang.Class<T> clazz)
                            throws BadInputException,
                                   BusException,
                                   java.io.IOException

This function send an approved Element like to Bus. There's a check for the state (must be Approved). It returns the updated Element. If the element has null busversion the element is created on bus, otherwise is updated.

Specified by:

sendApprovedElement in interface BusApprovedElementInterface

Parameters:

element - the Element to send to bus

clazz - is the class of the element, like MeasurementGoal or Question

Returns:

the Element returned by the bus

Throws:

BadInputException - state not "Approved"

BusException - error in interation with bus

java.io.IOException - generic error mapping entities

getApprovedElement

public <T extends Element> T getApprovedElement(@Nonnull
                                       PointerBus pointerBus,
                                       java.lang.Class<T> clazz)
                                     throws BadInputException,
                                            BusException,
                                            java.io.IOException

This function gathers Elements like MeasurementGoal, Metric and Question from the bus. If the pointerBus has null version, the last one is returned

Specified by:

getApprovedElement in interface BusApprovedElementInterface

Parameters:

pointerBus - the pointer of the entity requested

clazz - the class of the element to gather, like MeasurementGoal.class, Metric.class

Returns:

return the elements returned by the bus. No null check control implemented

Throws:

BadInputException - if the pointer is not correct

BusException - error in interation with bus

java.io.IOException - generic mapping error.

getLastApprovedElement

public <T extends Element> T getLastApprovedElement(@Nonnull
                                           java.lang.String id,
                                           java.lang.Class<T> clazz,
                                           Entity typeObj)
                                         throws BadInputException,
                                                BusException,
                                                java.io.IOException

this function returns the last approved version of element with a id in the bus

Specified by:

getLastApprovedElement in interface BusApprovedElementInterface

Parameters:

id -

clazz -

Returns:

Throws:

BadInputException

BusException

java.io.IOException

getApprovedElements

public <T extends Element> java.util.ArrayList<T> getApprovedElements(@Nonnull
                                                             PointerBus pointerBus,
                                                             java.lang.Class<T> clazz)
                                                           throws BadInputException,
                                                                  BusException,
                                                                  java.io.IOException

This function gathers an Array of Elements like MeasurementGoal, Metric and Question from the bus. If the pointerBus has null version, the last one is returned

Specified by:

getApprovedElements in interface BusApprovedElementInterface

Parameters:

pointerBus - the pointer of the entity requested

clazz - the class of the element to gather, like MeasurementGoal.class, Metric.class

Returns:

return the elements returned by the bus. No null check control implemented

Throws:

BadInputException - if the pointer is not correct

BusException - error in interation with bus

java.io.IOException - generic mapping error.

fromElementToRichPointerBus

public RichPointerBus fromElementToRichPointerBus(Element element)
                                           throws com.fasterxml.jackson.core.JsonProcessingException

This method maps Element to RichPointerBus to send it to bus, with a create or a update.

TODO: change secure key in something safer (my idea is make a secret password in file /resource/application.properties. To generate this secret token we can do MD5(password XOR id)) In this way we have only to know the password, and not all the secret tokens.

Specified by:

fromElementToRichPointerBus in interface BusApprovedElementInterface

Parameters:

element - typically is of type MeasurementGoal, Metric or Question. Cast to Element is not necessary.

Returns:

RichPointerBus ready to be sent to bus

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if the ObjectToString mapping is not possible

fromRichPointerBusToElement

public Element fromRichPointerBusToElement(RichPointerBus pointer)
                                    throws BusException,
                                           java.io.IOException

this method gets from RichPointerBus, typically received from the bus after an Update or a create action, and maps it to an Element like MeasurementGoal, Metric, Question. This method provides to save fields like secretToken in Element

Specified by:

fromRichPointerBusToElement in interface BusApprovedElementInterface

Parameters:

pointer, - typically received from bus. It Must contain fields getTypeObj and payload not null

Returns:

the element, you have to cast it to your Element. Class type is described like Enum in elementReturned.getEntityType()

Throws:

BusException - if typeobject is not correct, or supported. Exception message contains the value that triggers exception

java.io.IOException - if the StringToObject is not possible