Package org.cyclos.impl.access

Class DeviceConfirmationServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.access.DeviceConfirmationServiceImpl

All Implemented Interfaces:

DeviceConfirmationServiceLocal, DeviceConfirmationService, Service

@Service
public class DeviceConfirmationServiceImpl
extends BaseServiceImpl
implements DeviceConfirmationServiceLocal

Implementation for DeviceConfirmationService

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.services.access.DeviceConfirmationService

DEVICE_CONFIRMATION_VALUE_PREFIX

Constructor Summary

Constructors

Constructor	Description
DeviceConfirmationServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	approve(String id, long deviceId, String hmac)	Approves a confirmation through a trusted device.
SerializableInputStream	barcode(DeviceConfirmationBarcodeParams params)	Generates a two-dimensional barcode (QR code), only if the confirmation was not already approved nor rejected, containing a URL of the form: cyclos://confirm?id=confirmation_id&op=i18n_confirmation_type&fields=Label1:Value1|Label2:Value2... If any of the labels / values contains a ':' or '|' char then they are escaped with a '\' (e.i 'Business One | Big' -> 'Business One \| Big') E.g cyclos://confirm?id=-6959640208566238428&op=Payment confirmation&fields=from:b1|to:b2|amount:50 units)
TrustedDevice	check(String confirmationId, CreateDeviceConfirmationParams params)	Checks if the confirmation was APPROVED and also its QR-content matches the generated from the CreateDeviceConfirmationParams parameter.
DeviceConfirmationVO	create(CreateDeviceConfirmationParams params)	Creates a new pending for approval device confirmation for the logged user.
DeviceConfirmationVO	create(CreateDeviceConfirmationParams params, BasicUser creatorUser, BasicUser ownerUser, boolean unmaskIds)	Creates a new pending for approval device confirmation for the owner user.
DeviceConfirmation	find(String id)	Returns the device confirmation with a given id, throwing EntityNotFoundException if the id isn't found.
DeviceConfirmationApprovalData	getApprovalData(Long deviceId)	Return data for approve / reject device confirmations for the given device id
Map<MessageKey,Object>	getQRFields(DeviceConfirmationType type, Map<DeviceConfirmationField,Object> canonicalValues)	Returns a map with the fields used to generate the QR content for a given device confirmation type
void	initialize()
boolean	isVisible(DeviceConfirmation confirmation)	Returns whether the given device confirmation is visible to the authenticated user
DeviceConfirmationVO	load(String id)	Load a device confirmation by id for the logged user.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	reject(String id, long deviceId, String hmac)	Same as DeviceConfirmationService.approve(String, long, String) but for confirmation rejection.
void	remove(String id)	Removes a confirmation for the logged user.
TrustedDevice	validate(String id, long deviceId, String hmac)	Validates a PENDING confirmation with a device to ensure the device is a valid trusted device.

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.impl.access.DeviceConfirmationServiceLocal

isDeviceConfirmation

Constructor Detail

DeviceConfirmationServiceImpl

public DeviceConfirmationServiceImpl()

Method Detail

approve

public void approve(String id,
                    long deviceId,
                    String hmac)

Description copied from interface: DeviceConfirmationService

Approves a confirmation through a trusted device. This operation can be invoked as guests or with a logged user, if guest the final user running the approve will be the device's owner.

Specified by:

approve in interface DeviceConfirmationService

Parameters:

id - the identification of the confirmation being approved.

deviceId - the identification of the trusted device used to approve.

hmac - the Hash-based Message Authentication Code used to verify the authentication of the confirmation and device.
The cryptographic hash function used to compute the HMAC is SHA-256.

barcode

public SerializableInputStream barcode(DeviceConfirmationBarcodeParams params)

Description copied from interface: DeviceConfirmationService

Generates a two-dimensional barcode (QR code), only if the confirmation was not already approved nor rejected, containing a URL of the form:
cyclos://confirm?id=confirmation_id&op=i18n_confirmation_type&fields=Label1:Value1|Label2:Value2...

If any of the labels / values contains a ':' or '|' char then they are escaped with a '\' (e.i 'Business One | Big' -> 'Business One \| Big') E.g
cyclos://confirm?id=-6959640208566238428&op=Payment confirmation&fields=from:b1|to:b2|amount:50 units)

Specified by:

barcode in interface DeviceConfirmationService

check

public TrustedDevice check(String confirmationId,
                           CreateDeviceConfirmationParams params)

Description copied from interface: DeviceConfirmationServiceLocal

Checks if the confirmation was APPROVED and also its QR-content matches the generated from the CreateDeviceConfirmationParams parameter. Also, if the confirmation was found and is approved then it's removed.

Specified by:

check in interface DeviceConfirmationServiceLocal

Returns:

the device used to approve the given confirmation

create

public DeviceConfirmationVO create(CreateDeviceConfirmationParams params)

Description copied from interface: DeviceConfirmationService

Creates a new pending for approval device confirmation for the logged user.

Specified by:

create in interface DeviceConfirmationService

create

public DeviceConfirmationVO create(CreateDeviceConfirmationParams params,
                                   BasicUser creatorUser,
                                   BasicUser ownerUser,
                                   boolean unmaskIds)

Description copied from interface: DeviceConfirmationServiceLocal

Creates a new pending for approval device confirmation for the owner user. If the ids present in the 'params' object are masked then set the 'unmaskIds' flag to true. If a 'creatorUser' is given then the push-notification will be send to that user instead of to the owner user.

Specified by:

create in interface DeviceConfirmationServiceLocal

find

public DeviceConfirmation find(String id)

Description copied from interface: DeviceConfirmationServiceLocal

Returns the device confirmation with a given id, throwing EntityNotFoundException if the id isn't found.

Specified by:

find in interface DeviceConfirmationServiceLocal

getApprovalData

public DeviceConfirmationApprovalData getApprovalData(Long deviceId)

Description copied from interface: DeviceConfirmationService

Return data for approve / reject device confirmations for the given device id

Specified by:

getApprovalData in interface DeviceConfirmationService

Returns:

getQRFields

public Map<MessageKey,Object> getQRFields(DeviceConfirmationType type,
                                                Map<DeviceConfirmationField,Object> canonicalValues)

Returns a map with the fields used to generate the QR content for a given device confirmation type

Specified by:

getQRFields in interface DeviceConfirmationServiceLocal

Parameters:

canonicalValues - the values obtained after parsing the CreateDeviceConfirmationParams.FIELDS map

initialize

@PostConstruct
public void initialize()

isVisible

public boolean isVisible(DeviceConfirmation confirmation)

Description copied from interface: DeviceConfirmationServiceLocal

Returns whether the given device confirmation is visible to the authenticated user

Specified by:

isVisible in interface DeviceConfirmationServiceLocal

load

public DeviceConfirmationVO load(String id)

Description copied from interface: DeviceConfirmationService

Load a device confirmation by id for the logged user.

Specified by:

load in interface DeviceConfirmationService

reject

public void reject(String id,
                   long deviceId,
                   String hmac)

Description copied from interface: DeviceConfirmationService

Same as DeviceConfirmationService.approve(String, long, String) but for confirmation rejection.

Specified by:

reject in interface DeviceConfirmationService

remove

public void remove(String id)

Description copied from interface: DeviceConfirmationService

Removes a confirmation for the logged user.

Specified by:

remove in interface DeviceConfirmationService

validate

public TrustedDevice validate(String id,
                              long deviceId,
                              String hmac)

Description copied from interface: DeviceConfirmationServiceLocal

Validates a PENDING confirmation with a device to ensure the device is a valid trusted device. This method perform the same validation as for #approve(long, long, String) but immediately remove the confirmation and do not send any push-notification if the validation success.

Specified by:

validate in interface DeviceConfirmationServiceLocal

Returns:

the device associated to the given id

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl