org.cyclos.security.marketplace

Class AdServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.CRUDServiceSecurity<BasicAdDTO,BasicAd,AdDetailsData,AdDataParams>

org.cyclos.security.marketplace.AdServiceSecurity

All Implemented Interfaces:

CRUDService<BasicAdDTO,AdDetailsData,AdDataParams>, CRUDWithConfirmationPasswordService<BasicAdDTO,AdDetailsData,AdDataParams>, AdService, Service

@Security
public class AdServiceSecurity
extends CRUDServiceSecurity<BasicAdDTO,BasicAd,AdDetailsData,AdDataParams>
implements AdService

Security implementation for AdService

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

Fields inherited from class org.cyclos.impl.AbstractServerComponent

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

Constructor Summary

Constructors

Constructor and Description
AdServiceSecurity()

Method Summary

Modifier and Type	Method and Description
void	approve(@NotNull BasicAdVO adVO) Approves the publication of an advertisement in status AdStatus.PENDING.
protected boolean	canCreateNew(boolean isSimpleAd, User user)
boolean	canPerformOperation(BasicAd entity, CRUDOperation operation) Returns whether the logged user can perform the given operation over the given entity
protected void	checkApproveOrReject(BasicAdVO adVO)
protected void	checkCreateNew(AdDataParams params) Checks whether creating new entities with the given context parameters is allowed, throwing PermissionDeniedException if not
protected void	customizeData(AdDetailsData data) Can be overridden in order to process the returned data object for the given entity
boolean	doHasManageAccess(BasicAd ad) Should be implemented in order to return whether the caller is allowed to manage the given entity, for the given operation
boolean	doHasViewAccess(BasicAd ad) Should be implemented in order to return whether the caller is allowed to view the given entity.
FileInfo	exportAd(ExportFormatVO format, BasicAdVO adVO) Exports the given advertisement to file
AdSearchData	getAdSearchData(AdType type, boolean overBrokeredUsers) Returns data for searching advertisements
protected AdServiceLocal	getImplementation() Should be implemented in order to return the actual implementation of the service
UserAdsSearchData	getUserAdsSearchData(UserLocatorVO locator, AdType type) Returns data for searching advertisements
AdViewData	getViewData(BasicAdVO adVO) Returns data for viewing details of an advertisement
boolean	isAccessible(SessionData sessionData, BasicAd entity) Must be implemented in order to determine whether the given entity is accessible for the given session data.
BasicAdVO	loadVO(BasicAdVO adVO) Loads a VO, by id
void	reject(@NotNull BasicAdVO adVO, java.lang.String comments) Rejects the publication of an advertisement in status AdStatus.PENDING.
Page<BasicAdVO>	search(BasicAdQuery params) Searches for advertisements, according to the given query parameters
void	setAsDraft(BasicAdVO adVO, java.lang.String comments) Sets the ad back to draft status.
void	setHidden(BasicAdVO adVO, boolean hidden) Hides or unhides the ad according to given hidden parameter.
void	submitForAuthorization(@NotNull BasicAdVO adVO) Submits the given ad for authorization.

Methods inherited from class org.cyclos.security.CRUDServiceSecurity

canViewData, checkManageAccess, checkOperation, checkSave, 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, checkScope, 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

AdServiceSecurity

public AdServiceSecurity()

Method Detail

approve

public void approve(@NotNull
                    @NotNull BasicAdVO adVO)
             throws FrameworkException

Description copied from interface: AdService

Approves the publication of an advertisement in status AdStatus.PENDING. The new status will be AdStatus.ACTIVE.

Specified by:

approve in interface AdService

Throws:

FrameworkException

canPerformOperation

public boolean canPerformOperation(BasicAd entity,
                                   CRUDOperation operation)

Description copied from class: CRUDServiceSecurity

Returns whether the logged user can perform the given operation over the given entity

Overrides:

canPerformOperation in class CRUDServiceSecurity<BasicAdDTO,BasicAd,AdDetailsData,AdDataParams>

doHasManageAccess

public boolean doHasManageAccess(BasicAd ad)

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<BasicAdDTO,BasicAd,AdDetailsData,AdDataParams>

doHasViewAccess

public boolean doHasViewAccess(BasicAd ad)

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<BasicAdDTO,BasicAd,AdDetailsData,AdDataParams>

exportAd

public FileInfo exportAd(ExportFormatVO format,
                         BasicAdVO adVO)
                  throws FrameworkException

Description copied from interface: AdService

Exports the given advertisement to file

Specified by:

exportAd in interface AdService

Throws:

FrameworkException

getAdSearchData

public AdSearchData getAdSearchData(AdType type,
                                    boolean overBrokeredUsers)

Description copied from interface: AdService

Returns data for searching advertisements

Specified by:

getAdSearchData in interface AdService

getUserAdsSearchData

public UserAdsSearchData getUserAdsSearchData(UserLocatorVO locator,
                                              AdType type)

Description copied from interface: AdService

Returns data for searching advertisements

Specified by:

getUserAdsSearchData in interface AdService

getViewData

public AdViewData getViewData(BasicAdVO adVO)
                       throws EntityNotFoundException

Description copied from interface: AdService

Returns data for viewing details of an advertisement

Specified by:

getViewData in interface AdService

Throws:

EntityNotFoundException

isAccessible

public boolean isAccessible(SessionData sessionData,
                            BasicAd 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<BasicAdDTO,BasicAd,AdDetailsData,AdDataParams>

loadVO

public BasicAdVO loadVO(BasicAdVO adVO)
                 throws FrameworkException

Description copied from interface: AdService

Loads a VO, by id

Specified by:

loadVO in interface AdService

Throws:

FrameworkException

reject

public void reject(@NotNull
                   @NotNull BasicAdVO adVO,
                   java.lang.String comments)
            throws FrameworkException

Description copied from interface: AdService

Rejects the publication of an advertisement in status AdStatus.PENDING. The new status will be AdStatus.DRAFT.

Specified by:

reject in interface AdService

Throws:

FrameworkException

search

public Page<BasicAdVO> search(BasicAdQuery params)

Description copied from interface: AdService

Searches for advertisements, according to the given query parameters

Specified by:

search in interface AdService

setAsDraft

public void setAsDraft(BasicAdVO adVO,
                       java.lang.String comments)

Description copied from interface: AdService

Sets the ad back to draft status.

Specified by:

setAsDraft in interface AdService

setHidden

public void setHidden(BasicAdVO adVO,
                      boolean hidden)

Description copied from interface: AdService

Hides or unhides the ad according to given hidden parameter.

Specified by:

setHidden in interface AdService

submitForAuthorization

public void submitForAuthorization(@NotNull
                                   @NotNull BasicAdVO adVO)

Description copied from interface: AdService

Submits the given ad for authorization. Only available if the logged user can manage the given ad and in case it isn't the owner it can't manage pending ads. NOTE: The main web doesn't use this method instead it saves the ad with the AdStatus.PENDING status. This is used only by the REST services but we should refactor the marketplace module too to use actions instead of save the ad each time the status changes.

Specified by:

submitForAuthorization in interface AdService

canCreateNew

protected boolean canCreateNew(boolean isSimpleAd,
                               User user)

checkApproveOrReject

protected void checkApproveOrReject(BasicAdVO adVO)

checkCreateNew

protected void checkCreateNew(AdDataParams 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<BasicAdDTO,BasicAd,AdDetailsData,AdDataParams>

customizeData

protected void customizeData(AdDetailsData 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<BasicAdDTO,BasicAd,AdDetailsData,AdDataParams>

getImplementation

protected AdServiceLocal 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<BasicAdDTO,BasicAd,AdDetailsData,AdDataParams>