org.cyclos.security.access

Class PinServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.access.PinServiceSecurity

All Implemented Interfaces:

PinService, Service

@Security
public class PinServiceSecurity
extends BaseServiceSecurity
implements PinService

Security for PinService

Author:

ameyer

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

Constructor Summary

Constructors

Constructor and Description
PinServiceSecurity()

Method Summary

Modifier and Type	Method and Description
void	apply(BasicUser user, UserPinsData data)
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.
PasswordInputDTO	getPasswordInputForCreate() Return the password input required to create a pin for the logged user.
java.util.List<PinVO>	list(UserLocatorVO locator) Returns the list of device pins for the given user (null resolves to the logged user).
PinDetailedVO	locate(PinLocatorVO locator) Locates a device pin, either by id or principal.
void	remove(PinLocatorVO locator, CurrentCredentialsForPinManage currentCredentials) Removes the given pin.
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(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 java.lang.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.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, 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

PinServiceSecurity

public PinServiceSecurity()

Method Detail

apply

public void apply(BasicUser user,
                  UserPinsData data)

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

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

list

public java.util.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.

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

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 java.lang.String value)
                          throws FrameworkException

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.

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