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
protected void	checkCreateNew(java.lang.Void param) Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
protected void	checkRun(CustomOperationVO customOperationVO, User user, BasicAd ad)
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	getRunData(CustomOperationVO customOperationVO, UserLocatorVO userVO, BasicAdVO adVO) Returns data to run a custom operation over an specific user or specific ad.
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<CustomOperationVO>	list() Lists all available custom operations
java.util.List<CustomOperationVO>	listSystemToRun() Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
java.util.List<CustomOperationVO>	listUserToRun(UserLocatorVO locator) Lists the user custom operations scope = CustomOperationScope.USER the logged user can run over the given user (or self if null)
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
CustomOperationContentResult	runForContent(RunCustomOperationDTO params, FileInfo inputFile) Runs a content page custom operation
FileInfo	runForCSV(RunCustomOperationDTO params, FileInfo inputFile) Runs a result page custom operation, returning the all in a CSV file
FileInfo	runForFile(RunCustomOperationDTO params, FileInfo inputFile) Runs a custom operation.
CustomOperationPageResult	runForPage(RunCustomOperationDTO params, FileInfo inputFile) Runs a result page custom operation
FileInfo	runForPDF(RunCustomOperationDTO params, FileInfo inputFile) Runs a result page custom operation, returning the page results in a PDF file
java.lang.String	runForString(RunCustomOperationDTO params, FileInfo inputFile) Runs a custom operation.

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

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>

getRunData

public RunCustomOperationData getRunData(CustomOperationVO customOperationVO,
                                         UserLocatorVO userVO,
                                         BasicAdVO adVO)
                                  throws FrameworkException

Description copied from interface: CustomOperationService

Returns data to run a custom operation over an specific user or specific ad. If the operation has CustomOperationScope.SYSTEM, user and ad must be null. if CustomOperationScope.USER, user must be passed in if CustomOperationScope.ADVERTISEMENT, ad must be passed in

Specified by:

getRunData 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<CustomOperationVO> list()
                                       throws FrameworkException

Description copied from interface: CustomOperationService

Lists all available custom operations

Specified by:

list in interface CustomOperationService

Throws:

FrameworkException

listSystemToRun

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

Description copied from interface: CustomOperationService

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

Specified by:

listSystemToRun in interface CustomOperationService

Throws:

FrameworkException

listUserToRun

public java.util.List<CustomOperationVO> listUserToRun(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:

listUserToRun 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

runForContent

public CustomOperationContentResult runForContent(RunCustomOperationDTO params,
                                                  FileInfo inputFile)
                                           throws FrameworkException

Description copied from interface: CustomOperationService

Runs a content page custom operation

Specified by:

runForContent in interface CustomOperationService

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not CustomOperationResultType.RESULT_PAGE

FrameworkException

runForCSV

public FileInfo runForCSV(RunCustomOperationDTO params,
                          FileInfo inputFile)
                   throws FrameworkException

Description copied from interface: CustomOperationService

Runs a result page custom operation, returning the all in a CSV file

Specified by:

runForCSV in interface CustomOperationService

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not CustomOperationResultType.RESULT_PAGE

FrameworkException

runForFile

public FileInfo runForFile(RunCustomOperationDTO params,
                           FileInfo inputFile)
                    throws FrameworkException

Description copied from interface: CustomOperationService

Runs a custom operation. This method only should be called if the operation's result type is a file download.

Specified by:

runForFile in interface CustomOperationService

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not CustomOperationResultType.FILE_DOWNLOAD

FrameworkException

runForPage

public CustomOperationPageResult runForPage(RunCustomOperationDTO params,
                                            FileInfo inputFile)
                                     throws FrameworkException

Description copied from interface: CustomOperationService

Runs a result page custom operation

Specified by:

runForPage in interface CustomOperationService

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not CustomOperationResultType.RESULT_PAGE

FrameworkException

runForPDF

public FileInfo runForPDF(RunCustomOperationDTO params,
                          FileInfo inputFile)
                   throws FrameworkException

Description copied from interface: CustomOperationService

Runs a result page custom operation, returning the page results in a PDF file

Specified by:

runForPDF in interface CustomOperationService

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not CustomOperationResultType.RESULT_PAGE

FrameworkException

runForString

public java.lang.String runForString(RunCustomOperationDTO params,
                                     FileInfo inputFile)
                              throws FrameworkException

Description copied from interface: CustomOperationService

Runs a custom operation. This method only should be called if the operation's result type is a string

Specified by:

runForString in interface CustomOperationService

Throws:

ValidationException - If the operation has system scope but an user id was informed, or if the operation didn't expect a file but one was uploaded

IllegalActionException - When the custom operation result type is not a string

FrameworkException

checkCreateNew

protected 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>

checkRun

protected void checkRun(CustomOperationVO customOperationVO,
                        User user,
                        BasicAd ad)

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>