com.newrelic.agent.config

Class BaseConfig

java.lang.Object

com.newrelic.agent.config.BaseConfig

All Implemented Interfaces:

Config

Direct Known Subclasses:

AgentConfigImpl, AgentControlIntegrationConfigImpl, AgentControlIntegrationHealthConfig, ApplicationLoggingConfigImpl, ApplicationLoggingContextDataConfig, ApplicationLoggingForwardingConfig, ApplicationLoggingLabelsConfig, ApplicationLoggingLocalDecoratingConfig, ApplicationLoggingMetricsConfig, AttributesConfigImpl, AuditModeConfig, BrowserConfig, BrowserMonitoringConfigImpl, CircuitBreakerConfig, CodeLevelMetricsConfigImpl, CommandParserConfigImpl, CrossProcessConfigImpl, DatastoreConfigImpl, DistributedTracingConfig, ErrorCollectorConfigImpl, ExtensionsConfigImpl, ExternalTracerConfigImpl, InfiniteTracingConfigImpl, InfiniteTracingSpanEventsConfig, InfiniteTracingTraceObserverConfig, InsightsConfigImpl, JarCollectorConfigImpl, ObfuscateJvmPropsConfigImpl, ObscuringConfig, ObscuringKeyConfig, SlowTransactionsConfigImpl, SpanEventsConfig, SqlTraceConfigImpl, StripExceptionConfigImpl, TransactionEventsConfig, TransactionTracerConfigImpl, UtilizationDataConfig

public class BaseConfig
extends java.lang.Object
implements Config

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	addDeprecatedProperties
static java.lang.String	COMMA_SEPARATOR
protected static java.util.Map<java.lang.String[],DeprecatedProperty>	deprecatedProperties
static java.lang.String	SEMI_COLON_SEPARATOR
protected java.lang.String	systemPropertyPrefix

Constructor Summary

Constructors

Constructor and Description
BaseConfig(java.util.Map<java.lang.String,java.lang.Object> props) Construct a BaseConfig for the map passed as an argument.
BaseConfig(java.util.Map<java.lang.String,java.lang.Object> props, java.lang.String systemPropertyPrefix) Construct a BaseConfig.

Method Summary

Modifier and Type	Method and Description
protected static void	addDeprecatedProperty(java.lang.String[] deprecatedProperty, java.lang.String[] newProperty) Adds a marker for later that a deprecated property should be logged as such.
protected <T> T	castValue(java.lang.String key, java.lang.Object value, T defaultVal)
protected static void	clearDeprecatedProperties()
protected double	getDoubleProperty(java.lang.String key, double defaultVal)
protected java.util.Set<java.lang.Integer>	getIntegerSet(java.lang.String key, java.util.Set<java.lang.Integer> defaultVal)
protected int	getIntProperty(java.lang.String key, int defaultVal)
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
<T> T	getProperty(java.lang.String key)
<T> T	getProperty(java.lang.String key, T defaultVal)
protected java.lang.Object	getPropertyFromSystemEnvironment(java.lang.String name, java.lang.Object defaultVal)
protected java.lang.Object	getPropertyFromSystemProperties(java.lang.String name, java.lang.Object defaultVal)
protected java.lang.String	getStringPropertyOrNull(java.lang.String key)
protected java.lang.String	getSystemPropertyKey(java.lang.String key)
protected java.util.List<java.lang.String>	getUniqueStrings(java.lang.String key) Returns a collection of strings for the given key using comma as a separator character.
protected java.util.List<java.lang.String>	getUniqueStrings(java.lang.String key, java.lang.String separator) Returns a collection of strings for the given key.
static java.util.List<java.lang.String>	getUniqueStringsFromCollection(java.util.Collection<?> values)
static java.util.List<java.lang.String>	getUniqueStringsFromCollection(java.util.Collection<?> values, java.lang.String prefix)
static java.util.List<java.lang.String>	getUniqueStringsFromString(java.lang.String valuesString, java.lang.String separator)
protected java.util.Map<java.lang.String,java.lang.Object>	nestedProps(java.lang.String key)

Methods inherited from class java.lang.Object

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

Field Detail

COMMA_SEPARATOR

public static final java.lang.String COMMA_SEPARATOR

See Also:

Constant Field Values

SEMI_COLON_SEPARATOR

public static final java.lang.String SEMI_COLON_SEPARATOR

See Also:

Constant Field Values

addDeprecatedProperties

protected static boolean addDeprecatedProperties

systemPropertyPrefix

protected final java.lang.String systemPropertyPrefix

deprecatedProperties

protected static final java.util.Map<java.lang.String[],DeprecatedProperty> deprecatedProperties

Constructor Detail

BaseConfig

public BaseConfig(java.util.Map<java.lang.String,java.lang.Object> props)

Construct a BaseConfig for the map passed as an argument. Values in the map are not subject to override by either system properties or environment variables.

Parameters:

props - the collection from which the values of keys are taken.

BaseConfig

public BaseConfig(java.util.Map<java.lang.String,java.lang.Object> props,
                  java.lang.String systemPropertyPrefix)

Construct a BaseConfig.

Parameters:

props - the collection from which the values of keys are taken, subject to override behaviors.

systemPropertyPrefix - If specified as null, values from the collection will not be subject to override by values from the system properties or environment. If non-null, the value serves as the prefix for matching overrides by the system properties and environment, with the environment having priority. Passing an empty string would expose the keys in the collection to override by arbitrary keys the user may have present in the the environment or system properties, so is not allowed.

Throws:

java.lang.IllegalArgumentException - - 0-length string given as systemPropertyPrefix

Method Detail

getProperties

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

nestedProps

protected java.util.Map<java.lang.String,java.lang.Object> nestedProps(java.lang.String key)

getPropertyFromSystemProperties

protected java.lang.Object getPropertyFromSystemProperties(java.lang.String name,
                                                           java.lang.Object defaultVal)

getSystemPropertyKey

protected java.lang.String getSystemPropertyKey(java.lang.String key)

getPropertyFromSystemEnvironment

protected java.lang.Object getPropertyFromSystemEnvironment(java.lang.String name,
                                                            java.lang.Object defaultVal)

getProperty

public <T> T getProperty(java.lang.String key,
                         T defaultVal)

Specified by:

getProperty in interface Config

castValue

protected <T> T castValue(java.lang.String key,
                          java.lang.Object value,
                          T defaultVal)

getProperty

public <T> T getProperty(java.lang.String key)

Specified by:

getProperty in interface Config

getIntegerSet

protected java.util.Set<java.lang.Integer> getIntegerSet(java.lang.String key,
                                                         java.util.Set<java.lang.Integer> defaultVal)

getUniqueStrings

protected java.util.List<java.lang.String> getUniqueStrings(java.lang.String key)

Returns a collection of strings for the given key using comma as a separator character.

See Also:

getUniqueStrings(String, String)

getUniqueStrings

protected java.util.List<java.lang.String> getUniqueStrings(java.lang.String key,
                                                            java.lang.String separator)

Returns a collection of strings for the given key. The property value can be a collection or a String list that uses a separator character.

getUniqueStringsFromCollection

public static java.util.List<java.lang.String> getUniqueStringsFromCollection(java.util.Collection<?> values,
                                                                              java.lang.String prefix)

getUniqueStringsFromCollection

public static java.util.List<java.lang.String> getUniqueStringsFromCollection(java.util.Collection<?> values)

getUniqueStringsFromString

public static java.util.List<java.lang.String> getUniqueStringsFromString(java.lang.String valuesString,
                                                                          java.lang.String separator)

getIntProperty

protected int getIntProperty(java.lang.String key,
                             int defaultVal)

getStringPropertyOrNull

protected java.lang.String getStringPropertyOrNull(java.lang.String key)

getDoubleProperty

protected double getDoubleProperty(java.lang.String key,
                                   double defaultVal)

addDeprecatedProperty

protected static void addDeprecatedProperty(java.lang.String[] deprecatedProperty,
                                            java.lang.String[] newProperty)

Adds a marker for later that a deprecated property should be logged as such.

Parameters:

deprecatedProperty - The property path that should be deprecated (e.g., ["transaction_tracer","deprecated_name"])

newProperty - The property path that should be used instead; set to null if there is no new property.

clearDeprecatedProperties

protected static void clearDeprecatedProperties()