Package org.cyclos.impl.access

Class PinServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.access.PinServiceImpl

All Implemented Interfaces:

PinServiceLocal, PinService, Service

@Service
public class PinServiceImpl
extends BaseServiceImpl
implements PinServiceLocal

Implementation for PinService

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.impl.access.PinServiceLocal

PRINCIPAL_LENGTH, SALT_LENGTH

Constructor Summary

Constructors

Constructor	Description
PinServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	checkPin(Pin pin, String pinValue, ChannelAccessAccessor channelAccess)	Checks the plain pin's value sent by a client ensuring it matched the value stored in the given Pin entity.
Pin	ensurePin(PinLocatorVO locator)	Returns the Pin from the given locator or (if null) from the current session if authenticated with pin.
UserPinsData	getData(UserLocatorVO locator)	Returns data regarding pins for the given user (null resolves to the logged user).
PinData	getEditData(PinLocatorVO locator)	Returns data for editing a pin.
Pair<Pin,ChannelAccessAccessor>	getIfActive(PinLocatorVO pinLocator, Channel channel)	Returns both the Pin and its channel access configuration for the current channel if it is active: exists, not expired and active on channel.
PasswordInputDTO	getPasswordInputForCreate()	Return the password input required to create a pin for the logged user.
void	initialize()
List<PinVO>	list(UserLocatorVO locator)	Returns the list of device pins for the given user (null resolves to the logged user). Manager users must have the Permission.USER_PINS_VIEW permission.
PinDetailedVO	locate(PinLocatorVO locator)	Locates a device pin, either by id or principal.
Pin	locatePin(PinLocatorVO locator, boolean ownPin)	Locates a device pin, either by id or principal.
boolean	pinEnabled(BasicUser user)	Returns whether the given user has at least one channel with PIN enabled.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
<T extends NetworkedEntity> void	relatedEntityRemoved(T entity, Supplier<T> newEntitySupplier)	Searches for all Pin instances related to the entity being removed and for all of those, sets the new entity obtained from the supplier as the new related one. If the supplier returns null then all related pins are removed.
void	remove(PinLocatorVO locator, CurrentCredentialsForPinManage currentCredentials)	Removes the given pin.
long	removeExpired()	Removes all expired PINs
void	save(PinDTO dto)	Updates a given device pin for the logged user.
CreatePinDTO	set(SetPinParams params)	Creates a new pin or modify an existing for the logged user and associates it to the current principal type and password type.
ValidationResult	validate(@NotNull String value)	Validates a value to be used as a pin for the logged user and the current channel.

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

Constructor Detail

PinServiceImpl

public PinServiceImpl()

Method Detail

checkPin

public void checkPin(Pin pin,
                     String pinValue,
                     ChannelAccessAccessor channelAccess)

Description copied from interface: PinServiceLocal

Checks the plain pin's value sent by a client ensuring it matched the value stored in the given Pin entity.

Specified by:

checkPin in interface PinServiceLocal

ensurePin

public Pin ensurePin(PinLocatorVO locator)

Description copied from interface: PinServiceLocal

Returns the Pin from the given locator or (if null) from the current session if authenticated with pin. Otherwise, if a pin can be obtained then it throws a ValidationException.

Specified by:

ensurePin in interface PinServiceLocal

getData

public UserPinsData getData(UserLocatorVO locator)
                     throws FrameworkException

Description copied from interface: PinService

Returns data regarding pins for the given user (null resolves to the logged user).

Specified by:

getData in interface PinService

Throws:

FrameworkException

getEditData

public PinData getEditData(PinLocatorVO locator)
                    throws FrameworkException

Description copied from interface: PinService

Returns data for editing a pin.

Specified by:

getEditData in interface PinService

Parameters:

locator - Optional if authenticated with a pin. Otherwise it must not be null.

Throws:

FrameworkException

getIfActive

public Pair<Pin,ChannelAccessAccessor> getIfActive(PinLocatorVO pinLocator,
                                                         Channel channel)

Description copied from interface: PinServiceLocal

Returns both the Pin and its channel access configuration for the current channel if it is active: exists, not expired and active on channel. Otherwise, returns null.

Specified by:

getIfActive in interface PinServiceLocal

getPasswordInputForCreate

public PasswordInputDTO getPasswordInputForCreate()
                                           throws FrameworkException

Description copied from interface: PinService

Return the password input required to create a pin for the logged user.

Specified by:

getPasswordInputForCreate in interface PinService

Throws:

FrameworkException

initialize

@PostConstruct
public void initialize()

list

public List<PinVO> list(UserLocatorVO locator)
                 throws FrameworkException

Description copied from interface: PinService

Returns the list of device pins for the given user (null resolves to the logged user).
Manager users must have the Permission.USER_PINS_VIEW permission.

Specified by:

list in interface PinService

Throws:

FrameworkException

locate

public PinDetailedVO locate(PinLocatorVO locator)

Description copied from interface: PinService

Locates a device pin, either by id or principal. For users other than the pin's owner (admin / brokers) the Permission.USER_PINS_VIEW permission must be granted

Specified by:

locate in interface PinService

Parameters:

locator - Optional if authenticated with a pin. Otherwise it must not be null.

locatePin

public Pin locatePin(PinLocatorVO locator,
                     boolean ownPin)

Description copied from interface: PinServiceLocal

Locates a device pin, either by id or principal. If the ownPin parameter is true then the located pin (if any) must belong to the logged user.

Specified by:

locatePin in interface PinServiceLocal

pinEnabled

public boolean pinEnabled(BasicUser user)

Description copied from interface: PinServiceLocal

Returns whether the given user has at least one channel with PIN enabled.

Specified by:

pinEnabled in interface PinServiceLocal

relatedEntityRemoved

public <T extends NetworkedEntity> void relatedEntityRemoved(T entity,
                                                             Supplier<T> newEntitySupplier)

Description copied from interface: PinServiceLocal

Searches for all Pin instances related to the entity being removed and for all of those, sets the new entity obtained from the supplier as the new related one.
If the supplier returns null then all related pins are removed.

Specified by:

relatedEntityRemoved in interface PinServiceLocal

remove

public void remove(PinLocatorVO locator,
                   CurrentCredentialsForPinManage currentCredentials)
            throws FrameworkException

Description copied from interface: PinService

Removes the given pin. For managers (admin / brokers) the Permission.USER_PINS_MANAGE permission must be granted. For the pin owner the action must be confirmed with the current login password for the current channel or the current pin. Only one of these is mandatory to be given.

Specified by:

remove in interface PinService

Parameters:

locator - Optional if authenticated with a pin. Otherwise it must not be null.

Throws:

FrameworkException

removeExpired

public long removeExpired()

Description copied from interface: PinServiceLocal

Removes all expired PINs

Specified by:

removeExpired in interface PinServiceLocal

save

public void save(PinDTO dto)
          throws FrameworkException

Description copied from interface: PinService

Updates a given device pin for the logged user. It will be used from the mobile in the settings page. The given pin's name must be unique, otherwise it throws a ValidationException

Specified by:

save in interface PinService

Throws:

FrameworkException

set

public CreatePinDTO set(SetPinParams params)
                 throws FrameworkException

Description copied from interface: PinService

Creates a new pin or modify an existing for the logged user and associates it to the current principal type and password type. The result will contain the generated principal and a salt that must be prepended to the pin entered by the user when login. In case of a modification the current pin or login password must be given.

Specified by:

set in interface PinService

Throws:

FrameworkException

validate

public ValidationResult validate(@NotNull
                                 @NotNull String value)

Description copied from interface: PinService

Validates a value to be used as a pin for the logged user and the current channel.

Specified by:

validate in interface PinService

Returns:

null if the value is valid. Otherwise return the validation error.

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