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

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, reportHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

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, SimpleEntity entity)
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.
PasswordInputDTO	getConfirmationPasswordInputForRun(RunCustomOperationDataParams params) Returns the PasswordInputDTO for the confirmation password that would be required if executing the given custom operation.
protected CRUDServiceLocal<CustomOperation,CustomOperationDTO,CustomOperationData,java.lang.Void>	getImplementation() Should be implemented in order to return the actual implementation of the service
RunCustomOperationData	getRunData(RunCustomOperationDataParams params) Returns data to run a custom operation.
java.util.List<RunnableCustomOperationVO>	getRunnableOperationsForAd(BasicAdVO ad) Lists the user custom operations scope = CustomOperationScope.ADVERTISEMENT the logged user can run over the given advertisement
java.util.List<RunnableCustomOperationVO>	getRunnableOperationsForContact(ContactVO contact) Lists the user custom operations scope = CustomOperationScope.CONTACT the logged user can run over the given contact
java.util.List<RunnableCustomOperationVO>	getRunnableOperationsForContactInfo(ContactInfoVO contactInfo) Lists the user custom operations scope = CustomOperationScope.CONTACT_INFO the logged user can run over the given additional contact information
java.util.List<RunnableCustomOperationVO>	getRunnableOperationsForRecord(RecordVO record) Lists the user custom operations scope = CustomOperationScope.RECORD the logged user can run over the given record
java.util.List<RunnableCustomOperationVO>	getRunnableOperationsForSystem() Lists the custom operations with scope = CustomOperationScope.SYSTEM the logged user can run
java.util.List<RunnableCustomOperationVO>	getRunnableOperationsForTransfer(TransferVO transfer) Lists the custom operations with scope = CustomOperationScope.TRANSFER the logged user can run over the given transfer
java.util.List<RunnableCustomOperationVO>	getRunnableOperationsForUser(UserLocatorVO locator) Lists the user custom operations scope = CustomOperationScope.USER the logged user can run over the given user (or self if null)
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
RunCustomOperationResult	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, canViewData, 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, 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

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

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>

getConfirmationPasswordInputForRun

public PasswordInputDTO getConfirmationPasswordInputForRun(RunCustomOperationDataParams params)

Description copied from interface: CustomOperationService

Returns the PasswordInputDTO for the confirmation password that would be required if executing the given custom operation.

Specified by:

getConfirmationPasswordInputForRun in interface CustomOperationService

getRunData

public RunCustomOperationData getRunData(RunCustomOperationDataParams params)
                                  throws FrameworkException

Description copied from interface: CustomOperationService

Returns data to run a custom operation. Depending on the custom operation scope, the input parameters must be a subclass of RunCustomOperationDataParams with the specific parmeters set (for example, a RunRecordCustomOperationDataParams with the record set if the scope is CustomOperationScope.RECORD) The result will also be a subclass of RunCustomOperationData depending on the custom operation scope, for example a RunRecordCustomOperationData.

Specified by:

getRunData in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForAd

public java.util.List<RunnableCustomOperationVO> 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

getRunnableOperationsForContact

public java.util.List<RunnableCustomOperationVO> getRunnableOperationsForContact(ContactVO contact)
                                                                          throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.CONTACT the logged user can run over the given contact

Specified by:

getRunnableOperationsForContact in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForContactInfo

public java.util.List<RunnableCustomOperationVO> getRunnableOperationsForContactInfo(ContactInfoVO contactInfo)
                                                                              throws FrameworkException

Description copied from interface: CustomOperationService

Lists the user custom operations scope = CustomOperationScope.CONTACT_INFO the logged user can run over the given additional contact information

Specified by:

getRunnableOperationsForContactInfo in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForRecord

public java.util.List<RunnableCustomOperationVO> 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<RunnableCustomOperationVO> 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

getRunnableOperationsForTransfer

public java.util.List<RunnableCustomOperationVO> getRunnableOperationsForTransfer(TransferVO transfer)
                                                                           throws FrameworkException

Description copied from interface: CustomOperationService

Lists the custom operations with scope = CustomOperationScope.TRANSFER the logged user can run over the given transfer

Specified by:

getRunnableOperationsForTransfer in interface CustomOperationService

Throws:

FrameworkException

getRunnableOperationsForUser

public java.util.List<RunnableCustomOperationVO> 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

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 RunCustomOperationResult runExternalRedirectCallback(RunExternalRedirectCallbackParams params)
                                                     throws FrameworkException

Description copied from interface: CustomOperationService

Runs the callback for a custom operation of type external redirect. The result is currently always sent with result type = CustomOperationResultType.NOTIFICATION.

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,
                                   SimpleEntity entity)

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>