Package org.cyclos.impl.users

Class OperatorServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

org.cyclos.impl.users.OperatorServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<Operator,OperatorDTO,OperatorData,OperatorDataParams>, OperatorServiceLocal, CRUDService<OperatorDTO,OperatorData,OperatorDataParams>, CRUDWithConfirmationPasswordService<OperatorDTO,OperatorData,OperatorDataParams>, Service, OperatorService

@Service
public class OperatorServiceImpl
extends CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>
implements OperatorServiceLocal

Implementation for OperatorService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

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

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.impl.users.OperatorServiceLocal

op

Constructor Summary

Constructors

Constructor	Description
OperatorServiceImpl()

Method Summary

Modifier and Type	Method	Description
OperatorGroupAccountAccess	accountAccess(Account account)	If the logged user is a restricted operator, returns his access over the given account (never null).
protected void	addCustomNameValidations(Property name, OperatorDTO dto)	This method may be overridden to add custom validations for the NAME property.
boolean	canViewOperators(User user)	Returns true if the logged user can view the operators of the given user.
protected void	doRemove(Operator operator, boolean flush)	May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well
protected OperatorData	getData(Operator operator)	Returns details data for the given entity
protected CreateDeviceConfirmationParams	getDeviceConfirmationParams(OperatorDTO dto, Operator operator, CRUDOperation operation)	If the confirmation password must be checked then subclasses must overwrite this method to return a no-null CreateDeviceConfirmationParams object.
Object[]	getExcludedPropertiesToEntity()	Same as the getExcludedPropertiesToEntity() method from the CRUDServiceImpl but for all dto's instances.
protected Object[]	getExcludedPropertiesToEntity(OperatorDTO dto)	May be overridden in order to exclude properties when converting the given DTO to entity
OperatorsSearchData	getSearchData(UserLocatorVO locator)	Returns data for searching operators of the given user
protected Pair<DBQuery<?>,String>	getUniqueNameQuery(OperatorDTO dto)	This method may be overridden to customize the default global unique validation for the name property.
ViewOperatorProfileData	getViewProfileData(UserLocatorVO locator)	Returns data for viewing an operator profile
boolean	hasOperators(User user)	Returns whether the user even had operators
protected boolean	isNameRequired(OperatorDTO dto)	By default, the name is always required
com.mysema.commons.lang.CloseableIterator<Operator>	iterateOperatorsToNotify(BasicUser destination, UserNotificationType type, boolean aliasesOnly)	Returns either all or only alias operators from the given owner that chose to receive the given notification type.
com.mysema.commons.lang.CloseableIterator<BasicUser>	iteratePossibleAuthorizers(Operator operator, PaymentTransferType type)	Returns all basic users that can authorize payments of the given type, excluding the given operator.
List<Operator>	list(User user)	Lists all operators for the given user
List<Operator>	listAliases(User user)	Lists the alias operators of the given user.
Operator	newEntity(OperatorDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(Operator operator, Operator currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected void	onBeforeRemove(Operator operator)	May be overridden in order to perform custom logic before removing an entity
protected Object	onBeforeSave(Operator operator, Operator currentCopy)	May be overridden in order to perform custom logic before saving an entity.
void	onRegistrationValidation(Operator operator)	Performs additional actions when an operator registration is validated
UserRegistrationResult	register(OperatorRegistrationDTO dto)	Registers an operator, returning the status and generated data
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	removeAll(User user, boolean purge)	Removes all operators from the given user
protected ExtensionPointAccessor	resolveExtensionPointAccessor(CRUDOperation operation, Operator operator)	Should be overridden by subclasses which have extension points
protected Validator	resolveValidator(OperatorDTO dto)
Page<OperatorWithFieldsVO>	search(OperatorQuery params)	Searches for operators according to the given criteria
protected boolean	shouldCheckConfirmationPassword(Operator operator, CRUDOperation operation)	Controls whether confirmation password should be checked for the given entity and operation.
OperatorDTO	toDTO(Operator entity)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, checkConfirmationPassword, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getNameLabel, getUniqueInternalNameQuery, isEntityInternalNameRequired, load, logEntity, onAfterRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, subClassMappings, toEntity, validate

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

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, 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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toEntity, validate

Methods inherited from interface org.cyclos.services.CRUDWithConfirmationPasswordService

getConfirmationPasswordInputForRemove, removeAllWithConfirmationPassword, removeWithConfirmationPassword, saveWithConfirmationPassword

Constructor Detail

OperatorServiceImpl

public OperatorServiceImpl()

Method Detail

accountAccess

public OperatorGroupAccountAccess accountAccess(Account account)

Description copied from interface: OperatorServiceLocal

If the logged user is a restricted operator, returns his access over the given account (never null). If not a restricted operator, returns null.

Specified by:

accountAccess in interface OperatorServiceLocal

canViewOperators

public boolean canViewOperators(User user)

Description copied from interface: OperatorServiceLocal

Returns true if the logged user can view the operators of the given user.

Specified by:

canViewOperators in interface OperatorServiceLocal

getExcludedPropertiesToEntity

public Object[] getExcludedPropertiesToEntity()

Description copied from interface: OperatorServiceLocal

Same as the getExcludedPropertiesToEntity() method from the CRUDServiceImpl but for all dto's instances.

Specified by:

getExcludedPropertiesToEntity in interface OperatorServiceLocal

getSearchData

public OperatorsSearchData getSearchData(UserLocatorVO locator)
                                  throws FrameworkException

Description copied from interface: OperatorService

Returns data for searching operators of the given user

Specified by:

getSearchData in interface OperatorService

Throws:

FrameworkException

getViewProfileData

public ViewOperatorProfileData getViewProfileData(UserLocatorVO locator)
                                           throws FrameworkException

Description copied from interface: OperatorService

Returns data for viewing an operator profile

Specified by:

getViewProfileData in interface OperatorService

Throws:

FrameworkException

hasOperators

public boolean hasOperators(User user)

Description copied from interface: OperatorServiceLocal

Returns whether the user even had operators

Specified by:

hasOperators in interface OperatorServiceLocal

iterateOperatorsToNotify

public com.mysema.commons.lang.CloseableIterator<Operator> iterateOperatorsToNotify(BasicUser destination,
                                                                                    UserNotificationType type,
                                                                                    boolean aliasesOnly)

Description copied from interface: OperatorServiceLocal

Returns either all or only alias operators from the given owner that chose to receive the given notification type. If the destination is an operator, he won't be included in the result.

Specified by:

iterateOperatorsToNotify in interface OperatorServiceLocal

iteratePossibleAuthorizers

public com.mysema.commons.lang.CloseableIterator<BasicUser> iteratePossibleAuthorizers(Operator operator,
                                                                                       PaymentTransferType type)

Description copied from interface: OperatorServiceLocal

Returns all basic users that can authorize payments of the given type, excluding the given operator. The member is always returned, as well as any alias operators, plus all operators that have permission to authorize the given payment type.

Specified by:

iteratePossibleAuthorizers in interface OperatorServiceLocal

list

public List<Operator> list(User user)
                    throws FrameworkException

Description copied from interface: OperatorServiceLocal

Lists all operators for the given user

Specified by:

list in interface OperatorServiceLocal

Throws:

FrameworkException

listAliases

public List<Operator> listAliases(User user)
                           throws FrameworkException

Description copied from interface: OperatorServiceLocal

Lists the alias operators of the given user. Aliases are operators without a group

Specified by:

listAliases in interface OperatorServiceLocal

Throws:

FrameworkException

newEntity

public Operator newEntity(OperatorDataParams params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<Operator,OperatorDTO,OperatorData,OperatorDataParams>

Specified by:

newEntity in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

onRegistrationValidation

public void onRegistrationValidation(Operator operator)

Description copied from interface: OperatorServiceLocal

Performs additional actions when an operator registration is validated

Specified by:

onRegistrationValidation in interface OperatorServiceLocal

register

public UserRegistrationResult register(OperatorRegistrationDTO dto)
                                throws FrameworkException

Description copied from interface: OperatorService

Registers an operator, returning the status and generated data

Specified by:

register in interface OperatorService

Throws:

FrameworkException

removeAll

public void removeAll(User user,
                      boolean purge)

Description copied from interface: OperatorServiceLocal

Removes all operators from the given user

Specified by:

removeAll in interface OperatorServiceLocal

search

public Page<OperatorWithFieldsVO> search(OperatorQuery params)
                                  throws FrameworkException

Description copied from interface: OperatorService

Searches for operators according to the given criteria

Specified by:

search in interface OperatorService

Throws:

FrameworkException

toDTO

public OperatorDTO toDTO(Operator entity)

Description copied from class: CRUDServiceImpl

Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toDTO in interface CRUDServiceLocal<Operator,OperatorDTO,OperatorData,OperatorDataParams>

Overrides:

toDTO in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

addCustomNameValidations

protected void addCustomNameValidations(Property name,
                                        OperatorDTO dto)

Description copied from class: CRUDServiceImpl

This method may be overridden to add custom validations for the NAME property.

Overrides:

addCustomNameValidations in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

doRemove

protected void doRemove(Operator operator,
                        boolean flush)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well

Overrides:

doRemove in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

getData

protected OperatorData getData(Operator operator)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

getDeviceConfirmationParams

protected CreateDeviceConfirmationParams getDeviceConfirmationParams(OperatorDTO dto,
                                                                     Operator operator,
                                                                     CRUDOperation operation)

Description copied from class: CRUDServiceImpl

If the confirmation password must be checked then subclasses must overwrite this method to return a no-null CreateDeviceConfirmationParams object. This object is required to validate the confirmation when the operation was confirmed with a device.

Overrides:

getDeviceConfirmationParams in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

Parameters:

dto - , it can be null, subclasses must take it into account. E.g: to disable a mobile phone for SMS, the confirmation password must be check and for this case there is no DTO instance.

operator - never null, represents the current value (i.e before apply the dto).

getExcludedPropertiesToEntity

protected Object[] getExcludedPropertiesToEntity(OperatorDTO dto)

Description copied from class: CRUDServiceImpl

May be overridden in order to exclude properties when converting the given DTO to entity

Overrides:

getExcludedPropertiesToEntity in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

getUniqueNameQuery

protected Pair<DBQuery<?>,String> getUniqueNameQuery(OperatorDTO dto)

Description copied from class: CRUDServiceImpl

This method may be overridden to customize the default global unique validation for the name property. Also it must return a string with the context to be included in the key used for the lock (LockKey#LockType)

Overrides:

getUniqueNameQuery in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

isNameRequired

protected boolean isNameRequired(OperatorDTO dto)

Description copied from class: CRUDServiceImpl

By default, the name is always required

Overrides:

isNameRequired in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

onAfterSave

protected void onAfterSave(Operator operator,
                           Operator currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

onBeforeRemove

protected void onBeforeRemove(Operator operator)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before removing an entity

Overrides:

onBeforeRemove in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

onBeforeSave

protected Object onBeforeSave(Operator operator,
                              Operator currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

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

resolveExtensionPointAccessor

protected ExtensionPointAccessor resolveExtensionPointAccessor(CRUDOperation operation,
                                                               Operator operator)

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which have extension points

Overrides:

resolveExtensionPointAccessor in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

resolveValidator

protected Validator resolveValidator(OperatorDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>

shouldCheckConfirmationPassword

protected boolean shouldCheckConfirmationPassword(Operator operator,
                                                  CRUDOperation operation)

Description copied from class: CRUDServiceImpl

Controls whether confirmation password should be checked for the given entity and operation. By default returns true if this service indirectly implements CRUDWithConfirmationPasswordService (for example, if the remote service interface extends it).

Overrides:

shouldCheckConfirmationPassword in class CRUDServiceImpl<Operator,QOperator,OperatorDTO,OperatorData,OperatorDataParams>