com.yahoo.bard.webservice.druid.client.impl

Class AsyncDruidWebServiceImpl

java.lang.Object

com.yahoo.bard.webservice.druid.client.impl.AsyncDruidWebServiceImpl

All Implemented Interfaces:

DruidWebService

public class AsyncDruidWebServiceImpl
extends Object
implements DruidWebService

Represents the druid web service endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
static Function<org.asynchttpclient.Response,com.fasterxml.jackson.databind.JsonNode>	DEFAULT_JSON_NODE_BUILDER_STRATEGY The default JSON builder puts only response body in the JSON response.
static String	DRUID_QUERY_ALL_TIMER
static String	DRUID_QUERY_MAX_TIMER
static String	DRUID_QUERY_TIMER
static String	DRUID_SEGMENT_METADATA_TIMER
static String	DRUID_TIMER
static String	DRUID_WEIGHTED_QUERY_TIMER

Constructor Summary

Constructors

Constructor and Description
AsyncDruidWebServiceImpl(DruidServiceConfig config, org.asynchttpclient.AsyncHttpClient asyncHttpClient, com.fasterxml.jackson.databind.ObjectMapper mapper) Deprecated. We now require a header supplier parameter. Use AsyncDruidWebServiceImpl(DruidServiceConfig, AsyncHttpClient, ObjectMapper, Supplier, Function)
AsyncDruidWebServiceImpl(DruidServiceConfig config, org.asynchttpclient.AsyncHttpClient asyncHttpClient, com.fasterxml.jackson.databind.ObjectMapper mapper, Supplier<Map<String,String>> headersToAppend) IOC constructor.
AsyncDruidWebServiceImpl(DruidServiceConfig config, org.asynchttpclient.AsyncHttpClient asyncHttpClient, com.fasterxml.jackson.databind.ObjectMapper mapper, Supplier<Map<String,String>> headersToAppend, Function<org.asynchttpclient.Response,com.fasterxml.jackson.databind.JsonNode> jsonNodeBuilderStrategy) IOC constructor.
AsyncDruidWebServiceImpl(DruidServiceConfig serviceConfig, com.fasterxml.jackson.databind.ObjectMapper mapper) Deprecated. We now require a header supplier parameter. Use AsyncDruidWebServiceImpl(DruidServiceConfig, AsyncHttpClient, ObjectMapper, Supplier, Function)
AsyncDruidWebServiceImpl(DruidServiceConfig serviceConfig, com.fasterxml.jackson.databind.ObjectMapper mapper, Supplier<Map<String,String>> headersToAppend) Friendly non-DI constructor useful for manual tests.
AsyncDruidWebServiceImpl(DruidServiceConfig serviceConfig, com.fasterxml.jackson.databind.ObjectMapper mapper, Supplier<Map<String,String>> headersToAppend, Function<org.asynchttpclient.Response,com.fasterxml.jackson.databind.JsonNode> jsonNodeBuilderStrategy) Friendly non-DI constructor useful for manual tests.

Method Summary

Modifier and Type	Method and Description
protected DruidServiceConfig	getDruidServiceConfig()
protected com.codahale.metrics.Meter	getExceptionMeter()
protected com.codahale.metrics.Meter	getHttpErrorMeter()
Future<org.asynchttpclient.Response>	getJsonObject(SuccessCallback success, HttpErrorCallback error, FailureCallback failure, String resourcePath) Invokes GET on the druid broker with a callback expecting a JSON Object on success.
DruidServiceConfig	getServiceConfig() Returns the service configuration object for this web service.
Integer	getTimeout() Returns the timeout configured on this web service.
protected boolean	hasError(javax.ws.rs.core.Response.Status status) Return true if response status code indicates an error.
Future<org.asynchttpclient.Response>	postDruidQuery(RequestContext context, SuccessCallback success, HttpErrorCallback error, FailureCallback failure, DruidQuery<?> druidQuery) Serializes the provided query and invokes POST on the druid broker.
protected Future<org.asynchttpclient.Response>	sendRequest(SuccessCallback success, HttpErrorCallback error, FailureCallback failure, org.asynchttpclient.BoundRequestBuilder requestBuilder, String timerName, AtomicLong outstanding) Serializes the provided query and invokes a request on the druid broker.

Methods inherited from class java.lang.Object

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

Field Detail

DRUID_TIMER

public static final String DRUID_TIMER

See Also:

Constant Field Values

DRUID_QUERY_TIMER

public static final String DRUID_QUERY_TIMER

See Also:

Constant Field Values

DRUID_QUERY_ALL_TIMER

public static final String DRUID_QUERY_ALL_TIMER

See Also:

Constant Field Values

DRUID_QUERY_MAX_TIMER

public static final String DRUID_QUERY_MAX_TIMER

See Also:

Constant Field Values

DRUID_WEIGHTED_QUERY_TIMER

public static final String DRUID_WEIGHTED_QUERY_TIMER

See Also:

Constant Field Values

DRUID_SEGMENT_METADATA_TIMER

public static final String DRUID_SEGMENT_METADATA_TIMER

See Also:

Constant Field Values

DEFAULT_JSON_NODE_BUILDER_STRATEGY

public static final Function<org.asynchttpclient.Response,com.fasterxml.jackson.databind.JsonNode> DEFAULT_JSON_NODE_BUILDER_STRATEGY

The default JSON builder puts only response body in the JSON response.

Constructor Detail

AsyncDruidWebServiceImpl

@Deprecated
public AsyncDruidWebServiceImpl(DruidServiceConfig serviceConfig,
                                            com.fasterxml.jackson.databind.ObjectMapper mapper)

Deprecated. We now require a header supplier parameter. Use AsyncDruidWebServiceImpl(DruidServiceConfig, AsyncHttpClient, ObjectMapper, Supplier, Function)

Friendly non-DI constructor useful for manual tests.

Parameters:

serviceConfig - Configuration for the Druid Service

mapper - A shared jackson object mapper resource

AsyncDruidWebServiceImpl

@Deprecated
public AsyncDruidWebServiceImpl(DruidServiceConfig config,
                                            org.asynchttpclient.AsyncHttpClient asyncHttpClient,
                                            com.fasterxml.jackson.databind.ObjectMapper mapper)

Deprecated. We now require a header supplier parameter. Use AsyncDruidWebServiceImpl(DruidServiceConfig, AsyncHttpClient, ObjectMapper, Supplier, Function)

IOC constructor.

Parameters:

config - the configuration for this druid service

asyncHttpClient - the HTTP client

mapper - A shared jackson object mapper resource

AsyncDruidWebServiceImpl

public AsyncDruidWebServiceImpl(DruidServiceConfig serviceConfig,
                                com.fasterxml.jackson.databind.ObjectMapper mapper,
                                Supplier<Map<String,String>> headersToAppend)

Friendly non-DI constructor useful for manual tests.

This constructor uses default JSON builder, which only uses response body to build the JSON response.

Parameters:

serviceConfig - Configuration for the Druid Service

mapper - A shared jackson object mapper resource

headersToAppend - Supplier for map of headers for Druid requests

AsyncDruidWebServiceImpl

public AsyncDruidWebServiceImpl(DruidServiceConfig serviceConfig,
                                com.fasterxml.jackson.databind.ObjectMapper mapper,
                                Supplier<Map<String,String>> headersToAppend,
                                Function<org.asynchttpclient.Response,com.fasterxml.jackson.databind.JsonNode> jsonNodeBuilderStrategy)

Friendly non-DI constructor useful for manual tests.

Parameters:

serviceConfig - Configuration for the Druid Service

mapper - A shared jackson object mapper resource

headersToAppend - Supplier for map of headers for Druid requests

jsonNodeBuilderStrategy - A function to build JSON nodes from the response

AsyncDruidWebServiceImpl

public AsyncDruidWebServiceImpl(DruidServiceConfig config,
                                org.asynchttpclient.AsyncHttpClient asyncHttpClient,
                                com.fasterxml.jackson.databind.ObjectMapper mapper,
                                Supplier<Map<String,String>> headersToAppend)

IOC constructor.

This constructor uses default JSON builder, which only uses response body to build the JSON response.

Parameters:

config - the configuration for this druid service

asyncHttpClient - the HTTP client

mapper - A shared jackson object mapper resource

headersToAppend - Supplier for map of headers for Druid requests

AsyncDruidWebServiceImpl

public AsyncDruidWebServiceImpl(DruidServiceConfig config,
                                org.asynchttpclient.AsyncHttpClient asyncHttpClient,
                                com.fasterxml.jackson.databind.ObjectMapper mapper,
                                Supplier<Map<String,String>> headersToAppend,
                                Function<org.asynchttpclient.Response,com.fasterxml.jackson.databind.JsonNode> jsonNodeBuilderStrategy)

IOC constructor.

Parameters:

config - the configuration for this druid service

asyncHttpClient - the HTTP client

mapper - A shared jackson object mapper resource

headersToAppend - Supplier for map of headers for Druid requests

jsonNodeBuilderStrategy - A function to build JSON nodes from the response

Method Detail

sendRequest

protected Future<org.asynchttpclient.Response> sendRequest(SuccessCallback success,
                                                           HttpErrorCallback error,
                                                           FailureCallback failure,
                                                           org.asynchttpclient.BoundRequestBuilder requestBuilder,
                                                           String timerName,
                                                           AtomicLong outstanding)

Serializes the provided query and invokes a request on the druid broker.

Parameters:

success - callback for handling successful requests.

error - callback for handling http errors.

failure - callback for handling exception failures.

requestBuilder - The bound request builder for the request to be sent.

timerName - The name that distinguishes this request as part of a druid query or segment metadata request

outstanding - The counter that keeps track of the outstanding (in flight) requests for the top level query

Returns:

a future response for the query being sent

getJsonObject

public Future<org.asynchttpclient.Response> getJsonObject(SuccessCallback success,
                                                          HttpErrorCallback error,
                                                          FailureCallback failure,
                                                          String resourcePath)

Description copied from interface: DruidWebService

Invokes GET on the druid broker with a callback expecting a JSON Object on success.

Specified by:

getJsonObject in interface DruidWebService

Parameters:

success - callback for handling successful requests.

error - callback for handling http errors.

failure - callback for handling exception failures.

resourcePath - The url suffix for the remote resource. The prefix should be the shared Broker endpoint url.

Returns:

a future response to the get request.

postDruidQuery

public Future<org.asynchttpclient.Response> postDruidQuery(RequestContext context,
                                                           SuccessCallback success,
                                                           HttpErrorCallback error,
                                                           FailureCallback failure,
                                                           DruidQuery<?> druidQuery)

Description copied from interface: DruidWebService

Serializes the provided query and invokes POST on the druid broker.

Specified by:

postDruidQuery in interface DruidWebService

Parameters:

context - The context for the Request.

success - callback for handling successful requests.

error - callback for handling http errors.

failure - callback for handling exception failures.

druidQuery - The druid query object to serialize.

Returns:

a future response to the post query.

getTimeout

public Integer getTimeout()

Description copied from interface: DruidWebService

Returns the timeout configured on this web service.

Specified by:

getTimeout in interface DruidWebService

Returns:

the query timeout in milliseconds

getServiceConfig

public DruidServiceConfig getServiceConfig()

Description copied from interface: DruidWebService

Returns the service configuration object for this web service.

Specified by:

getServiceConfig in interface DruidWebService

Returns:

the service configuration object

getHttpErrorMeter

protected com.codahale.metrics.Meter getHttpErrorMeter()

getExceptionMeter

protected com.codahale.metrics.Meter getExceptionMeter()

getDruidServiceConfig

protected DruidServiceConfig getDruidServiceConfig()

hasError

protected boolean hasError(javax.ws.rs.core.Response.Status status)

Return true if response status code indicates an error.

If etag cache is enabled, no error on 200 OK and 304 NOT-MODIFIED. Otherwise, no error only on 200 OK.

Parameters:

status - The Status object that contains status code to be checked

Returns:

true if the status code indicates an error