Package org.cyclos.impl.marketplace

Class AdServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

org.cyclos.impl.marketplace.AdServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<BasicAd,BasicAdDTO,AdDetailsData,AdDataParams>, AdServiceLocal, CRUDService<BasicAdDTO,AdDetailsData,AdDataParams>, CRUDWithConfirmationPasswordService<BasicAdDTO,AdDetailsData,AdDataParams>, AdService, Service

@Service
public class AdServiceImpl
extends CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>
implements AdServiceLocal

Service implementation class for Advertisements

Field Summary

Fields

Modifier and Type	Field	Description
protected AdAddressServiceLocal	adAddressService
protected AdCategoryServiceLocal	adCategoryService
protected AdCustomFieldServiceLocal	adCustomFieldService
protected AdDeliveryMethodServiceLocal	adDeliveryMethodService
protected UserAddressServiceLocal	addressService
protected AdImageServiceLocal	adImageService
protected AdInterestServiceLocal	adInterestService
protected AdQuestionServiceLocal	adQuestionService
protected AdWebShopSettingServiceLocal	adWebShopSettingService
protected CurrencyServiceLocal	currencyService
protected CustomFieldValueHandler	customFieldValueService
protected CustomOperationServiceLocal	customOperationService
protected EntityLogServiceLocal	entityLogService
protected ExportFormatServiceLocal	exportFormatService
protected MessageCategoryServiceLocal	messageCategoryService
protected MessageServiceLocal	messageService
protected UserCustomFieldServiceLocal	userCustomFieldService
protected UserServiceLocal	userService

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

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

Fields inherited from interface org.cyclos.impl.marketplace.AdServiceLocal

ATTR_AD_TYPE, ATTR_USER

Constructor Summary

Constructors

Constructor	Description
AdServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addCustomNameValidations(Property name, BasicAdDTO namedDTO)	This method may be overridden to add custom validations for the NAME property.
boolean	adRequiresAuthorization(BasicAd ad)	Returns true if the ad requires authorization for publishing.
void	approve(@NotNull BasicAdVO adVO)	Approves the publication of an advertisement in status AdStatus.PENDING.
boolean	canViewAddresses(User adOwner)	Returns if the given ad owner or a user manager can view addresses in an ad
boolean	canViewAuthorizationNotes(BasicAd ad)	Returns true if the logged user can view the authorization notes of the given ad
boolean	canViewPendings(AdType adType, User owner, boolean brokeredSearch)	Returns true if the logged user can view pending ads with the given restrictions
void	checkStatus(boolean guest, boolean ownAds, BasicAdQuery params, User owner)	Check the statuses in the query params according to the relationship between the logged user and the ad owner.
int	disableInCurrencies(User user, Collection<Currency> currencies)	Disables all the ads for the given user which are related to the given currencies
protected void	doRemove(BasicAd ad, boolean flush)	May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well
FileInfo	exportAd(ExportFormatVO formatVO, BasicAdVO adVO)	Exports the given advertisement to file
AdWebShop	findByOwnerAndNumber(User user, String adNumber)	Returns an AdWebShop by product owner and number, or throws EntityNotFoundException if not found
AdSearchData	getAdSearchData(AdType type, boolean overBrokeredUsers)	Returns data for searching advertisements
Integer	getAdvertisementsCount(User owner, AdType type)	Counts the number of ads filtering by status, for more details about the filters see AdServiceLocal.checkStatus(boolean, boolean, BasicAdQuery, User)}
Set<AdCategoryVO>	getCategories(Long adId)	Returns the categories for the given Ad id
protected AdDetailsData	getData(BasicAd ad)	Returns details data for the given entity
protected String	getNameLabel(BasicAdDTO dto)
protected Pair<DBQuery<?>,String>	getUniqueNameQuery(BasicAdDTO dto)	This method may be overridden to customize the default global unique validation for the name property.
UserAdsSearchData	getUserAdsSearchData(UserLocatorVO locator, AdType type)	Returns data for searching advertisements
AdViewData	getViewData(BasicAdVO adVO)	Returns data for viewing details of an advertisement
boolean	hasManageAccess(Date deletedDate, AdStatus status, AdStatus persistedStatus, AdType type, User owner)	Returns true if the logged user has manage access to the ad with the given conditions
boolean	hasManageAccess(BasicAd ad)	Returns true if the logged user has manage access for the given ad.
boolean	hasManageAccess(AdType type, User owner)	Returns true if the logged user can manage ads of the given type and user.
List<SitemapItemVO>	listForSitemap()	Returns the sitemap entries for all enabled advertisements in this network
BasicAdVO	loadVO(BasicAdVO adVO)	Loads a VO, by id
BasicAd	newEntity(AdDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(BasicAd ad, BasicAd currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(BasicAd ad, BasicAd currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	preProcessCurrentCopy(BasicAdDTO dto, BasicAd currentCopy)	This method is invoked before saving the entity and also, if the log is enabled, before removing.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	reject(@NotNull BasicAdVO adVO, String comments)	Rejects the publication of an advertisement in status AdStatus.PENDING.
void	removeAll(User user)	Removes all the advertisements for the given user
protected ExtensionPointAccessor	resolveExtensionPointAccessor(CRUDOperation operation, BasicAd ad)	Should be overridden by subclasses which have extension points
protected Validator	resolveValidator(BasicAdDTO dto)
Page<BasicAdVO>	search(BasicAdQuery params)	Searches for advertisements, according to the given query parameters
void	setAsDraft(BasicAdVO adVO, 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.
protected org.apache.commons.collections4.BidiMap<Class<? extends BasicAd>,Class<? extends BasicAdDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.
void	submitForAuthorization(@NotNull BasicAdVO adVO)	Submits the given ad for authorization.
BasicAdDTO	toDTO(BasicAd entity)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, checkConfirmationPassword, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getUniqueInternalNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, onBeforeRemove, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

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

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

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toEntity, validate

Field Detail

customFieldValueService

@Autowired
protected CustomFieldValueHandler customFieldValueService

customOperationService

@Autowired
protected CustomOperationServiceLocal customOperationService

adInterestService

@Autowired
protected AdInterestServiceLocal adInterestService

messageService

@Autowired
protected MessageServiceLocal messageService

messageCategoryService

@Autowired
protected MessageCategoryServiceLocal messageCategoryService

currencyService

@Autowired
protected CurrencyServiceLocal currencyService

adImageService

@Autowired
protected AdImageServiceLocal adImageService

adAddressService

@Autowired
protected AdAddressServiceLocal adAddressService

adQuestionService

@Autowired
protected AdQuestionServiceLocal adQuestionService

adCustomFieldService

@Autowired
protected AdCustomFieldServiceLocal adCustomFieldService

exportFormatService

@Autowired
protected ExportFormatServiceLocal exportFormatService

adCategoryService

@Autowired
protected AdCategoryServiceLocal adCategoryService

adDeliveryMethodService

@Autowired
protected AdDeliveryMethodServiceLocal adDeliveryMethodService

userService

@Autowired
protected UserServiceLocal userService

userCustomFieldService

@Autowired
protected UserCustomFieldServiceLocal userCustomFieldService

adWebShopSettingService

@Autowired
protected AdWebShopSettingServiceLocal adWebShopSettingService

addressService

@Autowired
protected UserAddressServiceLocal addressService

entityLogService

@Autowired
protected EntityLogServiceLocal entityLogService

Constructor Detail

AdServiceImpl

public AdServiceImpl()

Method Detail

adRequiresAuthorization

public boolean adRequiresAuthorization(BasicAd ad)

Description copied from interface: AdServiceLocal

Returns true if the ad requires authorization for publishing.

Specified by:

adRequiresAuthorization in interface AdServiceLocal

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

canViewAddresses

public boolean canViewAddresses(User adOwner)

Description copied from interface: AdServiceLocal

Returns if the given ad owner or a user manager can view addresses in an ad

Specified by:

canViewAddresses in interface AdServiceLocal

canViewAuthorizationNotes

public boolean canViewAuthorizationNotes(BasicAd ad)

Description copied from interface: AdServiceLocal

Returns true if the logged user can view the authorization notes of the given ad

Specified by:

canViewAuthorizationNotes in interface AdServiceLocal

canViewPendings

public boolean canViewPendings(AdType adType,
                               User owner,
                               boolean brokeredSearch)

Description copied from interface: AdServiceLocal

Returns true if the logged user can view pending ads with the given restrictions

Specified by:

canViewPendings in interface AdServiceLocal

checkStatus

public void checkStatus(boolean guest,
                        boolean ownAds,
                        BasicAdQuery params,
                        User owner)

Description copied from interface: AdServiceLocal

Check the statuses in the query params according to the relationship between the logged user and the ad owner. if no status is passed in the query params, all the allowed ones are setted.

Specified by:

checkStatus in interface AdServiceLocal

disableInCurrencies

public int disableInCurrencies(User user,
                               Collection<Currency> currencies)

Description copied from interface: AdServiceLocal

Disables all the ads for the given user which are related to the given currencies

Specified by:

disableInCurrencies in interface AdServiceLocal

exportAd

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

Description copied from interface: AdService

Exports the given advertisement to file

Specified by:

exportAd in interface AdService

Throws:

FrameworkException

findByOwnerAndNumber

public AdWebShop findByOwnerAndNumber(User user,
                                      String adNumber)

Description copied from interface: AdServiceLocal

Returns an AdWebShop by product owner and number, or throws EntityNotFoundException if not found

Specified by:

findByOwnerAndNumber in interface AdServiceLocal

getAdSearchData

public AdSearchData getAdSearchData(AdType type,
                                    boolean overBrokeredUsers)

Description copied from interface: AdService

Returns data for searching advertisements

Specified by:

getAdSearchData in interface AdService

getAdvertisementsCount

public Integer getAdvertisementsCount(User owner,
                                      AdType type)

Description copied from interface: AdServiceLocal

Counts the number of ads filtering by status, for more details about the filters see AdServiceLocal.checkStatus(boolean, boolean, BasicAdQuery, User)}

Specified by:

getAdvertisementsCount in interface AdServiceLocal

getCategories

public Set<AdCategoryVO> getCategories(Long adId)

Description copied from interface: AdServiceLocal

Returns the categories for the given Ad id

Specified by:

getCategories in interface AdServiceLocal

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

hasManageAccess

public boolean hasManageAccess(AdType type,
                               User owner)

Description copied from interface: AdServiceLocal

Returns true if the logged user can manage ads of the given type and user. Doesn't takes into account the authorization status of advertisements.

Specified by:

hasManageAccess in interface AdServiceLocal

hasManageAccess

public boolean hasManageAccess(BasicAd ad)

Description copied from interface: AdServiceLocal

Returns true if the logged user has manage access for the given ad.

Specified by:

hasManageAccess in interface AdServiceLocal

hasManageAccess

public boolean hasManageAccess(Date deletedDate,
                               AdStatus status,
                               AdStatus persistedStatus,
                               AdType type,
                               User owner)

Description copied from interface: AdServiceLocal

Returns true if the logged user has manage access to the ad with the given conditions

Specified by:

hasManageAccess in interface AdServiceLocal

listForSitemap

public List<SitemapItemVO> listForSitemap()

Description copied from interface: AdServiceLocal

Returns the sitemap entries for all enabled advertisements in this network

Specified by:

listForSitemap in interface AdServiceLocal

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

newEntity

public BasicAd newEntity(AdDataParams params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<BasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

Specified by:

newEntity in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

reject

public void reject(@NotNull
                   @NotNull BasicAdVO adVO,
                   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

removeAll

public void removeAll(User user)

Description copied from interface: AdServiceLocal

Removes all the advertisements for the given user

Specified by:

removeAll in interface AdServiceLocal

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

toDTO

public BasicAdDTO toDTO(BasicAd entity)

Description copied from class: CRUDServiceImpl

Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toDTO in interface CRUDServiceLocal<BasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

Overrides:

toDTO in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

addCustomNameValidations

protected void addCustomNameValidations(Property name,
                                        BasicAdDTO namedDTO)

Description copied from class: CRUDServiceImpl

This method may be overridden to add custom validations for the NAME property.

Overrides:

addCustomNameValidations in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

doRemove

protected void doRemove(BasicAd ad,
                        boolean flush)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well

Overrides:

doRemove in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

getData

protected AdDetailsData getData(BasicAd ad)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

getNameLabel

protected String getNameLabel(BasicAdDTO dto)

Overrides:

getNameLabel in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

getUniqueNameQuery

protected Pair<DBQuery<?>,String> getUniqueNameQuery(BasicAdDTO dto)

Description copied from class: CRUDServiceImpl

This method may be overridden to customize the default global unique validation for the name property. Also it must return a string with the context to be included in the key used for the lock (LockKey#LockType)

Overrides:

getUniqueNameQuery in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

onAfterSave

protected void onAfterSave(BasicAd ad,
                           BasicAd currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

onBeforeSave

protected Object onBeforeSave(BasicAd ad,
                              BasicAd currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

preProcessCurrentCopy

protected void preProcessCurrentCopy(BasicAdDTO dto,
                                     BasicAd currentCopy)

Description copied from class: CRUDServiceImpl

This method is invoked before saving the entity and also, if the log is enabled, before removing. Subclasses can override it to fetch lazy relationships, etc as the current copy will be detached. In case of removing (i.e the log is enabled for this entity) the dto parameter will be null.

Overrides:

preProcessCurrentCopy in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveExtensionPointAccessor

protected ExtensionPointAccessor resolveExtensionPointAccessor(CRUDOperation operation,
                                                               BasicAd ad)

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which have extension points

Overrides:

resolveExtensionPointAccessor in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

resolveValidator

protected Validator resolveValidator(BasicAdDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends BasicAd>,Class<? extends BasicAdDTO>> subClassMappings()

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which handle entity / dto hierarchies. The map key should be the entity class, while the map value, the DTO class

Overrides:

subClassMappings in class CRUDServiceImpl<BasicAd,QBasicAd,BasicAdDTO,AdDetailsData,AdDataParams>