AbstractBinderFactory (Fili: parent pom 0.10-SNAPSHOT API)

java.lang.Object
- com.yahoo.bard.webservice.application.AbstractBinderFactory

All Implemented Interfaces:

BinderFactory

Direct Known Subclasses:

GenericBinderFactory, WikiBinderFactory
```
public abstract class AbstractBinderFactory
extends Object
implements BinderFactory
```
Abstract Binder factory implements the standard buildBinder functionality. It is left to individual projects to subclass, providing dimensions config, Metric and Table loading classes.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEPRECATED_PERMISSIVE_AVAILABILITY_FLAG`
`static int`	`DRUID_DIM_LOADER_HC_LAST_RUN_PERIOD_MILLIS`
`static int`	`DRUID_UNCOVERED_INTERVAL_LIMIT`
`static int`	`HC_LAST_RUN_PERIOD_MILLIS_DEFAULT`
`static String`	`HEALTH_CHECK_NAME_DATASOURCE_METADATA`
`static String`	`HEALTH_CHECK_NAME_DIMENSION`
`static String`	`HEALTH_CHECK_NAME_DRUID_DIM_LOADER`
`static String`	`HEALTH_CHECK_NAME_LOOKUP_METADATA`
`static String`	`HEALTH_CHECK_VERSION`
`static int`	`LOADER_SCHEDULER_THREAD_POOL_SIZE`
`static int`	`LOADER_SCHEDULER_THREAD_POOL_SIZE_DEFAULT`
`static int`	`SEG_LOADER_HC_LAST_RUN_PERIOD_MILLIS`
`static String`	`SYSTEM_CONFIG_TIMEZONE_KEY`

Constructor Summary

Constructors
Constructor and Description

AbstractBinderFactory()
Constructor.

Constructors
Constructor and Description
`AbstractBinderFactory()` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`afterBinding(org.glassfish.hk2.utilities.binding.AbstractBinder abstractBinder)` Allows additional app-specific binding.
`void`	`afterRegistration(ResourceConfig resourceConfig)` Allows additional app-specific Jersey feature registration and config.
`protected ApiJobStore`	`buildApiJobStore()` Builds an instance of the interface to the storage system to use to store metadata about asynchronous requests.
`org.glassfish.hk2.utilities.Binder`	`buildBinder()` Build an hk2 Binder instance.
`protected BroadcastChannel<String>`	`buildBroadcastChannel()` Builds an instance of a BroadcastChannel that broadcasts the tickets of asynchronous jobs that have been successfully stored in the PreResponseStore .
`protected DataCache<?>`	`buildCache()` Build a cache for data requests and matching responses.
`protected ConfigurationLoader`	`buildConfigurationLoader(DimensionLoader dimensionLoader, MetricLoader metricLoader, TableLoader tableLoader)` Extension point for building custom Configuration Loaders.
`protected DataApiRequestFactory`	`buildDataApiRequestFactory()` Creates an factory that constructs DataApiRequests .
`protected DataSourceMetadataLoadTask`	`buildDataSourceMetadataLoader(DruidWebService webService, PhysicalTableDictionary physicalTableDictionary, DataSourceMetadataService metadataService, com.fasterxml.jackson.databind.ObjectMapper mapper)` Build a datasource metadata loader.
`protected DimensionValueLoadTask`	`buildDruidDimensionsLoader(DruidWebService webService, PhysicalTableDictionary physicalTableDictionary, DimensionDictionary dimensionDictionary)` Build a DimensionValueLoadTask.
`protected DruidFilterBuilder`	`buildDruidFilterBuilder()` Creates an object that constructs Druid dimension filters from Bard dimension filters.
`protected Class<? extends DruidQueryBuilder>`	`buildDruidQueryBuilder()` Initializes the factory that builds druid queries.
`protected Class<? extends DruidResponseParser>`	`buildDruidResponseParser()` Initializes the class that parses responses from Druid.
`protected DruidWebService`	`buildDruidWebService(DruidServiceConfig druidServiceConfig, com.fasterxml.jackson.databind.ObjectMapper mapper)` Create a DruidWebService.
`protected DruidWebService`	`buildDruidWebService(com.fasterxml.jackson.databind.ObjectMapper mapper)` Create a DruidWebService for the UI connection.
`protected Supplier<Map<String,String>>`	`buildDruidWebServiceHeaderSupplier()` Build the Supplier for Druid data request headers.
`protected HavingGenerator`	`buildHavingGenerator(ConfigurationLoader loader)` Creates an object that generates map of Api Having from having string.
`protected JobPayloadBuilder`	`buildJobPayloadBuilder()` The Builder to be used to serialize a JobRow into the the job to be returned to the user.
`protected JobRowBuilder`	`buildJobRowBuilder()` Initializes the service for building JobRows based on the information in a query.
`protected RegisteredLookupMetadataLoadTask`	`buildLookupMetaDataLoader(DruidWebService webService, DimensionDictionary dimensionDictionary)` Builds a lookup metadata loader.
`protected DruidWebService`	`buildMetadataDruidWebService(com.fasterxml.jackson.databind.ObjectMapper mapper)` Create a DruidWebService for metadata.
`protected DruidWebService`	`buildNonUiDruidWebService(com.fasterxml.jackson.databind.ObjectMapper mapper)` Deprecated. removed non-ui webservice, this method is no longer used
`protected PreResponseStore`	`buildPreResponseStore(ResourceDictionaries resourceDictionaries)` Builds an instance of the interface to the storage system to use to store PreResponses of asynchronous requests.
`protected QuerySigningService<?>`	`buildQuerySigningService(PhysicalTableDictionary physicalTableDictionary, DataSourceMetadataService dataSourceMetadataService)` Build a QuerySigningService.
`protected RateLimiter`	`buildRateLimiter()` Creates a new RateLimiter for the RateLimitFilter.
`protected ResponseFormatResolver`	`buildResponseFormatResolver()` Create a ResponseFormatResolver for Servlet objects.
`protected Class<? extends ResponseProcessorFactory>`	`buildResponseProcessorFactory()` Returns the class to bind to `ResponseProcessorFactory`.
`protected ResponseWriter`	`buildResponseWriter(ObjectMappersSuite mappers)` Builder for ResponseWriter, a serializer allowing customized response from Fili.
`protected Map<Class,RequestedIntervalsFunction>`	`buildSigningFunctions()` Build a Map of Class to Function that should be used to get requestedIntervals from the DruidQuery.
`protected List<FeatureFlag>`	`collectFeatureFlags()` Asks for the valid feature flags that are expected to be defined in the system.
`protected List<FeatureFlag>`	`collectFeatureFlags(Class<? extends FeatureFlag>... enumerations)` Given specific enumeration classes containing feature flags it returns a list with all the valid enumerations.
`protected List<FeatureFlag>`	`collectFeatureFlags(List<Class<? extends FeatureFlag>> enumerations)` Given a list of enumeration classes containing feature flags it returns a list with all the valid enumerations.
`protected void`	`finalize()` Make sure the scheduler for loader tasks shuts down when the resources of this class are released.
`protected Class<? extends AsynchronousWorkflowsBuilder>`	`getAsynchronousProcessBuilder()` Initializes the factory that builds the asynchronous PreResponse processing workflow.
`protected Clock`	`getClock()` Returns a clock for generating instants for timestamps.
`protected ConfigurationLoader`	`getConfigurationLoader()` Get the application specific configuration loader, if not exist already, initialize with pluggable loaders.
`protected DataSourceMetadataService`	`getDataSourceMetadataService()` Get the stored metadata service, if not exist yet, create the service and store it.
`protected abstract Set<DimensionConfig>`	`getDimensionConfigurations()` A set of all dimension configurations for this application.
`protected DimensionLoader`	`getDimensionLoader()` Create a Dimension Loader which will populate the dimensionDictionary.
`protected GranularityDictionary`	`getGranularityDictionary()` Extension point for building a dictionary of base granularities for use in the system.
`protected Class<? extends GranularityParser>`	`getGranularityParser()` Extension point for selecting GranularityParser implementations.
`protected Class<? extends HttpResponseMaker>`	`getHttpResponseMaker()` Initializes the factory that builds HttpResponseMaker.
`protected com.fasterxml.jackson.databind.ObjectMapper`	`getMapper()` Return the instance of ObjectMapper defined in the current ObjectMappersSuite.
`protected ObjectMappersSuite`	`getMappers()` Build an ObjectMappersSuite for everyone to use, since they are heavy-weight.
`protected abstract MetricLoader`	`getMetricLoader()` Create a Metric Loader.
`protected Class<? extends PhysicalTableResolver>`	`getPhysicalTableResolver()` Select a physical table resolver class.
`protected Map<String,RequestMapper>`	`getRequestMappers(ResourceDictionaries resourceDictionaries)` Get a map of named RequestMappers.
`protected abstract TableLoader`	`getTableLoader()` Create a Table Loader.
`protected VolatileIntervalsService`	`getVolatileIntervalsService()` Initialize the service that decides which intervals in a request are volatile relative to a physical table.
`protected Class<? extends RequestWorkflowProvider>`	`getWorkflow()` Return a workflow class to bind to RequestWorkflowProvider.
`protected MetricsFilterSetBuilder`	`initializeMetricsFilterSetBuilder()` Initialize the FilteredMetricsHelper.
`protected PreResponseDeserializer`	`initializePreResponseDeserializer(DimensionDictionary dimensionDictionary, com.fasterxml.jackson.databind.ObjectMapper nonResponseContextMapper, com.fasterxml.jackson.databind.ObjectMapper responseContextMapper, GranularityParser granularityParser)` Initialize the PreResponse deserializer to deserialize the custom serialized PreResponse.
`protected FieldConverters`	`initializeSketchConverter()` Initialize the field converter.
`protected void`	`scheduleLoader(LoadTask<?> loadTask)` Schedule a loadTask task.
`protected void`	`setupDataSourceMetaData(com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry, DataSourceMetadataLoadTask dataSourceMetadataLoader)` Schedule a datasource metadata loader and register its health check.
`protected void`	`setupDruidDimensionsLoader(com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry, DimensionValueLoadTask dataDimensionLoader)` Schedule DimensionValueLoadTask and register its health check.
`protected void`	`setupGauges()` Register global gauges.
`protected void`	`setupHealthChecks(com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry, DimensionDictionary dimensionDictionary)` Register required core health checks.
`protected void`	`setupLookUpMetadataLoader(com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry, RegisteredLookupMetadataLoadTask registeredLookupMetadataLoadTask)` Schedule a lookup metadata loader and register its health check.
`protected void`	`shutdownLoaderScheduler()` Shutdown the scheduler for loader tasks.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HEALTH_CHECK_NAME_DATASOURCE_METADATA
```
public static final String HEALTH_CHECK_NAME_DATASOURCE_METADATA
```
    See Also:
    
    Constant Field Values
  - HEALTH_CHECK_NAME_LOOKUP_METADATA
```
public static final String HEALTH_CHECK_NAME_LOOKUP_METADATA
```
    See Also:
    
    Constant Field Values
  - HEALTH_CHECK_NAME_DRUID_DIM_LOADER
```
public static final String HEALTH_CHECK_NAME_DRUID_DIM_LOADER
```
    See Also:
    
    Constant Field Values
  - HEALTH_CHECK_VERSION
```
public static final String HEALTH_CHECK_VERSION
```
    See Also:
    
    Constant Field Values
  - HEALTH_CHECK_NAME_DIMENSION
```
public static final String HEALTH_CHECK_NAME_DIMENSION
```
    See Also:
    
    Constant Field Values
  - HC_LAST_RUN_PERIOD_MILLIS_DEFAULT
```
public static final int HC_LAST_RUN_PERIOD_MILLIS_DEFAULT
```
    See Also:
    
    Constant Field Values
  - LOADER_SCHEDULER_THREAD_POOL_SIZE_DEFAULT
```
public static final int LOADER_SCHEDULER_THREAD_POOL_SIZE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - SEG_LOADER_HC_LAST_RUN_PERIOD_MILLIS
```
public static final int SEG_LOADER_HC_LAST_RUN_PERIOD_MILLIS
```
  - DRUID_DIM_LOADER_HC_LAST_RUN_PERIOD_MILLIS
```
public static final int DRUID_DIM_LOADER_HC_LAST_RUN_PERIOD_MILLIS
```
  - LOADER_SCHEDULER_THREAD_POOL_SIZE
```
public static final int LOADER_SCHEDULER_THREAD_POOL_SIZE
```
  - DEPRECATED_PERMISSIVE_AVAILABILITY_FLAG
```
public static final String DEPRECATED_PERMISSIVE_AVAILABILITY_FLAG
```
  - DRUID_UNCOVERED_INTERVAL_LIMIT
```
public static final int DRUID_UNCOVERED_INTERVAL_LIMIT
```
  - SYSTEM_CONFIG_TIMEZONE_KEY
```
public static final String SYSTEM_CONFIG_TIMEZONE_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractBinderFactory
```
public AbstractBinderFactory()
```
    Constructor.
- Method Detail
  - buildBinder
```
public final org.glassfish.hk2.utilities.Binder buildBinder()
```
    Description copied from interface: BinderFactory
    
    Build an hk2 Binder instance. This binder should bind all data dictionaries after loading them, as well as UI/NonUI web services, Partial Data polling and Health Check metrics
    
    Specified by:
    
    buildBinder in interface BinderFactory
    
    Returns:
    
    A binder instance
  - buildDruidQueryBuilder
```
protected Class<? extends DruidQueryBuilder> buildDruidQueryBuilder()
```
    Initializes the factory that builds druid queries.
    
    Returns:
    
    An isntance of the DruidQueryBuilder
  - buildDruidResponseParser
```
protected Class<? extends DruidResponseParser> buildDruidResponseParser()
```
    Initializes the class that parses responses from Druid.
    
    Returns:
    
    An instance of the DruidResponseParser
  - getClock
```
protected Clock getClock()
```
    Returns a clock for generating instants for timestamps.
    
    Returns:
    
    The clock with which to generate instants for timestamps, by default uses the system clock with the system timezone
  - getAsynchronousProcessBuilder
```
protected Class<? extends AsynchronousWorkflowsBuilder> getAsynchronousProcessBuilder()
```
    Initializes the factory that builds the asynchronous PreResponse processing workflow.
    
    Returns:
    
    An instance of the DefaultAsynchronousWorkflowsBuilder
  - buildJobRowBuilder
```
protected JobRowBuilder buildJobRowBuilder()
```
    Initializes the service for building JobRows based on the information in a query.
    
    Returns:
    
    A factory for building JobRows, by default the factory builds a JobRow containing the fields enumerated in DefaultJobField, using ids that are the concatenation of the user id with a uuid generated by UUID.randomUUID().
  - buildPreResponseStore
```
protected PreResponseStore buildPreResponseStore(ResourceDictionaries resourceDictionaries)
```
    Builds an instance of the interface to the storage system to use to store PreResponses of asynchronous requests.
    
    Parameters:
    
    resourceDictionaries - Hold the resource dictionaries
    
    Returns:
    
    An instance of the interface that allows Bard to talk to an arbitrary key-value store system for storing PreResponses, by default this returns a NoOpPreResponseStore, which does nothing
  - buildApiJobStore
```
protected ApiJobStore buildApiJobStore()
```
    Builds an instance of the interface to the storage system to use to store metadata about asynchronous requests.
    
    Returns:
    
    An instance of the interface that allows Bard to talk to an arbitrary key-value store system for storing job metadata, by default this returns a NoOpApiJobStore, which does nothing
  - buildBroadcastChannel
```
protected BroadcastChannel<String> buildBroadcastChannel()
```
    Builds an instance of a BroadcastChannel that broadcasts the tickets of asynchronous jobs that have been successfully stored in the PreResponseStore .
    
    Returns:
    
    A BroadcastChannel that allows Bard to talk to other Bard processes, by default returns the SimpleBroadcastChannel, which uses a PublishSubject to allow cross-thread communication
  - initializePreResponseDeserializer
```
protected PreResponseDeserializer initializePreResponseDeserializer(DimensionDictionary dimensionDictionary,
                                                                    com.fasterxml.jackson.databind.ObjectMapper nonResponseContextMapper,
                                                                    com.fasterxml.jackson.databind.ObjectMapper responseContextMapper,
                                                                    GranularityParser granularityParser)
```
    Initialize the PreResponse deserializer to deserialize the custom serialized PreResponse.
    
    Parameters:
    
    dimensionDictionary - Contains all the dimension details
    
    nonResponseContextMapper - ObjectMapper instance without any customization
    
    responseContextMapper - ObjectMapper instance with customization to store/retrieve the value type
    
    granularityParser - Granularity parser to get the time id
    
    Returns:
    
    instance of PreResponse deserializer
  - getVolatileIntervalsService
```
protected VolatileIntervalsService getVolatileIntervalsService()
```
    Initialize the service that decides which intervals in a request are volatile relative to a physical table. By default, returns a `VolatileIntervalsService` that assumes none of the physical tables have any volatile intervals.
    
    Returns:
    
    A service for determining which intervals in a request are volatile relative to a physical table
  - initializeSketchConverter
```
protected FieldConverters initializeSketchConverter()
```
    Initialize the field converter. By default it is SketchFieldConverter
    
    Returns:
    
    An instance of SketchFieldConverter
  - initializeMetricsFilterSetBuilder
```
protected MetricsFilterSetBuilder initializeMetricsFilterSetBuilder()
```
    Initialize the FilteredMetricsHelper. By default it is FilteredSketchMetricsHelper
    
    Returns:
    
    An instance of FilteredSketchMetricsHelper
  - getMappers
```
protected final ObjectMappersSuite getMappers()
```
    Build an ObjectMappersSuite for everyone to use, since they are heavy-weight.
    
    Returns:
    
    The instance of ObjectMappersSuite
  - getMapper
```
protected final com.fasterxml.jackson.databind.ObjectMapper getMapper()
```
    Return the instance of ObjectMapper defined in the current ObjectMappersSuite.
    
    Returns:
    
    The instance of ObjectMapper
  - setupHealthChecks
```
protected final void setupHealthChecks(com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry,
                                       DimensionDictionary dimensionDictionary)
```
    Register required core health checks.
    
    Parameters:
    
    healthCheckRegistry - The health check registry
    
    dimensionDictionary - The container with all dimensions
  - setupGauges
```
protected final void setupGauges()
```
    Register global gauges.
  - buildDruidFilterBuilder
```
protected DruidFilterBuilder buildDruidFilterBuilder()
```
    Creates an object that constructs Druid dimension filters from Bard dimension filters. Constructs a DefaultDruidFilterBuilder by default.
    
    Returns:
    
    An object to build Druid filters from API filters
  - buildDataApiRequestFactory
```
protected DataApiRequestFactory buildDataApiRequestFactory()
```
    Creates an factory that constructs DataApiRequests . Constructs a DefaultDataApiRequestFactory by default.
    
    Returns:
    
    An object to build Druid filters from API filters
  - buildHavingGenerator
```
protected HavingGenerator buildHavingGenerator(ConfigurationLoader loader)
```
    Creates an object that generates map of Api Having from having string. Constructs a DefaultHavingApiGenerator by default.
    
    Parameters:
    
    loader - Configuration loader that connects resource dictionaries with the loader.
    
    Returns:
    
    An object to generate having maps from having string.
  - getDataSourceMetadataService
```
protected DataSourceMetadataService getDataSourceMetadataService()
```
    Get the stored metadata service, if not exist yet, create the service and store it.
    
    Returns:
    
    A datasource metadata service
  - buildQuerySigningService
```
protected QuerySigningService<?> buildQuerySigningService(PhysicalTableDictionary physicalTableDictionary,
                                                          DataSourceMetadataService dataSourceMetadataService)
```
    Build a QuerySigningService.
    
    Parameters:
    
    physicalTableDictionary - the dictionary of physical tables
    
    dataSourceMetadataService - A datasource metadata service
    
    Returns:
    
    A QuerySigningService
  - buildSigningFunctions
```
protected Map<Class,RequestedIntervalsFunction> buildSigningFunctions()
```
    Build a Map of Class to Function that should be used to get requestedIntervals from the DruidQuery.
    
    Returns:
    
    A Map that maps Class to a function that computes the requested intervals for a Druid query of that particular Class
  - buildDataSourceMetadataLoader
```
protected DataSourceMetadataLoadTask buildDataSourceMetadataLoader(DruidWebService webService,
                                                                   PhysicalTableDictionary physicalTableDictionary,
                                                                   DataSourceMetadataService metadataService,
                                                                   com.fasterxml.jackson.databind.ObjectMapper mapper)
```
    Build a datasource metadata loader.
    
    Parameters:
    
    webService - The web service used by the loader to query druid for segments availability.
    
    physicalTableDictionary - The table to get the dimensions from.
    
    metadataService - The service to be used to store the datasource metadata.
    
    mapper - The object mapper to process the metadata json.
    
    Returns:
    
    A datasource metadata loader.
  - buildLookupMetaDataLoader
```
protected RegisteredLookupMetadataLoadTask buildLookupMetaDataLoader(DruidWebService webService,
                                                                     DimensionDictionary dimensionDictionary)
```
    Builds a lookup metadata loader.
    
    Parameters:
    
    webService - The web service used by the loader to query druid for lookup statuses.
    
    dimensionDictionary - A DimensionDictionary that is used to obtain a list of lookups in Fili.
    
    Returns:
    
    a lookup metadata loader
  - buildDruidDimensionsLoader
```
protected DimensionValueLoadTask buildDruidDimensionsLoader(DruidWebService webService,
                                                            PhysicalTableDictionary physicalTableDictionary,
                                                            DimensionDictionary dimensionDictionary)
```
    Build a DimensionValueLoadTask.
    
    Parameters:
    
    webService - The web service used by the loader to query dimension values
    
    physicalTableDictionary - The table to update dimensions on
    
    dimensionDictionary - The dimensions to update
    
    Returns:
    
    A DimensionValueLoadTask
  - setupDataSourceMetaData
```
protected final void setupDataSourceMetaData(com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry,
                                             DataSourceMetadataLoadTask dataSourceMetadataLoader)
```
    Schedule a datasource metadata loader and register its health check.
    
    Parameters:
    
    healthCheckRegistry - The health check registry to register partial data health checks.
    
    dataSourceMetadataLoader - The datasource metadata loader to use.
  - setupLookUpMetadataLoader
```
protected final void setupLookUpMetadataLoader(com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry,
                                               RegisteredLookupMetadataLoadTask registeredLookupMetadataLoadTask)
```
    Schedule a lookup metadata loader and register its health check.
    
    Parameters:
    
    healthCheckRegistry - The health check registry to register lookup health checks.
    
    registeredLookupMetadataLoadTask - The RegisteredLookupMetadataLoadTask to use.
  - setupDruidDimensionsLoader
```
protected final void setupDruidDimensionsLoader(com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry,
                                                DimensionValueLoadTask dataDimensionLoader)
```
    Schedule DimensionValueLoadTask and register its health check.
    
    Parameters:
    
    healthCheckRegistry - The health check registry to register Dimension lookup health checks
    
    dataDimensionLoader - The DruidDimensionLoader used for monitoring and health checks
  - getWorkflow
```
protected Class<? extends RequestWorkflowProvider> getWorkflow()
```
    Return a workflow class to bind to RequestWorkflowProvider.
    
    Returns:
    
    a workflow class
  - buildCache
```
protected DataCache<?> buildCache()
```
    Build a cache for data requests and matching responses.
    
    Returns:
    
    The cache instance
  - collectFeatureFlags
```
protected List<FeatureFlag> collectFeatureFlags()
```
    Asks for the valid feature flags that are expected to be defined in the system. This method is also provided as an extension point for classes that need to add their own feature flags. Such an extension is made easy when one of the final version of the method is used. For example:
```
  @Override protected  List<FeatureFlag> collectFeatureFlags() {
      return collectFeatureFlags(AdditionalFeatureFlags.class);
 }
 
```
    Returns:
    
    The list of valid feature flags
  - collectFeatureFlags
```
@SafeVarargs
protected final List<FeatureFlag> collectFeatureFlags(Class<? extends FeatureFlag>... enumerations)
```
    Given specific enumeration classes containing feature flags it returns a list with all the valid enumerations.
    
    Parameters:
    
    enumerations - The enumeration classes that define feature flags
    
    Returns:
    
    The list of valid feature flags
  - collectFeatureFlags
```
protected final List<FeatureFlag> collectFeatureFlags(List<Class<? extends FeatureFlag>> enumerations)
```
    Given a list of enumeration classes containing feature flags it returns a list with all the valid enumerations.
    
    Parameters:
    
    enumerations - A list with the enumeration classes that define feature flags
    
    Returns:
    
    A list with all the defined feature flags
  - getConfigurationLoader
```
protected final ConfigurationLoader getConfigurationLoader()
```
    Get the application specific configuration loader, if not exist already, initialize with pluggable loaders.
    
    Returns:
    
    A configuration loader instance
  - buildConfigurationLoader
```
protected ConfigurationLoader buildConfigurationLoader(DimensionLoader dimensionLoader,
                                                       MetricLoader metricLoader,
                                                       TableLoader tableLoader)
```
    Extension point for building custom Configuration Loaders.
    
    Parameters:
    
    dimensionLoader - A dimension loader
    
    metricLoader - A metric loader
    
    tableLoader - A table loader
    
    Returns:
    
    A configurationLoader instance
  - getDimensionLoader
```
protected DimensionLoader getDimensionLoader()
```
    Create a Dimension Loader which will populate the dimensionDictionary. The default Dimension Loader builds KeyValueStore Dimensions which are configured via the getDimensionConfigurations() method.
    
    Returns:
    
    a Dimension Loader instance
  - buildJobPayloadBuilder
```
protected JobPayloadBuilder buildJobPayloadBuilder()
```
    The Builder to be used to serialize a JobRow into the the job to be returned to the user.
    
    Returns:
    
    A DefaultJobPayloadBuilder
  - getHttpResponseMaker
```
protected Class<? extends HttpResponseMaker> getHttpResponseMaker()
```
    Initializes the factory that builds HttpResponseMaker.
    
    Returns:
    
    an instance of the HttpResponseMaker
  - buildResponseWriter
```
protected ResponseWriter buildResponseWriter(ObjectMappersSuite mappers)
```
    Builder for ResponseWriter, a serializer allowing customized response from Fili.
    
    Parameters:
    
    mappers - Shared instance of ObjectMapper
    
    Returns:
    
    FiliResponseWriter
  - getMetricLoader
```
protected abstract MetricLoader getMetricLoader()
```
    Create a Metric Loader.
    Metric loader populates the metricDictionary
    
    Returns:
    
    a metric loader instance
  - getDimensionConfigurations
```
protected abstract Set<DimensionConfig> getDimensionConfigurations()
```
    A set of all dimension configurations for this application.
    These dimension configurations will be used to build the dimensions dictionary
    
    Returns:
    
    A set of configuration objects describing dimensions
  - getGranularityDictionary
```
protected GranularityDictionary getGranularityDictionary()
```
    Extension point for building a dictionary of base granularities for use in the system.
    
    Returns:
    
    A map of time grain api name (forced to lowercase) to time grain instances.
  - getGranularityParser
```
protected Class<? extends GranularityParser> getGranularityParser()
```
    Extension point for selecting GranularityParser implementations.
    
    Returns:
    
    A granularity parser instance
  - getPhysicalTableResolver
```
protected Class<? extends PhysicalTableResolver> getPhysicalTableResolver()
```
    Select a physical table resolver class.
    
    Returns:
    
    A table resolver implementation
  - getTableLoader
```
protected abstract TableLoader getTableLoader()
```
    Create a Table Loader.
    Table loader populates the physicalTableDictionary and logicalTableDictionary
    
    Returns:
    
    A table loader instance
  - getRequestMappers
```
@NotNull
protected Map<String,RequestMapper> getRequestMappers(ResourceDictionaries resourceDictionaries)
```
    Get a map of named RequestMappers.
    Create an empty map by default
    
    Parameters:
    
    resourceDictionaries - the ResourceDictionaries used for constructing RequestMappers
    
    Returns:
    
    A map where the key is the name of the requestMapper for binding, and value is the requestMapper
  - buildDruidWebService
```
protected DruidWebService buildDruidWebService(DruidServiceConfig druidServiceConfig,
                                               com.fasterxml.jackson.databind.ObjectMapper mapper)
```
    Create a DruidWebService.
    Provided so subclasses can implement alternative druid web service implementations
    
    Parameters:
    
    druidServiceConfig - Configuration for the Druid Service
    
    mapper - shared instance of ObjectMapper
    
    Returns:
    
    A DruidWebService
  - buildDruidWebServiceHeaderSupplier
```
protected Supplier<Map<String,String>> buildDruidWebServiceHeaderSupplier()
```
    Build the Supplier for Druid data request headers.
    
    Returns:
    
    The Druid data request header Supplier.
  - buildDruidWebService
```
protected DruidWebService buildDruidWebService(com.fasterxml.jackson.databind.ObjectMapper mapper)
```
    Create a DruidWebService for the UI connection.
    Provided so subclasses can implement alternative druid web service implementations for the UI connection
    
    Parameters:
    
    mapper - shared instance of ObjectMapper
    
    Returns:
    
    A DruidWebService
  - buildNonUiDruidWebService
```
@Deprecated
protected DruidWebService buildNonUiDruidWebService(com.fasterxml.jackson.databind.ObjectMapper mapper)
```
    Deprecated. removed non-ui webservice, this method is no longer used
    
    Create a DruidWebService for the non-UI connection.
    Provided so subclasses can implement alternative druid web service implementations for the non-UI connection
    
    Parameters:
    
    mapper - shared instance of ObjectMapper
    
    Returns:
    
    A DruidWebService
  - buildMetadataDruidWebService
```
protected DruidWebService buildMetadataDruidWebService(com.fasterxml.jackson.databind.ObjectMapper mapper)
```
    Create a DruidWebService for metadata.
    
    Parameters:
    
    mapper - shared instance of ObjectMapper
    
    Returns:
    
    A DruidWebService
  - buildResponseFormatResolver
```
protected ResponseFormatResolver buildResponseFormatResolver()
```
    Create a ResponseFormatResolver for Servlet objects.
    Currently default types are json, jsonapi and csv types.
    
    Returns:
    
    A ResponseFormatResolver
  - buildResponseProcessorFactory
```
protected Class<? extends ResponseProcessorFactory> buildResponseProcessorFactory()
```
    Returns the class to bind to ResponseProcessorFactory.
    The ResponseProcessorFactory allows us to inject a custom ResponseProcessor despite the fact that these processors depend on objects that are built uniquely for each request.
    
    Returns:
    
    A class that implements ResponseProcessorFactory.
  - buildRateLimiter
```
protected RateLimiter buildRateLimiter()
```
    Creates a new RateLimiter for the RateLimitFilter.
    
    Returns:
    
    a RateLimiter implementation
  - afterRegistration
```
public void afterRegistration(ResourceConfig resourceConfig)
```
    Description copied from interface: BinderFactory
    
    Allows additional app-specific Jersey feature registration and config.
    
    Specified by:
    
    afterRegistration in interface BinderFactory
    
    Parameters:
    
    resourceConfig - Resource config to use for accessing the configuration
  - afterBinding
```
protected void afterBinding(org.glassfish.hk2.utilities.binding.AbstractBinder abstractBinder)
```
    Allows additional app-specific binding.
    
    Parameters:
    
    abstractBinder - Binder to use for binding
  - scheduleLoader
```
protected void scheduleLoader(LoadTask<?> loadTask)
```
    Schedule a loadTask task.
    
    Parameters:
    
    loadTask - The loadTask task to run.
  - shutdownLoaderScheduler
```
protected void shutdownLoaderScheduler()
```
    Shutdown the scheduler for loader tasks.
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Make sure the scheduler for loader tasks shuts down when the resources of this class are released.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - An exception raised by this method.

Class AbstractBinderFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HEALTH_CHECK_NAME_DATASOURCE_METADATA

HEALTH_CHECK_NAME_LOOKUP_METADATA

HEALTH_CHECK_NAME_DRUID_DIM_LOADER

HEALTH_CHECK_VERSION

HEALTH_CHECK_NAME_DIMENSION

HC_LAST_RUN_PERIOD_MILLIS_DEFAULT

LOADER_SCHEDULER_THREAD_POOL_SIZE_DEFAULT

SEG_LOADER_HC_LAST_RUN_PERIOD_MILLIS

DRUID_DIM_LOADER_HC_LAST_RUN_PERIOD_MILLIS

LOADER_SCHEDULER_THREAD_POOL_SIZE

DEPRECATED_PERMISSIVE_AVAILABILITY_FLAG

DRUID_UNCOVERED_INTERVAL_LIMIT

SYSTEM_CONFIG_TIMEZONE_KEY

Constructor Detail

AbstractBinderFactory

Method Detail

buildBinder

buildDruidQueryBuilder

buildDruidResponseParser

getClock

getAsynchronousProcessBuilder

buildJobRowBuilder

buildPreResponseStore

buildApiJobStore

buildBroadcastChannel

initializePreResponseDeserializer

getVolatileIntervalsService

initializeSketchConverter

initializeMetricsFilterSetBuilder

getMappers

getMapper

setupHealthChecks

setupGauges

buildDruidFilterBuilder

buildDataApiRequestFactory

buildHavingGenerator

getDataSourceMetadataService

buildQuerySigningService

buildSigningFunctions

buildDataSourceMetadataLoader

buildLookupMetaDataLoader

buildDruidDimensionsLoader

setupDataSourceMetaData

setupLookUpMetadataLoader

setupDruidDimensionsLoader

getWorkflow

buildCache

collectFeatureFlags

collectFeatureFlags

collectFeatureFlags

getConfigurationLoader

buildConfigurationLoader

getDimensionLoader

buildJobPayloadBuilder

getHttpResponseMaker

buildResponseWriter

getMetricLoader

getDimensionConfigurations

getGranularityDictionary

getGranularityParser

getPhysicalTableResolver

getTableLoader

getRequestMappers

buildDruidWebService

buildDruidWebServiceHeaderSupplier

buildDruidWebService

buildNonUiDruidWebService

buildMetadataDruidWebService

buildResponseFormatResolver

buildResponseProcessorFactory

buildRateLimiter

afterRegistration

afterBinding

scheduleLoader