org.cyclos.security.access

Class TrustedDeviceServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.access.TrustedDeviceServiceSecurity

All Implemented Interfaces:

TrustedDeviceService, Service

@Security
public class TrustedDeviceServiceSecurity
extends BaseServiceSecurity
implements TrustedDeviceService

Security for TrustedDeviceService

Author:

ameyer

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

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

Fields inherited from class org.cyclos.impl.AbstractServerComponent

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

Constructor Summary

Constructors

Constructor and Description
TrustedDeviceServiceSecurity()

Method Summary

Modifier and Type	Method and Description
ActivateTrustedDeviceDTO	activate(java.lang.String code) Activates the trusted device with the given code for the logged user.
TrustedDeviceActivationData	getActivationData() Returns data required to activate a device for the logged user.
TrustedDeviceData	getData(long id) Returns data about a trusted device.
java.util.List<TrustedDeviceVO>	list(UserLocatorVO locator) Returns the list of trusted devices for the given user (null resolves to the logged user).
void	remove(java.lang.Long id) Removes a trusted device by id for the logged user.
RequestActivationResult	requestActivationCode(@NotNull RequestDeviceActivationParams params) Requests for an activation code.
protected org.cyclos.impl.access.EntityCheck<?>	resolveEntityCheck() Must be implemented in order to return the EntityCheck managed by this security component, or null if none
void	save(TrustedDeviceDTO dto) Updates a given trusted device for the logged user.

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

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, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

delete, detach, 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

Constructor Detail

TrustedDeviceServiceSecurity

public TrustedDeviceServiceSecurity()

Method Detail

activate

public ActivateTrustedDeviceDTO activate(java.lang.String code)
                                  throws FrameworkException

Description copied from interface: TrustedDeviceService

Activates the trusted device with the given code for the logged user.

Specified by:

activate in interface TrustedDeviceService

Throws:

FrameworkException

getActivationData

public TrustedDeviceActivationData getActivationData()
                                              throws FrameworkException

Description copied from interface: TrustedDeviceService

Returns data required to activate a device for the logged user.

Specified by:

getActivationData in interface TrustedDeviceService

Throws:

FrameworkException

getData

public TrustedDeviceData getData(long id)
                          throws FrameworkException

Description copied from interface: TrustedDeviceService

Returns data about a trusted device.

Specified by:

getData in interface TrustedDeviceService

Throws:

FrameworkException

list

public java.util.List<TrustedDeviceVO> list(UserLocatorVO locator)
                                     throws FrameworkException

Description copied from interface: TrustedDeviceService

Returns the list of trusted devices for the given user (null resolves to the logged user).
Manager users must have the Permission.USER_TRUSTED_DEVICES_VIEW permission.

Specified by:

list in interface TrustedDeviceService

Throws:

FrameworkException

remove

public void remove(java.lang.Long id)
            throws FrameworkException

Description copied from interface: TrustedDeviceService

Removes a trusted device by id for the logged user.

Specified by:

remove in interface TrustedDeviceService

Throws:

FrameworkException

requestActivationCode

public RequestActivationResult requestActivationCode(@NotNull
                                                     @NotNull RequestDeviceActivationParams params)
                                              throws FrameworkException

Description copied from interface: TrustedDeviceService

Requests for an activation code. This method can be used to request a code for the first time or as a new request for a given device. In case a RequestDeviceActivationParams.DEVICE_ID is given then the same existing code for that device will be send again and the the name won't be changed (it's ignored if given). Otherwise, a new pending trusted device will be created for the logged user and the code will be sent (in that case the name is required). (phone / e-mail). If RequestDeviceActivationParams.MEDIUM is SendMedium.SMS then the message will be send to the (required) RequestDeviceActivationParams#PHONE.

Specified by:

requestActivationCode in interface TrustedDeviceService

Returns:

A VO with the following:

• The final name assigned to the device. It could be different to the input name if it's already in use
• The device id (required to re-send the code)
• The e-mail or the normalized mobile phone number that received the code
• The creation date

Throws:

FrameworkException

save

public void save(TrustedDeviceDTO dto)
          throws FrameworkException

Description copied from interface: TrustedDeviceService

Updates a given trusted device for the logged user. It will be used from the mobile in the settings page.

Specified by:

save in interface TrustedDeviceService

Throws:

FrameworkException

resolveEntityCheck

protected org.cyclos.impl.access.EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity