Package org.cyclos.impl.users

Class UserAddressServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

org.cyclos.impl.users.UserAddressServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<UserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>, UserAddressServiceLocal, CRUDService<UserAddressDTO,UserAddressData,UserAddressDataParams>, CRUDWithConfirmationPasswordService<UserAddressDTO,UserAddressData,UserAddressDataParams>, Service, UserAddressService

@Service
public class UserAddressServiceImpl
extends CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>
implements UserAddressServiceLocal

Implementation for UserAddressService

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, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
UserAddressServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addCustomNameValidations(Property name, UserAddressDTO namedDTO)	This method may be overridden to add custom validations for the NAME property.
void	appendValidations(Validator validator, AddressDTO address, ConfigurationAccessor configuration, boolean nameRequired)	Append validation of address fields to the given validator
void	cleanDisabledAddressFields(IAddress address, ConfigurationAccessor configuration)	Sets null to the disabled address fields according to the given configuration
protected void	doRemove(UserAddress address, boolean flush)	May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well
List<UserAddressVO>	getAddresses(User user, boolean visibleOnly, boolean locatedOnly)	Returns all the user addresses or only the visible or located ones
UserAddressListData	getAddressListData(UserLocatorVO locator)	Returns all the user addresses.
protected UserAddressData	getData(UserAddress address)	Returns details data for the given entity
UserAddress	getDefaultUserAddress(User user)	Returns the user default address or null if none exists
protected CreateDeviceConfirmationParams	getDeviceConfirmationParams(UserAddressDTO dto, UserAddress entity, CRUDOperation operation)	If the confirmation password must be checked then subclasses must overwrite this method to return a no-null CreateDeviceConfirmationParams object.
protected Object[]	getExcludedPropertiesToEntity(UserAddressDTO dto)	May be overridden in order to exclude properties when converting the given DTO to entity
SearchByDistanceData	getSearchByDistanceData()	Returns data for the logged user to search by distance
Validator	getValidator(AddressDTO address, Group group, boolean nameRequired)	Validate a userAddressDTO instance when a userAddress is being validated outside this service (for example PublicRegistrationRemoteServiceImpl
List<UserAddress>	listByUser(User user)	Returns all user addresses for the given user
void	markAsDefault(Long id)	Marks the given address as default for it's owner
boolean	maxAddressesReached(User user)	Returns whether the given has reached the limit of allowed addresses
UserAddress	newEntity(UserAddressDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterRemove(UserAddress address)	May be overridden in order to perform custom logic after removing an entity
protected void	onAfterSave(UserAddress address, UserAddress currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected void	onBeforeRemove(UserAddress address)	May be overridden in order to perform custom logic before removing an entity
protected Object	onBeforeSave(UserAddress address, UserAddress currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	preProcessCurrentCopy(UserAddressDTO dto, UserAddress currentCopy)	This method is invoked before saving the entity and also, if the log is enabled, before removing.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	removeAll(User user)	Removes all addresses of the given user
protected ExtensionPointAccessor	resolveExtensionPointAccessor(CRUDOperation operation, UserAddress address)	Should be overridden by subclasses which have extension points
protected Validator	resolveValidator(UserAddressDTO dto)
protected boolean	shouldCheckConfirmationPassword(UserAddress entity, CRUDOperation operation)	Controls whether confirmation password should be checked for the given entity and operation.
UserAddress	toEntity(UserAddressDTO dto)	Converts the given DTO in an entity, 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, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, subClassMappings, toDTO, 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, toDTO, validate

Methods inherited from interface org.cyclos.services.CRUDWithConfirmationPasswordService

getConfirmationPasswordInputForRemove, removeAllWithConfirmationPassword, removeWithConfirmationPassword, saveWithConfirmationPassword

Constructor Detail

UserAddressServiceImpl

public UserAddressServiceImpl()

Method Detail

appendValidations

public void appendValidations(Validator validator,
                              AddressDTO address,
                              ConfigurationAccessor configuration,
                              boolean nameRequired)

Description copied from interface: UserAddressServiceLocal

Append validation of address fields to the given validator

Specified by:

appendValidations in interface UserAddressServiceLocal

cleanDisabledAddressFields

public void cleanDisabledAddressFields(IAddress address,
                                       ConfigurationAccessor configuration)

Description copied from interface: UserAddressServiceLocal

Sets null to the disabled address fields according to the given configuration

Specified by:

cleanDisabledAddressFields in interface UserAddressServiceLocal

getAddresses

public List<UserAddressVO> getAddresses(User user,
                                        boolean visibleOnly,
                                        boolean locatedOnly)

Description copied from interface: UserAddressServiceLocal

Returns all the user addresses or only the visible or located ones

Specified by:

getAddresses in interface UserAddressServiceLocal

getAddressListData

public UserAddressListData getAddressListData(UserLocatorVO locator)

Description copied from interface: UserAddressService

Returns all the user addresses. If the logged user manages the given user, the hidden addresses will be also returned.

Specified by:

getAddressListData in interface UserAddressService

getDefaultUserAddress

public UserAddress getDefaultUserAddress(User user)
                                  throws FrameworkException

Description copied from interface: UserAddressServiceLocal

Returns the user default address or null if none exists

Specified by:

getDefaultUserAddress in interface UserAddressServiceLocal

Throws:

FrameworkException

getSearchByDistanceData

public SearchByDistanceData getSearchByDistanceData()
                                             throws FrameworkException

Description copied from interface: UserAddressServiceLocal

Returns data for the logged user to search by distance

Specified by:

getSearchByDistanceData in interface UserAddressServiceLocal

Throws:

FrameworkException

getValidator

public Validator getValidator(AddressDTO address,
                              Group group,
                              boolean nameRequired)

Validate a userAddressDTO instance when a userAddress is being validated outside this service (for example PublicRegistrationRemoteServiceImpl

Specified by:

getValidator in interface UserAddressServiceLocal

listByUser

public List<UserAddress> listByUser(User user)

Description copied from interface: UserAddressServiceLocal

Returns all user addresses for the given user

Specified by:

listByUser in interface UserAddressServiceLocal

markAsDefault

public void markAsDefault(Long id)
                   throws FrameworkException

Description copied from interface: UserAddressService

Marks the given address as default for it's owner

Specified by:

markAsDefault in interface UserAddressService

Throws:

FrameworkException

maxAddressesReached

public boolean maxAddressesReached(User user)
                            throws FrameworkException

Description copied from interface: UserAddressServiceLocal

Returns whether the given has reached the limit of allowed addresses

Specified by:

maxAddressesReached in interface UserAddressServiceLocal

Throws:

FrameworkException

newEntity

public UserAddress newEntity(UserAddressDataParams 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<UserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

Specified by:

newEntity in class CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

removeAll

public void removeAll(User user)

Description copied from interface: UserAddressServiceLocal

Removes all addresses of the given user

Specified by:

removeAll in interface UserAddressServiceLocal

toEntity

public UserAddress toEntity(UserAddressDTO dto)

Description copied from class: CRUDServiceImpl

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

Specified by:

toEntity in interface CRUDServiceLocal<UserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

Overrides:

toEntity in class CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

addCustomNameValidations

protected void addCustomNameValidations(Property name,
                                        UserAddressDTO namedDTO)

Description copied from class: CRUDServiceImpl

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

Overrides:

addCustomNameValidations in class CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

doRemove

protected void doRemove(UserAddress address,
                        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<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

getData

protected UserAddressData getData(UserAddress address)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

getDeviceConfirmationParams

protected CreateDeviceConfirmationParams getDeviceConfirmationParams(UserAddressDTO dto,
                                                                     UserAddress entity,
                                                                     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<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

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.

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

getExcludedPropertiesToEntity

protected Object[] getExcludedPropertiesToEntity(UserAddressDTO 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<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

onAfterRemove

protected void onAfterRemove(UserAddress address)

Description copied from class: CRUDServiceImpl

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

Overrides:

onAfterRemove in class CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

onAfterSave

protected void onAfterSave(UserAddress address,
                           UserAddress 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<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

onBeforeRemove

protected void onBeforeRemove(UserAddress address)

Description copied from class: CRUDServiceImpl

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

Overrides:

onBeforeRemove in class CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

onBeforeSave

protected Object onBeforeSave(UserAddress address,
                              UserAddress 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<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

preProcessCurrentCopy

protected void preProcessCurrentCopy(UserAddressDTO dto,
                                     UserAddress currentCopy)

Description copied from class: CRUDServiceImpl

This method is invoked before saving the entity and also, if the log is enabled, before removing. Subclasses can override it to fetch lazy relationships, etc as the current copy will be detached. In case of removing (i.e the log is enabled for this entity) the dto parameter will be null.

Overrides:

preProcessCurrentCopy in class CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

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,
                                                               UserAddress address)

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which have extension points

Overrides:

resolveExtensionPointAccessor in class CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

resolveValidator

protected Validator resolveValidator(UserAddressDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>

shouldCheckConfirmationPassword

protected boolean shouldCheckConfirmationPassword(UserAddress entity,
                                                  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<UserAddress,QUserAddress,UserAddressDTO,UserAddressData,UserAddressDataParams>