org.sonar.api.config

Class Settings

java.lang.Object

org.sonar.api.config.Settings

Direct Known Subclasses:

MapSettings

@ScannerSide
 @ServerSide
 @ComputeEngineSide
public abstract class Settings
extends Object

Component to get effective settings. Values of properties depend on the runtime environment:

• project settings in scanner.
• global settings in web server. It does not allow to get the settings overridden on projects.
• project settings in Compute Engine.

Usage

 public class MyExtension {

   private final Settings settings;

   public MyExtension(Settings settings) {
     this.settings = settings;
   }
   public void doSomething() {
     String fooValue = settings.getString("sonar.foo");
     // ..
   }
 }
 

Scanner example

Scanner sensor can get the reference on Settings directly through SensorContext, without injecting the component into constructor.

 public class MySensor implements Sensor {
    @Override
   public void execute(SensorContext context) {
     String fooValue = context.settings().getString("sonar.foo");
     // ..
   }
 }
 

For testing, and only for testing, the in-memory implementation MapSettings can be used.

  @Test
 public void my_test() {
   Settings settings = new MapSettings();
   settings.setProperty("foo", "bar");
   MyExtension underTest = new MyExtension(settings);
   // ...
 }
 

History - this class is abstract since 6.1.

Since:

2.12

See Also:

MapSettings, PropertyDefinition

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Settings(PropertyDefinitions definitions, Encryption encryption)

Method Summary

Modifier and Type	Method and Description
Settings	addProperties(Map<String,String> props)
Settings	addProperties(Properties props)
Settings	appendProperty(String key, String value)
protected abstract Optional<String>	get(String key)
boolean	getBoolean(String key) Effective value as boolean.
Date	getDate(String key) Effective value as Date, without time fields.
Date	getDateTime(String key) Effective value as Date, with time fields.
String	getDefaultValue(String key)
Optional<PropertyDefinition>	getDefinition(String key) The definition related to the specified property.
PropertyDefinitions	getDefinitions() All the property definitions declared by core and plugins.
Double	getDouble(String key) Effective value as Double.
Encryption	getEncryption()
Float	getFloat(String key) Effective value as Float.
int	getInt(String key) Effective value as int.
List<String>	getKeysStartingWith(String prefix)
long	getLong(String key) Effective value as long.
abstract Map<String,String>	getProperties() Immutable map of the properties that have non-default values.
Optional<String>	getRawString(String key) The value that overrides the default value.
String	getString(String key) The effective value of the specified property.
String[]	getStringArray(String key) Value is split by comma and trimmed.
String[]	getStringArrayBySeparator(String key, String separator) Value is split and trimmed.
String[]	getStringLines(String key) Value is split by carriage returns.
boolean	hasDefaultValue(String key)
boolean	hasKey(String key)
protected abstract void	remove(String key)
Settings	removeProperty(String key)
protected abstract void	set(String key, String value)
Settings	setProperty(String key, Boolean value)
Settings	setProperty(String key, Date date)
Settings	setProperty(String key, Date date, boolean includeTime)
Settings	setProperty(String key, Double value)
Settings	setProperty(String key, Float value)
Settings	setProperty(String key, Integer value)
Settings	setProperty(String key, Long value)
Settings	setProperty(String key, String value) Change a property value in a restricted scope only, depending on execution context.
Settings	setProperty(String key, String[] values)

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

protected Settings(PropertyDefinitions definitions,
                   Encryption encryption)

Method Detail

get

protected abstract Optional<String> get(String key)

set

protected abstract void set(String key,
                            String value)

remove

protected abstract void remove(String key)

getProperties

public abstract Map<String,String> getProperties()

Immutable map of the properties that have non-default values. The default values defined by PropertyDefinitions are ignored, so the returned values are not the effective values. Basically only the non-empty results of getRawString(String) are returned.

Values are not decrypted if they are encrypted with a secret key.

getEncryption

public Encryption getEncryption()

getRawString

public Optional<String> getRawString(String key)

The value that overrides the default value. It may be encrypted with a secret key. Use getString(String) to get the effective and decrypted value.

Since:

6.1

getDefinitions

public PropertyDefinitions getDefinitions()

All the property definitions declared by core and plugins.

getDefinition

public Optional<PropertyDefinition> getDefinition(String key)

The definition related to the specified property. It may be empty.

Since:

6.1

hasKey

public boolean hasKey(String key)

Returns:

true if the property has a non-default value, else false.

getDefaultValue

@CheckForNull
public String getDefaultValue(String key)

hasDefaultValue

public boolean hasDefaultValue(String key)

getString

@CheckForNull
public String getString(String key)

The effective value of the specified property. Can return null if the property is not set and has no defined default value.

If the property is encrypted with a secret key, then the returned value is decrypted.

Throws:

IllegalStateException - if value is encrypted but fails to be decrypted.

getBoolean

public boolean getBoolean(String key)

Effective value as boolean. It is false if getString(String) does not return "true", even if it's not a boolean representation.

Returns:

true if the effective value is "true", else false.

getInt

public int getInt(String key)

Effective value as int.

Returns:

the value as int. If the property does not have value nor default value, then 0 is returned.

Throws:

NumberFormatException - if value is not empty and is not a parsable integer

getLong

public long getLong(String key)

Effective value as long.

Returns:

the value as long. If the property does not have value nor default value, then 0L is returned.

Throws:

NumberFormatException - if value is not empty and is not a parsable long

getDate

@CheckForNull
public Date getDate(String key)

Effective value as Date, without time fields. Format is DateUtils.DATE_FORMAT.

Returns:

the value as a Date. If the property does not have value nor default value, then null is returned.

Throws:

RuntimeException - if value is not empty and is not in accordance with DateUtils.DATE_FORMAT.

getDateTime

@CheckForNull
public Date getDateTime(String key)

Effective value as Date, with time fields. Format is DateUtils.DATETIME_FORMAT.

Returns:

the value as a Date. If the property does not have value nor default value, then null is returned.

Throws:

RuntimeException - if value is not empty and is not in accordance with DateUtils.DATETIME_FORMAT.

getFloat

@CheckForNull
public Float getFloat(String key)

Effective value as Float.

Returns:

the value as Float. If the property does not have value nor default value, then null is returned.

Throws:

NumberFormatException - if value is not empty and is not a parsable number

getDouble

@CheckForNull
public Double getDouble(String key)

Effective value as Double.

Returns:

the value as Double. If the property does not have value nor default value, then null is returned.

Throws:

NumberFormatException - if value is not empty and is not a parsable number

getStringArray

public String[] getStringArray(String key)

Value is split by comma and trimmed. Never returns null.
Examples :

• "one,two,three " -> ["one", "two", "three"]
• " one, two, three " -> ["one", "two", "three"]
• "one, , three" -> ["one", "", "three"]

getStringLines

public String[] getStringLines(String key)

Value is split by carriage returns.

Returns:

non-null array of lines. The line termination characters are excluded.

Since:

3.2

getStringArrayBySeparator

public String[] getStringArrayBySeparator(String key,
                                          String separator)

Value is split and trimmed.

appendProperty

public Settings appendProperty(String key,
                               @Nullable
                               String value)

setProperty

public Settings setProperty(String key,
                            @Nullable
                            String[] values)

setProperty

public Settings setProperty(String key,
                            @Nullable
                            String value)

Change a property value in a restricted scope only, depending on execution context. New value is never persisted. New value is ephemeral and kept in memory only:

• during current analysis in the case of scanner stack
• during processing of current HTTP request in the case of web server stack
• during execution of current task in the case of Compute Engine stack

Property is temporarily removed if the parameter value is null

setProperty

public Settings setProperty(String key,
                            @Nullable
                            Boolean value)

See Also:

setProperty(String, String)

setProperty

public Settings setProperty(String key,
                            @Nullable
                            Integer value)

See Also:

setProperty(String, String)

setProperty

public Settings setProperty(String key,
                            @Nullable
                            Long value)

See Also:

setProperty(String, String)

setProperty

public Settings setProperty(String key,
                            @Nullable
                            Double value)

See Also:

setProperty(String, String)

setProperty

public Settings setProperty(String key,
                            @Nullable
                            Float value)

See Also:

setProperty(String, String)

setProperty

public Settings setProperty(String key,
                            @Nullable
                            Date date)

See Also:

setProperty(String, String)

addProperties

public Settings addProperties(Map<String,String> props)

addProperties

public Settings addProperties(Properties props)

setProperty

public Settings setProperty(String key,
                            @Nullable
                            Date date,
                            boolean includeTime)

See Also:

setProperty(String, String)

removeProperty

public Settings removeProperty(String key)

getKeysStartingWith

public List<String> getKeysStartingWith(String prefix)