Package org.cyclos.impl.users

Class UserCustomFieldServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<CF,A,DTO,D,DP>

org.cyclos.impl.system.BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

org.cyclos.impl.users.UserCustomFieldServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<UserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>, UserCustomFieldServiceLocal, CRUDService<UserCustomFieldDTO,UserCustomFieldData,Void>, CRUDWithConfirmationPasswordService<UserCustomFieldDTO,UserCustomFieldData,Void>, Service, BaseCustomFieldService<UserCustomFieldDTO,UserCustomFieldData,Void>, UserCustomFieldService

@Service
public class UserCustomFieldServiceImpl
extends BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>
implements UserCustomFieldServiceLocal

Service implementation for user custom fields

Field Summary

Fields inherited from class org.cyclos.impl.system.BaseCustomFieldServiceImpl

customFieldValueHandler, customScriptService, dataClass

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, 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, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
UserCustomFieldServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addCustomInternalNameValidations(Property internalName, UserCustomFieldDTO dto)	This method may be overridden to add custom validations for the INTERNAL_NAME property.
boolean	existsUser(UserCustomField field, String value)	Returns true if there exists a non removed user that has a custom field value with the given value.
protected UserCustomFieldData	getData(UserCustomField field)	Returns details data for the given entity
protected Integer	getMaxOrder(UserCustomField field)	Should be implemented in order to return the maximum order number for fields like the given one
protected BaseCustomFieldPossibleValueCategoryServiceLocal<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue>	getPossibleValueCategoryService()	Must be implemented in order to return the corresponding category service
protected UserCustomFieldPossibleValueServiceLocal	getPossibleValueService()	Must be implemented in order to return the corresponding possible value service
protected List<Class<?>>	getPropertyClasses()	May be overridden in order to return a list of classes to apply internal name property validations
protected boolean	isBinaryTypesAllowed()	Indicates whether this custom field nature allows binary types
List<CustomFieldVO>	list()	Returns all user custom fields
List<UserCustomField>	listAll()	Returns all user custom fields
List<String>	listOidcClaims()	Returns all OpenID Connect claims from user custom fields for this network
UserCustomField	newEntity(Void params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterRemove(UserCustomField entity)	May be overridden in order to perform custom logic after removing an entity
protected void	onBeforeRemove(UserCustomField field)	May be overridden in order to perform custom logic before removing an entity
protected Object	onBeforeSave(UserCustomField field, UserCustomField currentCopy)	May be overridden in order to perform custom logic before saving an entity.
void	purgeValues(BasicUser user)	Purges the custom field values of the given user that are set to be purged with the user
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network

Methods inherited from class org.cyclos.impl.system.BaseCustomFieldServiceImpl

addCustomValidations, isEntityInternalNameRequired, resolveValidator, supportsValues, toDetailedVOs, toDTO

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isNameRequired, load, logEntity, onAfterSave, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, 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.system.BaseCustomFieldService

saveOrder

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, toEntity, validate

Constructor Detail

UserCustomFieldServiceImpl

public UserCustomFieldServiceImpl()

Method Detail

existsUser

public boolean existsUser(UserCustomField field,
                          String value)

Description copied from interface: UserCustomFieldServiceLocal

Returns true if there exists a non removed user that has a custom field value with the given value. Only two types of field are supported: string and integer. Based on the type of the field, it looks on the corresponding attribute of the custom field value.

Specified by:

existsUser in interface UserCustomFieldServiceLocal

list

public List<CustomFieldVO> list()

Description copied from interface: UserCustomFieldService

Returns all user custom fields

Specified by:

list in interface UserCustomFieldService

listAll

public List<UserCustomField> listAll()

Description copied from interface: UserCustomFieldServiceLocal

Returns all user custom fields

Specified by:

listAll in interface UserCustomFieldServiceLocal

listOidcClaims

public List<String> listOidcClaims()

Description copied from interface: UserCustomFieldServiceLocal

Returns all OpenID Connect claims from user custom fields for this network

Specified by:

listOidcClaims in interface UserCustomFieldServiceLocal

newEntity

public UserCustomField newEntity(Void 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<UserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

Specified by:

newEntity in class CRUDServiceImpl<UserCustomField,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

purgeValues

public void purgeValues(BasicUser user)

Description copied from interface: UserCustomFieldServiceLocal

Purges the custom field values of the given user that are set to be purged with the user

Specified by:

purgeValues in interface UserCustomFieldServiceLocal

addCustomInternalNameValidations

protected void addCustomInternalNameValidations(Property internalName,
                                                UserCustomFieldDTO dto)

Description copied from class: CRUDServiceImpl

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

Overrides:

addCustomInternalNameValidations in class BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

getData

protected UserCustomFieldData getData(UserCustomField field)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Overrides:

getData in class BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

getMaxOrder

protected Integer getMaxOrder(UserCustomField field)

Description copied from class: BaseCustomFieldServiceImpl

Should be implemented in order to return the maximum order number for fields like the given one

Specified by:

getMaxOrder in class BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

getPossibleValueCategoryService

protected BaseCustomFieldPossibleValueCategoryServiceLocal<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue> getPossibleValueCategoryService()

Description copied from class: BaseCustomFieldServiceImpl

Must be implemented in order to return the corresponding category service

Specified by:

getPossibleValueCategoryService in class BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

getPossibleValueService

protected UserCustomFieldPossibleValueServiceLocal getPossibleValueService()

Description copied from class: BaseCustomFieldServiceImpl

Must be implemented in order to return the corresponding possible value service

Specified by:

getPossibleValueService in class BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

getPropertyClasses

protected List<Class<?>> getPropertyClasses()

Description copied from class: BaseCustomFieldServiceImpl

May be overridden in order to return a list of classes to apply internal name property validations

Overrides:

getPropertyClasses in class BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

isBinaryTypesAllowed

protected boolean isBinaryTypesAllowed()

Description copied from class: BaseCustomFieldServiceImpl

Indicates whether this custom field nature allows binary types

Specified by:

isBinaryTypesAllowed in class BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

onAfterRemove

protected void onAfterRemove(UserCustomField entity)

Description copied from class: CRUDServiceImpl

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

Overrides:

onAfterRemove in class CRUDServiceImpl<UserCustomField,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

onBeforeRemove

protected void onBeforeRemove(UserCustomField field)

Description copied from class: CRUDServiceImpl

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

Overrides:

onBeforeRemove in class CRUDServiceImpl<UserCustomField,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

onBeforeSave

protected Object onBeforeSave(UserCustomField field,
                              UserCustomField 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 BaseCustomFieldServiceImpl<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue,QUserCustomField,UserCustomFieldDTO,UserCustomFieldData,Void>

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