public abstract class AbstractSearchResourceHandler extends AbstractBaseResourceHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM Copyright notice field.
|
static java.lang.String | PARAMETER_ADVANCED_FACET_LIST
parameter constant
|
static java.lang.String | PARAMETER_ADVANCED_FACET_LIST_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_ATTACHEMENT_FILTER
parameter constant
|
static java.lang.String | PARAMETER_ATTACHMENT_FILTER_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_CATEGORY_ID
parameter name
|
static java.lang.String | PARAMETER_CATEGORY_ID_DESCRIPTION
category identifier parameter description
|
static java.lang.String | PARAMETER_CHECK_ENTITLEMENT
parameter constant
|
static java.lang.String | PARAMETER_ENTITLEMENT_CHECK_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_FACET
parameter constant
|
static java.lang.String | PARAMETER_FACET_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_FACET_LIMIT
parameter constant
|
static java.lang.String | PARAMETER_FACET_LIMIT_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_FILTER_FACET
parameter constant
|
static java.lang.String | PARAMETER_FILTER_TERM
parameter constant
|
static java.lang.String | PARAMETER_FILTER_TERM_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_FILTER_TYPE
parameter constant
|
static java.lang.String | PARAMETER_FILTER_TYPE_DESCRIPTION
parameter description
|
static java.lang.String | PARAMETER_FITER_FACET_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_INTENT_SEARCH_TERM
parameter constant
|
static java.lang.String | PARAMETER_INTENT_SEARCH_TERM_DESCRIPTION
parameter description
|
static java.lang.String | PARAMETER_LANDING_PAGE
parameter constant
|
static java.lang.String | PARAMETER_LANDING_PAGE_DESCRIPTION
parameter description
|
static java.lang.String | PARAMETER_MANUFACTURER
parameter constant
|
static java.lang.String | PARAMETER_MANUFACTURER_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_MAX_PRICE
parameter constant
|
static java.lang.String | PARAMETER_MAXIMUM_PRICE_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_META_DATA
parameter constant
|
static java.lang.String | PARAMETER_META_DATA_DESCRIPTION
parameter description
|
static java.lang.String | PARAMETER_MIN_PRICE
parameter constant
|
static java.lang.String | PARAMETER_MINIMUM_PRICE_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_ORDER_BY
parameter constant
|
static java.lang.String | PARAMETER_ORDER_BY_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_ORIGINAL_SEARCH_TERM
parameter constant
|
static java.lang.String | PARAMETER_ORIGINAL_SEARCH_TERM_DESCRIPTION
parameter description
|
static java.lang.String | PARAMETER_PHYSICAL_STORE_IDS
parameter constant
|
static java.lang.String | PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION
parameter description
|
static java.lang.String | PARAMETER_PRICE_MODE
parameter constant
|
static java.lang.String | PARAMETER_PRICE_MODE_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_SEARCH_SOURCE
parameter constant
|
static java.lang.String | PARAMETER_SEARCH_SOURCE_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_SEARCH_TERM
parameter name
|
static java.lang.String | PARAMETER_SEARCH_TERM_DESCRIPTION
parameter name
|
static java.lang.String | PARAMETER_SEARCH_TERM_QUERY_DESCRIPTION
parameter description constant
|
static java.lang.String | PARAMETER_SEARCH_TYPE
parameter constant
|
static java.lang.String | PARAMETER_SEARCH_TYPE_DESCRIPTION
parameter description constant
|
protected static java.util.logging.Logger | SERVICELOGGER
Service Logger
|
Constructor and Description |
---|
AbstractSearchResourceHandler() |
Modifier and Type | Method and Description |
---|---|
protected SearchResponse | executeSearch(SearchCriteria searchCriteria)
Performs the actual search and return the search response object.
|
protected javax.ws.rs.core.Response | generateResponseFromRespData(SearchCriteria searchCriteria, SearchResponse searchResponse, java.lang.Exception e)
This method generates REST response for a given response map.
|
protected java.lang.String | getCheckEntitlement(SearchCriteria searchCriteria, java.lang.String searchProfile, java.lang.String storeId)
Gets the check entitlement string.
|
protected java.lang.String | getCookiesFromHTTPRequest(javax.servlet.http.HttpServletRequest aHTTPRequest)
Retrieves cookies from the HTTP Request and converts them to a string of name-value pairs separated by an ampersand.
|
protected java.lang.String | getPriceMode(SearchCriteria searchCriteria, java.lang.String searchProfile, java.lang.String storeId)
Gets the price mode.
|
protected java.lang.String | getRequestPath()
This method return request path with web server host name and port number.
|
protected SearchCriteria | initSearchCriteria(java.lang.String storeId, java.lang.String httpMethod, java.lang.String componentId, java.lang.String resourceName, java.lang.String resourceUri)
This method is reserved to do initialization as needed.
|
protected boolean | isLocaleSupportedByStore(java.lang.String storeId, java.lang.String localeName)
Test if a locale is supported by a store.
|
boolean | isRequestInPreviewMode()
Tests if the request is executed in preview mode.
|
protected javax.ws.rs.core.Response | performSearch(SearchCriteria searchCriteria)
Calls executeSearch() to perform the actual search and return the resource information.
|
protected javax.ws.rs.core.Response | prepareAndValidate(java.lang.String storeId, java.lang.String resourceName, java.lang.String httpMethod, javax.servlet.http.HttpServletRequest request, java.lang.String responseFormat)
This method is reserved to do initialization and validation as needed.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String PARAMETER_LANDING_PAGE
public static final java.lang.String PARAMETER_LANDING_PAGE_DESCRIPTION
public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS
public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION
public static final java.lang.String PARAMETER_FILTER_TYPE
public static final java.lang.String PARAMETER_META_DATA
public static final java.lang.String PARAMETER_META_DATA_DESCRIPTION
public static final java.lang.String PARAMETER_ORIGINAL_SEARCH_TERM
public static final java.lang.String PARAMETER_INTENT_SEARCH_TERM
public static final java.lang.String PARAMETER_ORIGINAL_SEARCH_TERM_DESCRIPTION
public static final java.lang.String PARAMETER_INTENT_SEARCH_TERM_DESCRIPTION
public static final java.lang.String PARAMETER_SEARCH_TERM_QUERY_DESCRIPTION
public static final java.lang.String PARAMETER_FILTER_TYPE_DESCRIPTION
public static final java.lang.String PARAMETER_CATEGORY_ID_DESCRIPTION
public static final java.lang.String PARAMETER_FILTER_FACET
public static final java.lang.String PARAMETER_FILTER_TERM
public static final java.lang.String PARAMETER_MANUFACTURER
public static final java.lang.String PARAMETER_MIN_PRICE
public static final java.lang.String PARAMETER_MAX_PRICE
public static final java.lang.String PARAMETER_ORDER_BY
public static final java.lang.String PARAMETER_SEARCH_TYPE
public static final java.lang.String PARAMETER_SEARCH_SOURCE
public static final java.lang.String PARAMETER_PRICE_MODE
public static final java.lang.String PARAMETER_CHECK_ENTITLEMENT
public static final java.lang.String PARAMETER_ATTACHEMENT_FILTER
public static final java.lang.String PARAMETER_ADVANCED_FACET_LIST
public static final java.lang.String PARAMETER_FACET_LIMIT
public static final java.lang.String PARAMETER_ATTACHMENT_FILTER_DESCRIPTION
public static final java.lang.String PARAMETER_ENTITLEMENT_CHECK_DESCRIPTION
public static final java.lang.String PARAMETER_PRICE_MODE_DESCRIPTION
public static final java.lang.String PARAMETER_SEARCH_SOURCE_DESCRIPTION
public static final java.lang.String PARAMETER_SEARCH_TYPE_DESCRIPTION
public static final java.lang.String PARAMETER_ORDER_BY_DESCRIPTION
public static final java.lang.String PARAMETER_MAXIMUM_PRICE_DESCRIPTION
public static final java.lang.String PARAMETER_MINIMUM_PRICE_DESCRIPTION
public static final java.lang.String PARAMETER_MANUFACTURER_DESCRIPTION
public static final java.lang.String PARAMETER_FILTER_TERM_DESCRIPTION
public static final java.lang.String PARAMETER_FITER_FACET_DESCRIPTION
public static final java.lang.String PARAMETER_ADVANCED_FACET_LIST_DESCRIPTION
public static final java.lang.String PARAMETER_FACET_LIMIT_DESCRIPTION
public static final java.lang.String PARAMETER_FACET_DESCRIPTION
public static final java.lang.String PARAMETER_FACET
public static final java.lang.String PARAMETER_CATEGORY_ID
public static final java.lang.String PARAMETER_SEARCH_TERM
public static final java.lang.String PARAMETER_SEARCH_TERM_DESCRIPTION
protected static final java.util.logging.Logger SERVICELOGGER
protected javax.ws.rs.core.Response performSearch(SearchCriteria searchCriteria)
protected java.lang.String getCookiesFromHTTPRequest(javax.servlet.http.HttpServletRequest aHTTPRequest)
protected javax.ws.rs.core.Response generateResponseFromRespData(SearchCriteria searchCriteria, SearchResponse searchResponse, java.lang.Exception e)
Use this method in your resource handler class when you want to pass name value pairs to the entity provider.
protected SearchResponse executeSearch(SearchCriteria searchCriteria) throws java.lang.Exception
protected SearchCriteria initSearchCriteria(java.lang.String storeId, java.lang.String httpMethod, java.lang.String componentId, java.lang.String resourceName, java.lang.String resourceUri)
protected java.lang.String getRequestPath()
public boolean isRequestInPreviewMode()
protected java.lang.String getPriceMode(SearchCriteria searchCriteria, java.lang.String searchProfile, java.lang.String storeId)
protected java.lang.String getCheckEntitlement(SearchCriteria searchCriteria, java.lang.String searchProfile, java.lang.String storeId)
protected boolean isLocaleSupportedByStore(java.lang.String storeId, java.lang.String localeName) throws java.lang.Exception
protected javax.ws.rs.core.Response prepareAndValidate(java.lang.String storeId, java.lang.String resourceName, java.lang.String httpMethod, javax.servlet.http.HttpServletRequest request, java.lang.String responseFormat)