com.neurosys.products.service.jaxrs

Class ProductQueryService

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.products.service.jaxrs.ProductQueryService

All Implemented Interfaces:

IQueryService<Product>, CacheLookups, Authorizable

@Path(value="/")
 @Consumes(value={"application/json","application/text","text/html","application/x-www-form-urlencoded"})
 @Produces(value="application/json;charset=utf-8")
 @Secured(value={"ROLE_USER","ROLE_ADMIN"})
public class ProductQueryService
extends SiteAuthorizableSecurableService
implements IQueryService<Product>, CacheLookups

Web Service Layer to Query Product Database

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected ProductDao<Product>	dao
protected org.apache.commons.collections.Transformer	productTransformer A Transformer that accepts a Product and can return a any Object back.
protected ProductService<Product>	service

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

audit, 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
ProductQueryService()
ProductQueryService(boolean checkAuthFiltered)

Method Summary

Modifier and Type	Method and Description
String	clearCache() Clear all the Product cache
Long	count(Query<Product> query)
List	getParents(Long id)
org.apache.commons.collections.Transformer	getProductTransformer()
ProductService<Product>	getService()
String	index() Re-Index all the Product data
Product	load(Long id)
List	loadByFieldName(String fieldNameValJSON)
Product	loadByName(String name)
List	productsInSetOfIds(String idsStr)
List	query(Query<Product> query)
Object	query(String contextNameId, String queryNameId, String json)
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	setProductTransformer(org.apache.commons.collections.Transformer productTransformer)
void	setService(ProductService<Product> service)

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

adminCheck, getAuthorizableIdAssignable, getAuthorizableService, getAuthorizationModule, getCurrentUserAuths, getModuleName, getUser, 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

service

protected transient ProductService<Product> service

dao

protected transient ProductDao<Product> dao

productTransformer

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

A Transformer that accepts a Product 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

ProductQueryService

public ProductQueryService()

ProductQueryService

public ProductQueryService(boolean checkAuthFiltered)

Method Detail

count

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

Specified by:

count in interface IQueryService<Product>

Throws:

Exception

query

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

Specified by:

query in interface IQueryService<Product>

Throws:

Exception

load

@GET
 @Path(value="load/{id}")
 @Consumes(value="text/plain")
public Product load(@PathParam(value="id")
                                                                                  Long id)
                                                                           throws Exception

Specified by:

load in interface IQueryService<Product>

Throws:

Exception

loadByName

@GET
 @Path(value="loadByName/{name}")
 @Consumes(value="text/plain")
public Product loadByName(@PathParam(value="name")
                                                                                                String name)
                                                                                         throws Exception

Throws:

Exception

loadByFieldName

@GET
 @Path(value="loadByFieldName")
 @Consumes(value="application/json")
public List loadByFieldName(@QueryParam(value="fieldNameValJSON")
                                                                                                      String fieldNameValJSON)
                                                                                               throws Exception

Throws:

Exception

getParents

@GET
 @Path(value="parents/{id}")
 @Consumes(value="text/plain")
public List getParents(@PathParam(value="id")
                                                                                        Long id)
                                                                                 throws Exception

Throws:

Exception

productsInSetOfIds

@GET
 @Path(value="loadSet")
 @Consumes(value="text/plain")
public List productsInSetOfIds(@QueryParam(value="ids")
                                                                                           String idsStr)
                                                                                    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

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

 
 {"intra_intersect":false,"inter_intersect":true,"numericRangeQueryFields":["inventory","cost"],"sortParams":[],"terms":["super","excited"],"termsForFields":{"inventory":["200","600"],"cost":["35.5D","85.4D"]}}
 {"intra_intersect":false,"inter_intersect":true,"numericRangeQueryFields":["regularPrice","currentInventory"],"sortParams":[],"terms":["red"],"termsForFields":{"regularPrice":["1100","1400"]."currentInventory":["15","40"]}}
 

Parameters:

pageInfo - as PageInfo Object or JSON @nullable true

categoryName - as String @nullable true

indexName - as String @nullable true (If Null will use Default index) and only applicable if Project uses multiple indeces

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

 
 {"intra_intersect":false,"inter_intersect":true,"numericRangeQueryFields":["inventory","cost"],"sortParams":[],"terms":["super","excited"],"termsForFields":{"inventory":["200","600"],"cost":["35.5D","85.4D"]}}
 {"intra_intersect":false,"inter_intersect":true,"numericRangeQueryFields":["regularPrice","currentInventory"],"sortParams":[],"terms":["red"],"termsForFields":{"regularPrice":["1100","1400"]."currentInventory":["15","40"]}}
 

Parameters:

pageInfo - as PageInfo Object or JSON @nullable true

categoryName - as String @nullable true

indexName - as String @nullable true (If Null will use Default index) and only applicable if Project uses multiple indeces

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 Product cache

Throws:

Exception

getService

public ProductService<Product> getService()

setService

public void setService(ProductService<Product> service)

getProductTransformer

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

setProductTransformer

public void setProductTransformer(org.apache.commons.collections.Transformer productTransformer)