com.neurosys.content.service

Class GenericContentServiceImpl<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

java.lang.Object

com.neurosys.content.service.GenericContentServiceImpl<C,CA,CF>

Type Parameters:

C -

CA -

CF -

All Implemented Interfaces:

GenericContentService<C,CA,CF>

Direct Known Subclasses:

GenericHierarchyContentServiceImpl

public abstract class GenericContentServiceImpl<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>
extends Object
implements GenericContentService<C,CA,CF>

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.cache.Cache	cache
protected org.springframework.cache.CacheManager	cacheManager
protected ContentSource<C,CA,CF>	contentSource
protected Collection<Status>	contentStatusCriticalForMove While #move(ContentDescriber, ContentDescriber, Integer) the service will move the content across all Status types.
protected MountPathReLoader<org.apache.wicket.protocol.http.WebApplication>	mountPathReLoader
protected Map<String,com.neurosys.spider.indexer.service.AbstractIndexSearch<Identifiable<Long>>>	searchMap Map of Index Name to the AbstractIndexSearch Default AbstractIndexSearch is mapped to null key
protected TemplateService	templateService

Fields inherited from interface com.neurosys.content.service.GenericContentService

CONTENT_LOOKUP_CACHE_NAME, CONTENT_PUBLISH_CACHE_NAME

Constructor Summary

Constructors

Constructor and Description
GenericContentServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clear all Product related Cache
void	clearTemplates() Clear cached HTML pages that serve as base templates
List<C>	clone(C content) clone a content across Status & Locales (alter-egos) of this same content. The passed content is not persisted.
protected List<C>	clone(C content, List<Status> statuses, List<Locale> locales) Ability to clone (create clones & persist) content across AbstractContent.getStatus() and/or AbstractContent.getLocale(). The content should have a valid parentId and hierarchy code already set. This method will not save the passed input content but will create a new clone for the alter egos of the supplied content. All the cloned content will search for their respective parents (creating a parallel cloned hierarchy)
C	createNewContent(C content, Integer sequence) Saves content (new) & creates its clones (see ContentService#clone()).
int	deleteContent(String name, boolean deleteChildren) HierarchyContentSource Override for event generation Delete a content and all associated content for all locales etc.
List<String>	getAdditionalCacheNames() Register additional caches, so that on clearCache() all registered caches can be cleared
org.springframework.cache.Cache	getCache()
org.springframework.cache.CacheManager	getCacheManager()
ContentSource<C,CA,CF>	getContentSource()
Collection<Status>	getContentStatusCriticalForMove() While #move(ContentDescriber, ContentDescriber, Integer) the service will move the content across all Status types.
MountPathReLoader<org.apache.wicket.protocol.http.WebApplication>	getMountPathReLoader()
List<AutoGenMenuItem>	getRelatedNavigations()
Map<String,com.neurosys.spider.indexer.service.AbstractIndexSearch<Identifiable<Long>>>	getSearchMap()
com.neurosys.spider.indexer.service.AbstractIndexSearch<Identifiable<Long>>	getSearchService(String indexName)
TemplateService	getTemplateService()
String	getURL(C content) For the content get the URL
void	index() Re-Index all the Content using Spider
C	publish(C content) Performs operations needed to publish the content and its related attributes, facets etc.
void	publish(Collection<C> contents) Performs operations needed to publish content(s) and related attributes, facets etc.
C	save(C content)
CF	saveFacet(CF cf) HierarchyContentSource Override for event generation Save a Facet
List	search(String indexName, com.neurosys.spider.domain.SearchParams searchParams, PageInfo pageInfo, String... categoryNames) Perform indexed/lucene based searches
int	searchCount(String indexName, com.neurosys.spider.domain.SearchParams searchParams, String... categoryNames) Perform indexed/lucene based searches
void	setAdditionalCacheNames(List<String> additionalCacheNames) Register additional caches, so that on clearCache() all registered caches can be cleared
void	setCache(org.springframework.cache.Cache cache)
void	setCacheManager(org.springframework.cache.CacheManager cacheManager)
void	setContentSource(ContentSource<C,CA,CF> contentSource)
void	setContentStatusCriticalForMove(Collection<Status> contentStatusCriticalForMove) While #move(ContentDescriber, ContentDescriber, Integer) the service will move the content across all Status types.
void	setMountPathReLoader(MountPathReLoader<org.apache.wicket.protocol.http.WebApplication> mountPathReLoader)
void	setRelatedNavigations(List<AutoGenMenuItem> relatedNavigations)
void	setSearchMap(Map<String,com.neurosys.spider.indexer.service.AbstractIndexSearch<Identifiable<Long>>> searchMap)
void	setTemplateService(TemplateService templateService)
protected void	sysAutoIndex() Based on a Scheduled job keep refreshing the Index
void	unPublish(C content) It will remove the published version from the ContentSource.
int	updateContentStatus(String name, Locale locale, Status oldStatus, Status newStatus) HierarchyContentSource Override for event generation This will cause an update to the Content state.
void	updateNav() Ability to refresh Navigation linked to the content service; if any

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.neurosys.content.service.GenericContentService

getFacets, mount

Field Detail

contentSource

protected ContentSource<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet> contentSource

cacheManager

@Autowired
 @Qualifier(value="cacheManager")
protected org.springframework.cache.CacheManager cacheManager

cache

protected org.springframework.cache.Cache cache

templateService

protected TemplateService templateService

mountPathReLoader

protected MountPathReLoader<org.apache.wicket.protocol.http.WebApplication> mountPathReLoader

searchMap

protected Map<String,com.neurosys.spider.indexer.service.AbstractIndexSearch<Identifiable<Long>>> searchMap

Map of Index Name to the AbstractIndexSearch Default AbstractIndexSearch is mapped to null key

contentStatusCriticalForMove

protected Collection<Status> contentStatusCriticalForMove

While #move(ContentDescriber, ContentDescriber, Integer) the service will move the content across all Status types. If the ones in this are not found it will break the process and not proceed.

Constructor Detail

GenericContentServiceImpl

public GenericContentServiceImpl()

Method Detail

updateContentStatus

@Transactional(readOnly=false)
public int updateContentStatus(String name,
                                                              Locale locale,
                                                              Status oldStatus,
                                                              Status newStatus)
                                                       throws Exception

HierarchyContentSource Override for event generation

This will cause an update to the Content state. Note, it is the responsibility of the calling API to ensure that the content status is not conflicting with an existing state.

For example: If a content (for the locale) is in status Status.DRAFT, and is being updated to Status.PUBLISH while another Status.PUBLISH one already exists. Then it should update the PUBLISH record for the content and mute the Status.DRAFT one (in concept).

Specified by:

updateContentStatus in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

name - as identifier for the content

locale - as the Locale

oldStatus - as the Status

newStatus - as the Status (replace the oldStatus with this value)

Returns:

int as number of rows updated

Throws:

Exception

save

@Transactional(readOnly=false)
public C save(C content)

Specified by:

save in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

publish

@Transactional(readOnly=false)
public C publish(C content)
                                         throws PartialTransactionException

Performs operations needed to publish the content and its related attributes, facets etc.
Typically at the service layer, the following operations constitute a publish (may differ in implementations):

• Clone Preview Content record (& related ContentFacets, attributes) to publish
• Generate new Markup related to template & content
• Refresh any caches
• Update Mount paths if required, so that navigation is up to date

It is preferred that the above steps (or any implementation specific steps) be maintained in one transaction. Failure in a single step should roll back the transaction.

Specified by:

publish in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

content - (this should be a record with Content.getStatus() as Status.DRAFT)

Throws:

PartialTransactionException

unPublish

public void unPublish(C content)
               throws Exception

Description copied from interface: GenericContentService

It will remove the published version from the ContentSource. By default any paths etc are not mounted.

Specified by:

unPublish in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Throws:

Exception

updateNav

public void updateNav()

Description copied from interface: GenericContentService

Ability to refresh Navigation linked to the content service; if any

Specified by:

updateNav in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

clearCache

public void clearCache()

Description copied from interface: GenericContentService

Clear all Product related Cache

Specified by:

clearCache in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

publish

public void publish(Collection<C> contents)
             throws Exception

Performs operations needed to publish content(s) and related attributes, facets etc.
Typically at the service layer, the following operations constitute a publish (may differ in implementations):

• Clone Preview Content record (& related ContentFacets, attributes) to publish
• Generate new Markup related to template & content
• Refresh any caches
• Update Mount paths if required, so that navigation is up to date
• Update any related navigations

It is preferred that the above steps (or any implementation specific steps) be maintained in one transaction. Failure in a single step should roll back the transaction.

Specified by:

publish in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

contents - (these should be records with Content.getStatus() as Status.DRAFT)

Throws:

Exception

getRelatedNavigations

public List<AutoGenMenuItem> getRelatedNavigations()

setRelatedNavigations

public void setRelatedNavigations(List<AutoGenMenuItem> relatedNavigations)

clone

protected List<C> clone(C content,
                        List<Status> statuses,
                        List<Locale> locales)

Ability to clone (create clones & persist) content across AbstractContent.getStatus() and/or AbstractContent.getLocale().
The content should have a valid parentId and hierarchy code already set.

This method will not save the passed input content but will create a new clone for the alter egos of the supplied content.
All the cloned content will search for their respective parents (creating a parallel cloned hierarchy)

Returns:

saved/persisted list of clones

clone

public List<C> clone(C content)

clone a content across Status & Locales (alter-egos) of this same content.
The passed content is not persisted.

Specified by:

clone in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Returns:

saved/persisted list of clones

createNewContent

public C createNewContent(C content,
                          Integer sequence)

Saves content (new) & creates its clones (see ContentService#clone()). The content being saved should be ideally a Status.DRAFT version, if its not set then it will set it; and replicate across other status. The content should also have its parent id set.

Specified by:

createNewContent in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

sequence - is ignored in this implementation

content - @nullable false ;if Content#getParentId() is null then it will assume root

Returns:

saved Content object

search

public List search(String indexName,
                   com.neurosys.spider.domain.SearchParams searchParams,
                   PageInfo pageInfo,
                   String... categoryNames)
            throws Exception

Description copied from interface: GenericContentService

Perform indexed/lucene based searches

Specified by:

search in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

indexName - as String @Nuallble true implies the default index wilt be searched

searchParams - as SearchParams @nullable false

pageInfo - as PageIngo @nullable true

categoryNames - @nullable true

Returns:

Throws:

Exception

searchCount

public int searchCount(String indexName,
                       com.neurosys.spider.domain.SearchParams searchParams,
                       String... categoryNames)
                throws Exception

Description copied from interface: GenericContentService

Perform indexed/lucene based searches

Specified by:

searchCount in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

indexName - as String @Nuallble true implies the default index wilt be searched

searchParams - as SearchParams @nullable false

categoryNames - @nullable true

Returns:

Throws:

Exception

sysAutoIndex

@Scheduled(cron="${search.indexer.content.cron}")
protected void sysAutoIndex()
                                                                       throws Exception

Based on a Scheduled job keep refreshing the Index

Throws:

Exception

index

public void index()
           throws Exception

Description copied from interface: GenericContentService

Re-Index all the Content using Spider

Specified by:

index in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Throws:

Exception

getSearchMap

public Map<String,com.neurosys.spider.indexer.service.AbstractIndexSearch<Identifiable<Long>>> getSearchMap()

setSearchMap

public void setSearchMap(Map<String,com.neurosys.spider.indexer.service.AbstractIndexSearch<Identifiable<Long>>> searchMap)

getSearchService

public com.neurosys.spider.indexer.service.AbstractIndexSearch<Identifiable<Long>> getSearchService(String indexName)

Specified by:

getSearchService in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

deleteContent

@Transactional(readOnly=false)
public int deleteContent(String name,
                                                        boolean deleteChildren)

Description copied from interface: GenericContentService

HierarchyContentSource Override for event generation

Delete a content and all associated content for all locales etc.
sub-hierarchy Deletion is optional as a flag, however most cases it makes sense to provide true as it makes no sense to have dangling orphaned children. However keeping in mind, complex scenarios and intermediate situations that can arise this feature is supported as a service level call.

Specified by:

deleteContent in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

name - of Content as String

deleteChildren - as boolean; will delete sub-hierarchy to this content

Returns:

int as the number of content records deleted (related records like ContentAttribute, ContentFacet etc are not counted, just core content entity objects)

saveFacet

@Transactional(readOnly=false)
public CF saveFacet(CF cf)

Description copied from interface: GenericContentService

HierarchyContentSource Override for event generation

Save a Facet

Specified by:

saveFacet in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

cf - as ContentFacet

Returns:

getCacheManager

public org.springframework.cache.CacheManager getCacheManager()

setCacheManager

public void setCacheManager(org.springframework.cache.CacheManager cacheManager)

getTemplateService

public TemplateService getTemplateService()

setTemplateService

public void setTemplateService(TemplateService templateService)

getMountPathReLoader

public MountPathReLoader<org.apache.wicket.protocol.http.WebApplication> getMountPathReLoader()

setMountPathReLoader

public void setMountPathReLoader(MountPathReLoader<org.apache.wicket.protocol.http.WebApplication> mountPathReLoader)

setCache

public void setCache(org.springframework.cache.Cache cache)

getContentStatusCriticalForMove

public Collection<Status> getContentStatusCriticalForMove()

While #move(ContentDescriber, ContentDescriber, Integer) the service will move the content across all Status types. If the ones in this are not found it will break the process and not proceed.

setContentStatusCriticalForMove

public void setContentStatusCriticalForMove(Collection<Status> contentStatusCriticalForMove)

While #move(ContentDescriber, ContentDescriber, Integer) the service will move the content across all Status types. If the ones in this are not found it will break the process and not proceed.

getURL

public String getURL(C content)

Description copied from interface: GenericContentService

For the content get the URL

Specified by:

getURL in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

content - as Content

Returns:

URL as String

getAdditionalCacheNames

public List<String> getAdditionalCacheNames()

Register additional caches, so that on clearCache() all registered caches can be cleared

setAdditionalCacheNames

public void setAdditionalCacheNames(List<String> additionalCacheNames)

Register additional caches, so that on clearCache() all registered caches can be cleared

getCache

public org.springframework.cache.Cache getCache()

Specified by:

getCache in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

clearTemplates

public void clearTemplates()
                    throws Exception

Description copied from interface: GenericContentService

Clear cached HTML pages that serve as base templates

Specified by:

clearTemplates in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Throws:

Exception

getContentSource

public ContentSource<C,CA,CF> getContentSource()

Specified by:

getContentSource in interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

setContentSource

public void setContentSource(ContentSource<C,CA,CF> contentSource)