org.cyclos.security.users

Class BulkActionServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.CRUDServiceSecurity<BulkActionDTO,BulkAction,BulkActionData,BulkActionDataParams>

org.cyclos.security.users.BulkActionServiceSecurity

All Implemented Interfaces:

CRUDService<BulkActionDTO,BulkActionData,BulkActionDataParams>, CRUDWithConfirmationPasswordService<BulkActionDTO,BulkActionData,BulkActionDataParams>, Service, BulkActionService

@Security
public class BulkActionServiceSecurity
extends CRUDServiceSecurity<BulkActionDTO,BulkAction,BulkActionData,BulkActionDataParams>
implements BulkActionService

Security layer for BulkActionService

Author:

luis

Field Summary

Fields inherited from class org.cyclos.security.CRUDServiceSecurity

entityClass

Constructor Summary

Constructors

Constructor and Description
BulkActionServiceSecurity()

Method Summary

Modifier and Type	Method and Description
int	cancel(java.lang.Long bulkActionId) Cancels a running bulk action, returning the number of users that were effectively canceled
boolean	canPerformOperation(BulkAction bulkAction, CRUDOperation operation) Bulk actions cannot be edited and need special permissions to run (create)
protected void	checkCreateNew(BulkActionDataParams params) Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
protected void	customizeData(BulkActionData data) Can be overridden in order to process the returned data object for the given entity
protected boolean	doHasManageAccess(BulkAction bulkAction) Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation
boolean	doHasViewAccess(BulkAction bulkAction) Should be implemented in order to return whether the caller is allowed to view the given entity.
java.lang.String	getErrorStackTrace(java.lang.Long bulkActionUserId) Returns the error stack trace for the given bulk action user.
protected CRUDServiceLocal<BulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>	getImplementation() Should be implemented in order to return the actual implementation of the service
BulkActionsSearchData	getSearchData() Returns data for searching bulk actions
BulkActionSearchUsersData	getSearchUsersData(BulkActionDataParams params) Returns data for searching users to run a bulk action over them
BulkActionStatusVO	getStatus(java.lang.Long id) Returns the current status of this bulk action counter of users for the bulk action with the given id
boolean	isAccessible(SessionData sessionData, BulkAction entity) Must be implemented in order to determine whether the given entity is accessible for the given session data.
Page<BulkActionVO>	search(BulkActionQuery params) Searches for already executed bulk actions
Page<BulkActionUserVO>	searchUsers(BulkActionUserQuery query) Searches for users affected by a bulk action

Methods inherited from class org.cyclos.security.CRUDServiceSecurity

canViewHistoryLog, checkManageAccess, checkOperation, checkViewAccess, find, getConfirmationPasswordInputForRemove, getData, getDataForNew, getEntityClass, hasManageAccess, hasViewAccess, load, onBeforeSave, remove, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveEntityCheck, save, saveWithConfirmationPassword

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getAccountHandler, getAuthHandler, getBaseEntityManagerHandler, getChannelConfiguration, getConfiguration, getConversionHandler, getCustomFieldValueHandler, getEntityManagerHandler, getGroupsHandler, getLoggedBasicUser, getLoggedUser, getProducts, getProductsHandler, getReportHandler, getTranslatedName, getTranslatedValue, getUserLocatorHandler, getValidationResult, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

delete, detach, find, flush, from, getApplicationContext, getConfigurationHandler, getDataTranslationHandler, getFormatter, getFormatter, getFormatter, getLogger, getNotificationHandler, getProfileFieldHandler, getRemoteAddress, getSessionData, getTransactionHandler, getTranslationHandler, message, message, persist, 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

Constructor Detail

BulkActionServiceSecurity

public BulkActionServiceSecurity()

Method Detail

cancel

public int cancel(java.lang.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

canPerformOperation

public boolean canPerformOperation(BulkAction bulkAction,
                                   CRUDOperation operation)

Bulk actions cannot be edited and need special permissions to run (create)

Overrides:

canPerformOperation in class CRUDServiceSecurity<BulkActionDTO,BulkAction,BulkActionData,BulkActionDataParams>

doHasViewAccess

public boolean doHasViewAccess(BulkAction bulkAction)

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return whether the caller is allowed to view the given entity.

Specified by:

doHasViewAccess in class CRUDServiceSecurity<BulkActionDTO,BulkAction,BulkActionData,BulkActionDataParams>

getErrorStackTrace

public java.lang.String getErrorStackTrace(java.lang.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()
                                    throws FrameworkException

Description copied from interface: BulkActionService

Returns data for searching bulk actions

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(java.lang.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

isAccessible

public boolean isAccessible(SessionData sessionData,
                            BulkAction entity)

Description copied from class: CRUDServiceSecurity

Must be implemented in order to determine whether the given entity is accessible for the given session data. This method shouldn't check the same condition as CRUDServiceSecurity.hasViewAccess(BaseEntity). If the only condition for an entity is CRUDServiceSecurity.hasViewAccess(BaseEntity), this method should return false.

Specified by:

isAccessible in class CRUDServiceSecurity<BulkActionDTO,BulkAction,BulkActionData,BulkActionDataParams>

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 query)
                                   throws FrameworkException

Description copied from interface: BulkActionService

Searches for users affected by a bulk action

Specified by:

searchUsers in interface BulkActionService

Throws:

FrameworkException

checkCreateNew

protected void checkCreateNew(BulkActionDataParams params)

Description copied from class: CRUDServiceSecurity

Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not

Specified by:

checkCreateNew in class CRUDServiceSecurity<BulkActionDTO,BulkAction,BulkActionData,BulkActionDataParams>

customizeData

protected void customizeData(BulkActionData data)

Description copied from class: CRUDServiceSecurity

Can be overridden in order to process the returned data object for the given entity

Overrides:

customizeData in class CRUDServiceSecurity<BulkActionDTO,BulkAction,BulkActionData,BulkActionDataParams>

doHasManageAccess

protected boolean doHasManageAccess(BulkAction bulkAction)

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation

Specified by:

doHasManageAccess in class CRUDServiceSecurity<BulkActionDTO,BulkAction,BulkActionData,BulkActionDataParams>

getImplementation

protected CRUDServiceLocal<BulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams> getImplementation()

Description copied from class: CRUDServiceSecurity

Should be implemented in order to return the actual implementation of the service

Specified by:

getImplementation in class CRUDServiceSecurity<BulkActionDTO,BulkAction,BulkActionData,BulkActionDataParams>