com.yahoo.bard.webservice.web.responseprocessors

Class CacheV2ResponseProcessor

java.lang.Object

com.yahoo.bard.webservice.web.responseprocessors.CacheV2ResponseProcessor

All Implemented Interfaces:

ResponseProcessor

public class CacheV2ResponseProcessor
extends Object
implements ResponseProcessor

A response processor which caches the results if appropriate after completing a query.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.databind.ObjectWriter	writer

Constructor Summary

Constructors

Constructor and Description
CacheV2ResponseProcessor(ResponseProcessor next, String cacheKey, TupleDataCache<String,Long,String> dataCache, QuerySigningService<Long> querySigningService, com.fasterxml.jackson.databind.ObjectMapper mapper) Constructor.

Method Summary

Modifier and Type	Method and Description
HttpErrorCallback	getErrorCallback(DruidAggregationQuery<?> druidQuery) Callback for handling http errors.
FailureCallback	getFailureCallback(DruidAggregationQuery<?> druidQuery) Callback handler for unexpected failures.
ResponseContext	getResponseContext() The response context allows state to be injected from construction and visible across response processor layers as necessary.
protected boolean	isCacheable() A request is cacheable if it does not refer to partial data.
void	processResponse(com.fasterxml.jackson.databind.JsonNode json, DruidAggregationQuery<?> druidQuery, LoggingContext metadata) Process the response json and respond to the original web request.

Methods inherited from class java.lang.Object

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

Field Detail

writer

protected final com.fasterxml.jackson.databind.ObjectWriter writer

Constructor Detail

CacheV2ResponseProcessor

public CacheV2ResponseProcessor(ResponseProcessor next,
                                String cacheKey,
                                TupleDataCache<String,Long,String> dataCache,
                                QuerySigningService<Long> querySigningService,
                                com.fasterxml.jackson.databind.ObjectMapper mapper)

Constructor.

Parameters:

next - Next ResponseProcessor in the chain

cacheKey - Key into which to write a cache entry

dataCache - The cache into which to write a cache entry

querySigningService - Service to use for signing the queries in the cache key with their metadata

mapper - An object mapper to use for processing Json

Method Detail

getResponseContext

public ResponseContext getResponseContext()

Description copied from interface: ResponseProcessor

The response context allows state to be injected from construction and visible across response processor layers as necessary.

Specified by:

getResponseContext in interface ResponseProcessor

Returns:

The context data

getFailureCallback

public FailureCallback getFailureCallback(DruidAggregationQuery<?> druidQuery)

Description copied from interface: ResponseProcessor

Callback handler for unexpected failures.

Specified by:

getFailureCallback in interface ResponseProcessor

Parameters:

druidQuery - The query associated with this failure

Returns:

The callback handler

getErrorCallback

public HttpErrorCallback getErrorCallback(DruidAggregationQuery<?> druidQuery)

Description copied from interface: ResponseProcessor

Callback for handling http errors.

Specified by:

getErrorCallback in interface ResponseProcessor

Parameters:

druidQuery - The query associated with this error

Returns:

The callback handler

processResponse

public void processResponse(com.fasterxml.jackson.databind.JsonNode json,
                            DruidAggregationQuery<?> druidQuery,
                            LoggingContext metadata)

Description copied from interface: ResponseProcessor

Process the response json and respond to the original web request.

Specified by:

processResponse in interface ResponseProcessor

Parameters:

json - The json representing a druid data response

druidQuery - The query with the schema for processing this response

metadata - The LoggingContext to use

isCacheable

protected boolean isCacheable()

A request is cacheable if it does not refer to partial data.

Returns:

whether request can be cached