com.neurosys.content.service

Interface GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

All Known Subinterfaces:

CommentService, ContentService, PostService

All Known Implementing Classes:

CommentServiceImpl, ContentServiceImpl, GenericContentServiceImpl, GenericHierarchyContentServiceImpl, PostServiceImpl

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

Author:

Basic set of Services expected from any Service servicing Content, Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_LOOKUP_CACHE_NAME Cache for looking up Categories, top level Contents that are called often in the project On save the cache is updated (ideally, check admin code Key: Content.getId() or Content#getParentId() or Content.getName()
static String	CONTENT_PUBLISH_CACHE_NAME Published Content is cached On publish the cache is updated ; ideally, check admin code Key : The Location / url

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) Ability to clone (create clones & persist) content across Content.getStatus() and/or Localizable.getLocale().
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.
org.springframework.cache.Cache	getCache()
ContentSource<C,CA,CF>	getContentSource()
List<CF>	getFacets(Object contentNameorId, String facetName, Status status) Convenient method for Scripts to call to get dynamic content for a AbstractContentFacet reference..
com.neurosys.spider.indexer.service.AbstractIndexSearch<Identifiable<Long>>	getSearchService(String indexName)
String	getURL(C content) For the content get the URL
void	index() Re-Index all the Content using Spider
String	mount(C content, Template template) Mount a page so its accessible on the webite.
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	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

Field Detail

CONTENT_PUBLISH_CACHE_NAME

static final String CONTENT_PUBLISH_CACHE_NAME

Published Content is cached
On publish the cache is updated ; ideally, check admin code

Key : The Location / url

See Also:

SingleContentPerFacetPublishAdapter}, Constant Field Values

CONTENT_LOOKUP_CACHE_NAME

static final String CONTENT_LOOKUP_CACHE_NAME

Cache for looking up Categories, top level Contents that are called often in the project
On save the cache is updated (ideally, check admin code

Key: Content.getId() or Content#getParentId() or Content.getName()

See Also:

Constant Field Values

Method Detail

mount

String mount(C content,
             Template template)

Mount a page so its accessible on the webite.

Parameters:

content -

template -

Returns:

publish

C publish(C content)
   throws Exception

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.

Parameters:

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

Throws:

Exception

save

C save(C content)

unPublish

void unPublish(C content)
        throws Exception

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

Parameters:

content -

Throws:

Exception

publish

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.

Parameters:

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

Throws:

Exception

updateNav

void updateNav()

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

clone

List<C> clone(C content)

Ability to clone (create clones & persist) content across Content.getStatus() and/or Localizable.getLocale(). The content should have a valid parentId. If hierarchy is not set, it will be derived from the parent (max + 1)

This method will not save the content and 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

createNewContent

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.

Parameters:

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

sequence - as Integer, an alternate order within the parent where this content will be created @nullable true

Returns:

saved Content object

search

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

Perform indexed/lucene based searches

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

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

Perform indexed/lucene based searches

Parameters:

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

searchParams - as SearchParams @nullable false

categoryNames - @nullable true

Returns:

Throws:

Exception

index

void index()
    throws Exception

Re-Index all the Content using Spider

Throws:

Exception

getCache

org.springframework.cache.Cache getCache()

clearCache

void clearCache()
         throws Exception

Clear all Product related Cache

Throws:

Exception

clearTemplates

void clearTemplates()
             throws Exception

Clear cached HTML pages that serve as base templates

Throws:

Exception

getURL

String getURL(C content)

For the content get the URL

Parameters:

content - as Content

Returns:

URL as String

getContentSource

ContentSource<C,CA,CF> getContentSource()

updateContentStatus

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).

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

deleteContent

int deleteContent(String name,
                  boolean deleteChildren)

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.

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

CF saveFacet(CF cf)

HierarchyContentSource Override for event generation

Save a Facet

Parameters:

cf - as ContentFacet

Returns:

getFacets

List<CF> getFacets(Object contentNameorId,
                   String facetName,
                   Status status)

Convenient method for Scripts to call to get dynamic content for a AbstractContentFacet reference.. Useful when called via embedded scripts in content.

Parameters:

contentNameorId - as String or Long

facetName - as String

status - as Status (optional)

Returns:

List of AbstractContentFacet

getSearchService

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