org.cyclos.security.system

Class CustomOperationServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.CRUDServiceSecurity<CustomOperationDTO,CustomOperation,CustomOperationData,java.lang.Void>

org.cyclos.security.system.CustomOperationServiceSecurity

All Implemented Interfaces:

CRUDService<CustomOperationDTO,CustomOperationData,java.lang.Void>, CRUDWithConfirmationPasswordService<CustomOperationDTO,CustomOperationData,java.lang.Void>, Service, CustomOperationService

@Security
public class CustomOperationServiceSecurity
extends CRUDServiceSecurity<CustomOperationDTO,CustomOperation,CustomOperationData,java.lang.Void>
implements CustomOperationService

Security layer for CustomOperation

Author:

luis

Field Summary

Fields inherited from class org.cyclos.security.CRUDServiceSecurity

entityClass

Constructor Summary

Constructors

Constructor and Description
CustomOperationServiceSecurity()

Method Summary

Modifier and Type	Method and Description
boolean	canManage()
boolean	canView()
void	checkCreateNew(java.lang.Void param) Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
protected CustomOperation	checkRun(CustomOperationVO customOperationVO, User user, BasicAd ad, Record record)
protected boolean	doHasManageAccess(CustomOperation entity) Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation
boolean	doHasViewAccess(CustomOperation entity) Should be implemented in order to return whether the caller is allowed to view the given entity.
protected CRUDServiceLocal<CustomOperation,CustomOperationDTO,CustomOperationData,java.lang.Void>	getImplementation() Should be implemented in order to return the actual implementation of the service
RunCustomOperationData	getRunAdData(CustomOperationVO customOperation, BasicAdVO adVO) Returns data to run a custom operation over an specific ad.
RunCustomOperationData	getRunData(CustomOperationVO customOperation) Returns data to run a custom operation with one of the following scopes: CustomOperationScope.SYSTEM CustomOperationScope.INTERNAL CustomOperationScope.MENU
java.util.List<CustomOperationVO>	getRunnableOperationsForAd(BasicAdVO ad) Lists the user custom operations scope = CustomOperationScope.ADVERTISEMENT the logged user can run over the given advertisement
java.util.List<CustomOperationVO>	getRunnableOperationsForRecord(RecordVO record) Lists the user custom operations scope = CustomOperationScope.RECORD the logged user can run over the given record
java.util.List<CustomOperationVO>	getRunnableOperationsForSystem() Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
java.util.List<CustomOperationVO>	getRunnableOperationsForUser(UserLocatorVO locator) Lists the user custom operations scope = CustomOperationScope.USER the logged user can run over the given user (or self if null)
RunCustomOperationData	getRunRecordData(CustomOperationVO customOperation, RecordVO recordVO) Returns data to run a custom operation over an specific record.
RunCustomOperationData	getRunUserData(CustomOperationVO customOperation, UserLocatorVO userLocatorVO) Returns data to run a custom operation over an specific user.
boolean	isAccessible(SessionData sessionData, CustomOperation entity) Must be implemented in order to determine whether the given entity is accessible for the given session data.
java.util.List<CustomOperationResultVO>	list() Lists all available custom operations
RunCustomOperationResult	run(RunCustomOperationDTO params) Runs a custom operation, returning the result with all type information
java.lang.String	runExternalRedirectCallback(RunExternalRedirectCallbackParams params) Runs the callback for a custom operation of type external redirect
void	saveOrder(java.util.List<java.lang.Long> ids) Saves the order according to the given operation ids

Methods inherited from class org.cyclos.security.CRUDServiceSecurity

canPerformOperation, canViewHistoryLog, checkManageAccess, checkOperation, checkViewAccess, customizeData, 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, isMemberOnly, 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, mailContentBuilder, 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

CustomOperationServiceSecurity

public CustomOperationServiceSecurity()

Method Detail

canManage

public boolean canManage()

canView

public boolean canView()

checkCreateNew

public void checkCreateNew(java.lang.Void param)

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<CustomOperationDTO,CustomOperation,CustomOperationData,java.lang.Void>

doHasViewAccess

public boolean doHasViewAccess(CustomOperation entity)

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<CustomOperationDTO,CustomOperation,CustomOperationData,java.lang.Void>

getRunAdData

public RunCustomOperationData getRunAdData(CustomOperationVO customOperation,
                                           BasicAdVO adVO)
                                    throws FrameworkException

Description copied from interface: CustomOperationService

Returns data to run a custom operation over an specific ad. The scope of the custom operation must be CustomOperationScope.ADVERTISEMENT

Specified by:

getRunAdData in interface CustomOperationService

Throws:

FrameworkException

getRunData

public RunCustomOperationData getRunData(CustomOperationVO customOperation)
                                  throws FrameworkException

Description copied from interface: CustomOperationService

Returns data to run a custom operation with one of the following scopes:

CustomOperationScope.SYSTEM CustomOperationScope.INTERNAL CustomOperationScope.MENU

Specified by:

getRunData in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForAd

public java.util.List<CustomOperationVO> getRunnableOperationsForAd(BasicAdVO ad)
                                                             throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.ADVERTISEMENT the logged user can run over the given advertisement

Specified by:

getRunnableOperationsForAd in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForRecord

public java.util.List<CustomOperationVO> getRunnableOperationsForRecord(RecordVO record)
                                                                 throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.RECORD the logged user can run over the given record

Specified by:

getRunnableOperationsForRecord in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForSystem

public java.util.List<CustomOperationVO> getRunnableOperationsForSystem()
                                                                 throws FrameworkException

Description copied from interface: CustomOperationService

Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run

Specified by:

getRunnableOperationsForSystem in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForUser

public java.util.List<CustomOperationVO> getRunnableOperationsForUser(UserLocatorVO locator)
                                                               throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.USER the logged user can run over the given user (or self if null)

Specified by:

getRunnableOperationsForUser in interface CustomOperationService

Throws:

FrameworkException

getRunRecordData

public RunCustomOperationData getRunRecordData(CustomOperationVO customOperation,
                                               RecordVO recordVO)
                                        throws FrameworkException

Description copied from interface: CustomOperationService

Returns data to run a custom operation over an specific record. The scope of the custom operation must be CustomOperationScope.RECORD

Specified by:

getRunRecordData in interface CustomOperationService

Throws:

FrameworkException

getRunUserData

public RunCustomOperationData getRunUserData(CustomOperationVO customOperation,
                                             UserLocatorVO userLocatorVO)
                                      throws FrameworkException

Description copied from interface: CustomOperationService

Returns data to run a custom operation over an specific user. The scope of the custom operation must be CustomOperationScope.USER

Specified by:

getRunUserData in interface CustomOperationService

Throws:

FrameworkException

isAccessible

public boolean isAccessible(SessionData sessionData,
                            CustomOperation 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<CustomOperationDTO,CustomOperation,CustomOperationData,java.lang.Void>

list

public java.util.List<CustomOperationResultVO> list()
                                             throws FrameworkException

Description copied from interface: CustomOperationService

Lists all available custom operations

Specified by:

list in interface CustomOperationService

Throws:

FrameworkException

run

public RunCustomOperationResult run(RunCustomOperationDTO params)
                             throws FrameworkException

Description copied from interface: CustomOperationService

Runs a custom operation, returning the result with all type information

Specified by:

run in interface CustomOperationService

Throws:

FrameworkException

runExternalRedirectCallback

public java.lang.String runExternalRedirectCallback(RunExternalRedirectCallbackParams params)
                                             throws FrameworkException

Description copied from interface: CustomOperationService

Runs the callback for a custom operation of type external redirect

Specified by:

runExternalRedirectCallback in interface CustomOperationService

Throws:

FrameworkException

saveOrder

public void saveOrder(java.util.List<java.lang.Long> ids)

Description copied from interface: CustomOperationService

Saves the order according to the given operation ids

Specified by:

saveOrder in interface CustomOperationService

checkRun

protected CustomOperation checkRun(CustomOperationVO customOperationVO,
                                   User user,
                                   BasicAd ad,
                                   Record record)

doHasManageAccess

protected boolean doHasManageAccess(CustomOperation entity)

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<CustomOperationDTO,CustomOperation,CustomOperationData,java.lang.Void>

getImplementation

protected CRUDServiceLocal<CustomOperation,CustomOperationDTO,CustomOperationData,java.lang.Void> 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<CustomOperationDTO,CustomOperation,CustomOperationData,java.lang.Void>