com.lucidworks.apollo.component

Class ConfigurationComponent

java.lang.Object

com.lucidworks.apollo.component.ConfigurationComponent

public class ConfigurationComponent
extends java.lang.Object

This component defines the configuration for a given service. Services will generally extend this component, add their own

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP_VERSION
static java.lang.String	BUILD_NUMBER
static int	DEFAULT_APP_PORT
static java.lang.String	DEFAULT_SEARCH_LOGS_COLLECTION_SUFFIX
static java.lang.String	GIT_COMMIT
static java.lang.String	historyKeyPrefix
static java.lang.String	JOB_HISTORY_COLLECTION_PREFIX
static java.lang.String	LOG_KEY_PREFIX
static java.lang.String	METRICS_INDEXING_ENABLED
static java.lang.String	metricsKeyPrefix
static java.lang.String	MONITOR_KEY_PREFIX
static java.lang.String	QUICKSTART_ENABLED
static java.lang.String	searchLogsClusterNameKeyPrefix
static java.lang.String	SOLR_BUFFER_CONCURRENCY
static java.lang.String	SOLR_BUFFER_FLUSH_INTERVAL
static java.lang.String	SOLR_BUFFER_SIZE
static java.lang.String	SOLR_COMMIT_WITHIN
static java.lang.String	SOLR_ZK_CLIENT_TIMEOUT
static java.lang.String	SOLR_ZK_CONNECT
static java.lang.String	SOLR_ZK_CONNECT_TIMEOUT
int	solrBufferConcurrency
int	solrBufferFlushInterval
int	solrBufferSize
int	solrCommitWithin
int	solrZKClientTimeout
java.lang.String	solrZkConnect
int	solrZkConnectTimeout
static java.lang.String	USAGE_MONITOR
static java.lang.String	USAGE_MONITOR_TEST_MODE

Constructor Summary

Constructors

Constructor and Description
ConfigurationComponent(ZooKeeperConfigurationComponent zkFactory, MetricRegistry metricRegistry) Note that this takes in a ZookeeperConfigurationComponent even though it doesn't use it directly.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAppHome()
java.io.File	getAppHomeDirectory()
java.lang.String	getAppHostname()
int	getAppPort()
java.lang.String	getAppVersion()
java.lang.String	getBindAddress()
boolean	getBoolean(java.lang.String key, boolean defaultValue) Get the value of the property with the given key, or defaultValue if not set.
java.lang.String	getBuildNumber()
java.lang.String	getCollectionFromSignalsCollection(java.lang.String signalsCollection)
java.util.Map<java.lang.String,java.lang.String>	getComponentVersions()
AggregatedConfiguration	getConfiguration() Return the whole configuration.
com.lucidworks.apollo.common.models.SearchCluster	getDefaultSearchCluster()
double	getDouble(java.lang.String key, double defaultValue) Get the value of the property with the given key, or defaultValue if not set.
float	getFloat(java.lang.String key, float defaultValue) Get the value of the property with the given key, or defaultValue if not set.
java.lang.String	getGitCommit()
int	getInt(java.lang.String key, int defaultValue) Get the value of the property with the given key, or defaultValue if not set.
long	getLong(java.lang.String key, long defaultValue) Get the value of the property with the given key, or defaultValue if not set.
static <T> T	getPropertyFromConfigurations(java.lang.String key, T defValue, org.apache.commons.configuration.Configuration... configs) Returns the value of specified key in the first configuration in which it is found and non-null.
java.lang.String	getSearchLogDocIdFieldName(java.lang.String collection)
java.lang.Integer	getSearchLogDocIdLimit(java.lang.String collection)
java.lang.String	getSearchLogsClusterName(java.lang.String collectionId)
java.lang.String	getSearchLogsCollectionName(java.lang.String collection)
java.lang.String	getSolrSignalAggrCollection(java.lang.String collection) Return the name of the aggregated signals collection.
java.lang.String	getSolrSignalCollection(java.lang.String collection) Return the name of the raw signals collection.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Get the value of the property with the given key, or defaultValue if not set.
boolean	hasSsl()
void	init(DefaultSearchClusterRegistrar.DefaultSearchCluster defaultSearchCluster)
boolean	isQuickstartEnabled()
boolean	managedModeEnabled()
boolean	metricsIndexingEnabled()
void	setCallback(java.lang.String key, ConfigurationListener listener) ConfigurationListener will be called when the given configuration key is modified on any node.
void	setOverrideProperty(java.lang.String key, java.lang.Object value)
static java.util.List<java.lang.String>	split(java.lang.String value) Uses the default splitter to split the given value into a list.
boolean	usageMonitorEnabled()
boolean	usageMonitorTestMode()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_APP_PORT

public static final int DEFAULT_APP_PORT

See Also:

Constant Field Values

APP_VERSION

public static final java.lang.String APP_VERSION

See Also:

Constant Field Values

GIT_COMMIT

public static final java.lang.String GIT_COMMIT

See Also:

Constant Field Values

BUILD_NUMBER

public static final java.lang.String BUILD_NUMBER

See Also:

Constant Field Values

SOLR_ZK_CONNECT

public static final java.lang.String SOLR_ZK_CONNECT

solrZkConnect

public java.lang.String solrZkConnect

SOLR_ZK_CLIENT_TIMEOUT

public static final java.lang.String SOLR_ZK_CLIENT_TIMEOUT

See Also:

Constant Field Values

solrZKClientTimeout

public int solrZKClientTimeout

SOLR_ZK_CONNECT_TIMEOUT

public static final java.lang.String SOLR_ZK_CONNECT_TIMEOUT

See Also:

Constant Field Values

solrZkConnectTimeout

public int solrZkConnectTimeout

SOLR_BUFFER_SIZE

public static final java.lang.String SOLR_BUFFER_SIZE

See Also:

Constant Field Values

solrBufferSize

public int solrBufferSize

SOLR_BUFFER_FLUSH_INTERVAL

public static final java.lang.String SOLR_BUFFER_FLUSH_INTERVAL

See Also:

Constant Field Values

solrBufferFlushInterval

public int solrBufferFlushInterval

SOLR_COMMIT_WITHIN

public static final java.lang.String SOLR_COMMIT_WITHIN

See Also:

Constant Field Values

solrCommitWithin

public int solrCommitWithin

SOLR_BUFFER_CONCURRENCY

public static final java.lang.String SOLR_BUFFER_CONCURRENCY

See Also:

Constant Field Values

solrBufferConcurrency

public int solrBufferConcurrency

DEFAULT_SEARCH_LOGS_COLLECTION_SUFFIX

public static final java.lang.String DEFAULT_SEARCH_LOGS_COLLECTION_SUFFIX

See Also:

Constant Field Values

searchLogsClusterNameKeyPrefix

public static final java.lang.String searchLogsClusterNameKeyPrefix

See Also:

Constant Field Values

LOG_KEY_PREFIX

public static final java.lang.String LOG_KEY_PREFIX

See Also:

Constant Field Values

JOB_HISTORY_COLLECTION_PREFIX

public static final java.lang.String JOB_HISTORY_COLLECTION_PREFIX

See Also:

Constant Field Values

MONITOR_KEY_PREFIX

public static final java.lang.String MONITOR_KEY_PREFIX

See Also:

Constant Field Values

USAGE_MONITOR

public static final java.lang.String USAGE_MONITOR

See Also:

Constant Field Values

USAGE_MONITOR_TEST_MODE

public static final java.lang.String USAGE_MONITOR_TEST_MODE

See Also:

Constant Field Values

metricsKeyPrefix

public static final java.lang.String metricsKeyPrefix

See Also:

Constant Field Values

historyKeyPrefix

public static final java.lang.String historyKeyPrefix

See Also:

Constant Field Values

METRICS_INDEXING_ENABLED

public static final java.lang.String METRICS_INDEXING_ENABLED

See Also:

Constant Field Values

QUICKSTART_ENABLED

public static final java.lang.String QUICKSTART_ENABLED

See Also:

Constant Field Values

Constructor Detail

ConfigurationComponent

public ConfigurationComponent(ZooKeeperConfigurationComponent zkFactory,
                              MetricRegistry metricRegistry)

Note that this takes in a ZookeeperConfigurationComponent even though it doesn't use it directly. That's to make sure that ZooKeeperConfigurationComponent has been constructed before this; it will modify the static ConfigurationManager, which this class will use.

Method Detail

getSearchLogsCollectionName

public java.lang.String getSearchLogsCollectionName(java.lang.String collection)

getSearchLogsClusterName

public java.lang.String getSearchLogsClusterName(java.lang.String collectionId)

usageMonitorEnabled

public boolean usageMonitorEnabled()

usageMonitorTestMode

public boolean usageMonitorTestMode()

metricsIndexingEnabled

public boolean metricsIndexingEnabled()

isQuickstartEnabled

public boolean isQuickstartEnabled()

managedModeEnabled

public boolean managedModeEnabled()

getAppVersion

public java.lang.String getAppVersion()

getComponentVersions

public java.util.Map<java.lang.String,java.lang.String> getComponentVersions()

getGitCommit

public java.lang.String getGitCommit()

getBuildNumber

public java.lang.String getBuildNumber()

getAppHostname

public java.lang.String getAppHostname()

getBindAddress

public java.lang.String getBindAddress()

getAppPort

public int getAppPort()

hasSsl

public boolean hasSsl()

getAppHome

public java.lang.String getAppHome()

getAppHomeDirectory

public java.io.File getAppHomeDirectory()

getSolrSignalCollection

public java.lang.String getSolrSignalCollection(java.lang.String collection)

Return the name of the raw signals collection.

getSolrSignalAggrCollection

public java.lang.String getSolrSignalAggrCollection(java.lang.String collection)

Return the name of the aggregated signals collection.

getCollectionFromSignalsCollection

public java.lang.String getCollectionFromSignalsCollection(java.lang.String signalsCollection)

init

@WhenReady
public void init(DefaultSearchClusterRegistrar.DefaultSearchCluster defaultSearchCluster)

getDefaultSearchCluster

public com.lucidworks.apollo.common.models.SearchCluster getDefaultSearchCluster()

getSearchLogDocIdFieldName

public java.lang.String getSearchLogDocIdFieldName(java.lang.String collection)

getSearchLogDocIdLimit

public java.lang.Integer getSearchLogDocIdLimit(java.lang.String collection)

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Get the value of the property with the given key, or defaultValue if not set. In most cases, you shouldn't need to use this method. You can instead annotate fields with @Configuration and let the system bind the property for you automatically.

Parameters:

key - cannot be null

defaultValue - default value if key is not set; can be null.

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Get the value of the property with the given key, or defaultValue if not set. In most cases, you shouldn't need to use this method. You can instead annotate fields with @Configuration and let the system bind the property for you automatically.

Parameters:

key - cannot be null

defaultValue - default value if key is not set; can be null.

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Get the value of the property with the given key, or defaultValue if not set. In most cases, you shouldn't need to use this method. You can instead annotate fields with @Configuration and let the system bind the property for you automatically.

Parameters:

key - cannot be null

defaultValue - default value if key is not set; can be null.

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

Get the value of the property with the given key, or defaultValue if not set. In most cases, you shouldn't need to use this method. You can instead annotate fields with @Configuration and let the system bind the property for you automatically.

Parameters:

key - cannot be null

defaultValue - default value if key is not set; can be null.

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Get the value of the property with the given key, or defaultValue if not set. In most cases, you shouldn't need to use this method. You can instead annotate fields with @Configuration and let the system bind the property for you automatically.

Parameters:

key - cannot be null

defaultValue - default value if key is not set; can be null.

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Get the value of the property with the given key, or defaultValue if not set. In most cases, you shouldn't need to use this method. You can instead annotate fields with @Configuration and let the system bind the property for you automatically.

Parameters:

key - cannot be null

defaultValue - default value if key is not set; can be null.

setOverrideProperty

public void setOverrideProperty(java.lang.String key,
                                java.lang.Object value)

setCallback

public void setCallback(java.lang.String key,
                        ConfigurationListener listener)

ConfigurationListener will be called when the given configuration key is modified on any node.

Parameters:

key -

listener -

getConfiguration

public AggregatedConfiguration getConfiguration()

Return the whole configuration. Note that if you just need to get or set a property, use the direct getter and setter methods instead.

split

public static java.util.List<java.lang.String> split(java.lang.String value)

Uses the default splitter to split the given value into a list. Handles nulls.

Parameters:

value -

Returns:

getPropertyFromConfigurations

public static <T> T getPropertyFromConfigurations(java.lang.String key,
                                                  T defValue,
                                                  org.apache.commons.configuration.Configuration... configs)

Returns the value of specified key in the first configuration in which it is found and non-null. If it is not found in any configuration, it returns defValue instead. Note that if a property exists in a configuration but the value is null, this method will not return null; it will keep trying the next configuration.