Package org.cyclos.impl.users

Class BulkActionServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

org.cyclos.impl.users.BulkActionServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<BulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>, BulkActionServiceLocal, CRUDService<BulkActionDTO,BulkActionData,BulkActionDataParams>, CRUDWithConfirmationPasswordService<BulkActionDTO,BulkActionData,BulkActionDataParams>, Service, BulkActionService

@Service
public class BulkActionServiceImpl
extends CRUDServiceImpl<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>
implements BulkActionServiceLocal

Service implementation for BulkActionService

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

Constructor Summary

Constructors

Constructor	Description
BulkActionServiceImpl()

Method Summary

Modifier and Type	Method	Description
long	archive(long id)	Archives the given bulk action, returning the number of relations to users removed
int	cancel(Long bulkActionId)	Cancels a running bulk action, returning the number of users that were effectively canceled
protected BulkActionData	getData(BulkAction bulkAction)	Returns details data for the given entity
String	getErrorStackTrace(Long bulkActionUserId)	Returns the error stack trace for the given bulk action user.
protected Object[]	getExcludedPropertiesToEntity(BulkActionDTO dto)	May be overridden in order to exclude properties when converting the given DTO to entity
BulkActionsSearchData	getSearchData(BulkActionUsage usage)	Returns data for searching bulk actions for a given usage
BulkActionSearchUsersData	getSearchUsersData(BulkActionDataParams params)	Returns data for searching users to run a bulk action over them
BulkActionStatusVO	getStatus(Long id)	Returns the current status of this bulk action counter of users for the bulk action with the given id
void	initialize()
void	markFinished(BulkAction bulkAction)	Marks the given BulkAction as finished
BulkAction	newEntity(BulkActionDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(BulkAction bulkAction, BulkAction currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(BulkAction bulkAction, BulkAction currentCopy)	May be overridden in order to perform custom logic before saving an entity.
BulkActionUserResult	process(TransactionStatus tx, BulkActionUser bulkActionUser)
boolean	processNext(Long id)	Processes the next user of the bulk action with the given id, returning whether there are more users to process or not.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Validator	resolveValidator(BulkActionDTO dto)
Page<BulkActionVO>	search(BulkActionQuery params)	Searches for already executed bulk actions
Page<BulkActionUserVO>	searchUsers(BulkActionUserQuery params)	Searches for users affected by a bulk action
protected org.apache.commons.collections4.BidiMap<Class<? extends BulkAction>,Class<? extends BulkActionDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.
BulkActionDTO	toDTO(BulkAction bulkAction)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses
BulkAction	toEntity(BulkActionDTO dto)	Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, onBeforeRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, 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, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, 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, validate

Constructor Detail

BulkActionServiceImpl

public BulkActionServiceImpl()

Method Detail

archive

public long archive(long id)

Description copied from interface: BulkActionServiceLocal

Archives the given bulk action, returning the number of relations to users removed

Specified by:

archive in interface BulkActionServiceLocal

cancel

public int cancel(Long bulkActionId)
           throws FrameworkException

Description copied from interface: BulkActionService

Cancels a running bulk action, returning the number of users that were effectively canceled

Specified by:

cancel in interface BulkActionService

Throws:

FrameworkException

getErrorStackTrace

public String getErrorStackTrace(Long bulkActionUserId)
                          throws FrameworkException

Description copied from interface: BulkActionService

Returns the error stack trace for the given bulk action user. If there is no error, returns null.

Specified by:

getErrorStackTrace in interface BulkActionService

Throws:

FrameworkException

getSearchData

public BulkActionsSearchData getSearchData(BulkActionUsage usage)
                                    throws FrameworkException

Description copied from interface: BulkActionService

Returns data for searching bulk actions for a given usage

Specified by:

getSearchData in interface BulkActionService

Throws:

FrameworkException

getSearchUsersData

public BulkActionSearchUsersData getSearchUsersData(BulkActionDataParams params)
                                             throws FrameworkException

Description copied from interface: BulkActionService

Returns data for searching users to run a bulk action over them

Specified by:

getSearchUsersData in interface BulkActionService

Throws:

FrameworkException

getStatus

public BulkActionStatusVO getStatus(Long id)
                             throws FrameworkException

Description copied from interface: BulkActionService

Returns the current status of this bulk action counter of users for the bulk action with the given id

Specified by:

getStatus in interface BulkActionService

Throws:

FrameworkException

initialize

@PostConstruct
public void initialize()

markFinished

public void markFinished(BulkAction bulkAction)

Description copied from interface: BulkActionServiceLocal

Marks the given BulkAction as finished

Specified by:

markFinished in interface BulkActionServiceLocal

newEntity

public BulkAction newEntity(BulkActionDataParams 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<BulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

Specified by:

newEntity in class CRUDServiceImpl<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

process

public BulkActionUserResult process(TransactionStatus tx,
                                    BulkActionUser bulkActionUser)

processNext

public boolean processNext(Long id)

Description copied from interface: BulkActionServiceLocal

Processes the next user of the bulk action with the given id, returning whether there are more users to process or not. Assumes there is no current transaction, as it will need 1 or 2 transactions to run: one to execute and another one if there's an error

Specified by:

processNext in interface BulkActionServiceLocal

search

public Page<BulkActionVO> search(BulkActionQuery params)
                          throws FrameworkException

Description copied from interface: BulkActionService

Searches for already executed bulk actions

Specified by:

search in interface BulkActionService

Throws:

FrameworkException

searchUsers

public Page<BulkActionUserVO> searchUsers(BulkActionUserQuery params)
                                   throws FrameworkException

Description copied from interface: BulkActionService

Searches for users affected by a bulk action

Specified by:

searchUsers in interface BulkActionService

Throws:

FrameworkException

toDTO

public BulkActionDTO toDTO(BulkAction bulkAction)

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<BulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

Overrides:

toDTO in class CRUDServiceImpl<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

toEntity

public BulkAction toEntity(BulkActionDTO 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<BulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

Overrides:

toEntity in class CRUDServiceImpl<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

getData

protected BulkActionData getData(BulkAction bulkAction)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

getExcludedPropertiesToEntity

protected Object[] getExcludedPropertiesToEntity(BulkActionDTO 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<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

onAfterSave

protected void onAfterSave(BulkAction bulkAction,
                           BulkAction 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<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

onBeforeSave

protected Object onBeforeSave(BulkAction bulkAction,
                              BulkAction 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<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

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

resolveValidator

protected Validator resolveValidator(BulkActionDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends BulkAction>,Class<? extends BulkActionDTO>> subClassMappings()

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which handle entity / dto hierarchies. The map key should be the entity class, while the map value, the DTO class

Overrides:

subClassMappings in class CRUDServiceImpl<BulkAction,QBulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>