com.neurosys.content.service.jaxrs

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

java.lang.Object

com.neurosys.amorphous.service.jaxrs.AnyWebService

com.neurosys.amorphous.service.jaxrs.SecurableService

com.neurosys.amorphous.service.jaxrs.AuthorizableSecurableService

com.neurosys.common.service.jaxrs.SiteAuthorizableSecurableService

com.neurosys.content.service.jaxrs.ContentQueryService<C,CA,CF>

All Implemented Interfaces:

IQueryService<C>, CacheLookups, Authorizable

@Path(value="/")
 @Consumes(value={"application/json","application/x-www-form-urlencoded"})
 @Produces(value="application/json;charset=utf-8")
 @Secured(value={"ROLE_USER","ROLE_ADMIN"})
public class ContentQueryService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>
extends SiteAuthorizableSecurableService
implements IQueryService<C>, CacheLookups

Web Service Layer to Query ContentDescriber Database

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.collections.Transformer	contentTransformer A Transformer that accepts a AbstractContentFacet and can return a any Object back.

Fields inherited from class com.neurosys.common.service.jaxrs.SiteAuthorizableSecurableService

authorizationModule

Fields inherited from class com.neurosys.amorphous.service.jaxrs.AnyWebService

applicationContext, CACHE, NO_CACHE, request, response

Fields inherited from interface com.neurosys.lookups.CacheLookups

CONTENT_PUBLISH_CACHE_NAME, PRODUCT_LOOKUP_CACHE_NAME, PRODUCT_SEARCH_CACHE_NAME, TEMPLATEPAGE_MAPPING_CACHE_NAME

Constructor Summary

Constructors

Constructor and Description
ContentQueryService()
ContentQueryService(boolean checkAuthFiltered)

Method Summary

Modifier and Type	Method and Description
String	clearCache() Clear all the ContentDescriber cache
String	clearTemplates() Clear all the ContentDescriber cache
Long	count(Query<C> query)
org.apache.commons.collections.Transformer	getContentTransformer()
GenericContentService	getService()
String	getURL(String name, Locale l)
Map<String,String>	getURLs(Collection<String> names, Locale l)
protected User	getUser(javax.servlet.http.HttpServletRequest request) Get User for the current HttpServletRequest
String	index() Re-Index all the Product data
C	load(Long id)
List<CF>	loadFacetArray(Long contentId, String facetName, Collection<Integer> indeces)
Collection<CF>	loadFacets(Long contentId, Collection<String> names) Fetch ContentFacet for specific types
List<C>	loadHierarchy(String name, Locale l)
List<C>	query(Query<C> query)
Object	query(String contextNameId, String queryNameId, String json)
Object	querySpringBean(String contextNameId, String beanClassName, String accessor)
List	search(com.neurosys.spider.domain.SearchParams searchParams, PageInfo pageInfo, String categoryName, String indexName, Boolean useCache) Do a Search using the Indexing API on terms Sample: SearchParams
int	searchCount(com.neurosys.spider.domain.SearchParams searchParams, String categoryName, String indexName, Boolean useCache) Search Count Sample: SearchParams
void	setContentTransformer(org.apache.commons.collections.Transformer contentTransformer)
void	setService(GenericContentService service)

Methods inherited from class com.neurosys.common.service.jaxrs.SiteAuthorizableSecurableService

adminCheck, getAuthorizableIdAssignable, getAuthorizableService, getAuthorizationModule, getCurrentUserAuths, getModuleName, getUserAuths, isAdmin, isUser, setAuthorizationModule

Methods inherited from class com.neurosys.amorphous.service.jaxrs.AuthorizableSecurableService

filter, getAuthorizableId, getAuthorizations, setAuthorizableId, setAuthorizations

Methods inherited from class com.neurosys.amorphous.service.jaxrs.SecurableService

checkAuthFilterInvoked, query

Methods inherited from class com.neurosys.amorphous.service.jaxrs.AnyWebService

filter, getCacheDef, getTestString, query

Methods inherited from class java.lang.Object

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

Field Detail

contentTransformer

protected transient org.apache.commons.collections.Transformer contentTransformer

A Transformer that accepts a AbstractContentFacet and can return a any Object back. and applies a filter one last time before its sent out.

The filteration is a process meant to apply formating fixes etc for easier consumption of the external API calling this service.

Constructor Detail

ContentQueryService

public ContentQueryService()

ContentQueryService

public ContentQueryService(boolean checkAuthFiltered)

Method Detail

getUser

protected User getUser(javax.servlet.http.HttpServletRequest request)

Description copied from class: AuthorizableSecurableService

Get User for the current HttpServletRequest

Overrides:

getUser in class SiteAuthorizableSecurableService

Parameters:

request - as HttpServletRequest

Returns:

User

count

@POST
 @Path(value="queryListSize")
 @Produces(value="text/plain")
public Long count(@FormParam(value="query")
                                                                                     Query<C> query)
                                                                              throws Exception

Specified by:

count in interface IQueryService<C extends Content<CA,CF>>

Throws:

Exception

query

@POST
 @Path(value="queryList")
public List<C> query(@FormParam(value="query")
                                                     Query<C> query)
                                              throws Exception

Specified by:

query in interface IQueryService<C extends Content<CA,CF>>

Throws:

Exception

load

@GET
 @Path(value="load/{id}")
 @Consumes(value={"text/plain","application/x-www-form-urlencoded"})
public C load(@PathParam(value="id")
                                                                                                                  Long id)
                                                                                                           throws Exception

Specified by:

load in interface IQueryService<C extends Content<CA,CF>>

Throws:

Exception

loadHierarchy

@GET
 @Path(value="loadHierarchy/{name}")
 @Consumes(value={"text/plain","application/x-www-form-urlencoded"})
public List<C> loadHierarchy(@PathParam(value="name")
                                                                                                                                            String name,
                                                                                                                                            @QueryParam(value="locale")
                                                                                                                                            Locale l)
                                                                                                                                     throws Exception

Throws:

Exception

getURL

@GET
 @Path(value="url/{name}")
 @Consumes(value={"text/plain","application/x-www-form-urlencoded"})
public String getURL(@PathParam(value="name")
                                                                                                                          String name,
                                                                                                                          @QueryParam(value="locale")
                                                                                                                          Locale l)
                                                                                                                   throws Exception

Throws:

Exception

getURLs

@GET
 @Path(value="urls")
 @Consumes(value={"text/plain","application/x-www-form-urlencoded"})
public Map<String,String> getURLs(@QueryParam(value="names")
                                                                                                                                 Collection<String> names,
                                                                                                                                 @QueryParam(value="locale")
                                                                                                                                 Locale l)
                                                                                                                          throws Exception

Throws:

Exception

loadFacets

@GET
 @Path(value="loadFacets")
 @Consumes(value={"text/plain","application/x-www-form-urlencoded"})
public Collection<CF> loadFacets(@QueryParam(value="contentId")
                                                                                                                                      Long contentId,
                                                                                                                                      @QueryParam(value="facetNames")
                                                                                                                                      Collection<String> names)
                                                                                                                               throws Exception

Fetch ContentFacet for specific types

Parameters:

contentId - as String for Content

names - as List of names @nullable true

Returns:

Collection of ContentFacet

Throws:

Exception

loadFacetArray

@GET
 @Path(value="loadFacetArray")
 @Consumes(value={"text/plain","application/x-www-form-urlencoded"})
public List<CF> loadFacetArray(@QueryParam(value="contentId")
                                                                                                                                        Long contentId,
                                                                                                                                        @QueryParam(value="facetName")
                                                                                                                                        String facetName,
                                                                                                                                        Collection<Integer> indeces)
                                                                                                                                 throws Exception

Throws:

Exception

query

@GET
 @Path(value="namedQuery/{contextNameId}/{queryNameId}")
 @Produces(value="application/json")
public Object query(@PathParam(value="contextNameId")
                                                                                                                       String contextNameId,
                                                                                                                       @PathParam(value="queryNameId")
                                                                                                                       String queryNameId,
                                                                                                                       @QueryParam(value="p")
                                                                                                                       String json)
                                                                                                                throws Exception

Parameters:

contextNameId - as String; a classification for the manner in which the Query is called. Can allow for better and custom security or context or SEO related aspects.

queryNameId - as String (should match a Spring Transformer bean id that accepts an Object array as params)

p - as JSON Array String @nullable true

Returns:

should be either String type or JSON

Throws:

Exception

querySpringBean

@GET
 @Path(value="admin/query/{contextNameId}/{beanClassName}/{accessor}")
 @Produces(value="application/json")
public Object querySpringBean(@PathParam(value="contextNameId")
                                                                                                                                               String contextNameId,
                                                                                                                                               @PathParam(value="beanClassName")
                                                                                                                                               String beanClassName,
                                                                                                                                               @PathParam(value="accessor")
                                                                                                                                               String accessor)
                                                                                                                                        throws Exception

Throws:

Exception

search

@POST
 @Path(value="search")
public List search(@FormParam(value="searchParams")
                                                com.neurosys.spider.domain.SearchParams searchParams,
                                                @FormParam(value="pageInfo")
                                                PageInfo pageInfo,
                                                @FormParam(value="categoryName")
                                                String categoryName,
                                                @FormParam(value="indexName")
                                                String indexName,
                                                @FormParam(value="useCache")
                                                Boolean useCache)
                                         throws Exception

Do a Search using the Indexing API on terms
Sample: SearchParams

 
 TODO: Provide Same & @Description on Param JSON Format
 

Returns:

Page or List

Throws:

Exception

searchCount

@POST
 @Path(value="searchCount")
public int searchCount(@FormParam(value="searchParams")
                                                         com.neurosys.spider.domain.SearchParams searchParams,
                                                         @FormParam(value="categoryName")
                                                         String categoryName,
                                                         @FormParam(value="indexName")
                                                         String indexName,
                                                         @FormParam(value="useCache")
                                                         Boolean useCache)
                                                  throws Exception

Search Count
Sample: SearchParams

 
 TODO: Provide Same & @Description on Param JSON Format
 

Returns:

count as int

Throws:

Exception

index

@GET
 @Path(value="admin/index")
public String index()
                                              throws Exception

Re-Index all the Product data

Throws:

Exception

clearCache

@GET
 @Path(value="admin/clearcache")
public String clearCache()
                                                        throws Exception

Clear all the ContentDescriber cache

Throws:

Exception

clearTemplates

@GET
 @Path(value="admin/cleartemplates")
public String clearTemplates()
                                                                throws Exception

Clear all the ContentDescriber cache

Throws:

Exception

getService

public GenericContentService getService()

setService

public void setService(GenericContentService service)

getContentTransformer

public org.apache.commons.collections.Transformer getContentTransformer()

setContentTransformer

public void setContentTransformer(org.apache.commons.collections.Transformer contentTransformer)