Package org.cyclos.impl.users

Class UserEntityLogHandlerImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseNetworkedHandlerImpl

org.cyclos.impl.system.BaseEntityLogHandlerImpl<User,UserDTO>

org.cyclos.impl.users.UserEntityLogHandlerImpl

All Implemented Interfaces:

EntityLogHandler<User,UserDTO>

@Component
public class UserEntityLogHandlerImpl
extends BaseEntityLogHandlerImpl<User,UserDTO>

Handler for Users entity logs.

Field Summary

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

$, el, MASKED_VALUE

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
UserEntityLogHandlerImpl()

Method Summary

Modifier and Type	Method	Description
Set<EntityLogType>	doApplyLogFilters(DBQuery<?> query, long userId)	Subclasses can implement this method to add specific filters to the query when searching for logs of an entity.
Class<User>	getEntityClass()	The entity class related to this handler
String	getEntityLogName(User oldEntity, User newEntity, EntityLogEvent event)	Return the name of the entity log being generated.
protected User	getEntityToViewLog(long entityId)	Returns the entity with the given id ONLY if the logged user can view its logs.
protected BasicUser	getRelatedUser(User entity)	Subclasses can implement this method to return the related user of the entity Returns the associated user to the given entity.
EntityLogType	getType()	The log type this handler manages.
EntityLogDescriptor<? extends UserDTO>	resolveLogDescriptor(User user)	Return the descriptor with the mappings for each DTO property.

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

applyLogFilters, areEquals, canViewEntityLog, createEntityPropertyLog, customLogForCreation, doOnBeforeLog, getValues, isLogEnabled, onBeforeLog

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

Constructor Detail

UserEntityLogHandlerImpl

public UserEntityLogHandlerImpl()

Method Detail

doApplyLogFilters

public Set<EntityLogType> doApplyLogFilters(DBQuery<?> query,
                                            long userId)

Description copied from class: BaseEntityLogHandlerImpl

Subclasses can implement this method to add specific filters to the query when searching for logs of an entity. Also, if other log types must be included in the query result then they must be returned.

Overrides:

doApplyLogFilters in class BaseEntityLogHandlerImpl<User,UserDTO>

Parameters:

query - the query to add the filters

userId - the id of the entity for which we're searching its logs

Returns:

the list of other types that must be included in the result (e.g for users we include the addresses and phones logs). Null/empty means no other types are included.

getEntityClass

public Class<User> getEntityClass()

Description copied from interface: EntityLogHandler

The entity class related to this handler

getEntityLogName

public String getEntityLogName(User oldEntity,
                               User newEntity,
                               EntityLogEvent event)

Description copied from interface: EntityLogHandler

Return the name of the entity log being generated.

Specified by:

getEntityLogName in interface EntityLogHandler<User,UserDTO>

Overrides:

getEntityLogName in class BaseEntityLogHandlerImpl<User,UserDTO>

getType

public EntityLogType getType()

Description copied from interface: EntityLogHandler

The log type this handler manages.

resolveLogDescriptor

public EntityLogDescriptor<? extends UserDTO> resolveLogDescriptor(User user)

Description copied from interface: EntityLogHandler

Return the descriptor with the mappings for each DTO property.

getEntityToViewLog

protected User getEntityToViewLog(long entityId)

Description copied from class: BaseEntityLogHandlerImpl

Returns the entity with the given id ONLY if the logged user can view its logs. Otherwise it MUST return null.

Specified by:

getEntityToViewLog in class BaseEntityLogHandlerImpl<User,UserDTO>

getRelatedUser

protected BasicUser getRelatedUser(User entity)

Description copied from class: BaseEntityLogHandlerImpl

Subclasses can implement this method to return the related user of the entity Returns the associated user to the given entity.

Overrides:

getRelatedUser in class BaseEntityLogHandlerImpl<User,UserDTO>