org.apache.sling.settings
Interface SlingSettingsService

All Known Implementing Classes:

SlingSettingsServiceImpl

public interface SlingSettingsService

The SlingSettingsService provides basic Sling settings. - Sling home : If the Sling launchpad is used - Sling Id : A unique id of the installation Run Mode Support A run mode is simply a string like "author", "test", "development",... The server can have a set of active run modes.

Field Summary

static java.lang.String	RUN_MODES_PROPERTY The name of the framework property defining the set of used run modes.
static java.lang.String	SLING_HOME The name of the framework property defining the Sling home directory (value is "sling.home").
static java.lang.String	SLING_HOME_URL The name of the framework property defining the Sling home directory as an URL (value is "sling.home.url").

Method Summary

java.lang.String	getAbsolutePathWithinSlingHome(java.lang.String relativePath) Utility method to generate an absolute path within Sling Home.
java.util.Set<java.lang.String>	getRunModes() Return the set of activate run modes.
java.net.URL	getSlingHome() Returns the value of the SLING_HOME_URL property.
java.lang.String	getSlingHomePath() Returns the value of the SLING_HOME property.
java.lang.String	getSlingId() The identifier of the running Sling instance.

Field Detail

SLING_HOME

static final java.lang.String SLING_HOME

The name of the framework property defining the Sling home directory (value is "sling.home"). This is a Platform file system directory below which all runtime data, such as the Felix bundle archives, logfiles, the repository, etc., is located.

This property is available calling the BundleContext.getProperty(String) method.

See Also:

SLING_HOME_URL, Constant Field Values

SLING_HOME_URL

static final java.lang.String SLING_HOME_URL

The name of the framework property defining the Sling home directory as an URL (value is "sling.home.url").

The value of this property is assigned the value of new File(${sling.home}).toURI().toString() before resolving the property variables.

This property is available calling the BundleContext.getProperty(String) method.

See Also:

SLING_HOME, Constant Field Values

RUN_MODES_PROPERTY

static final java.lang.String RUN_MODES_PROPERTY

The name of the framework property defining the set of used run modes. The value is a comma separated list of run modes.

See Also:

Constant Field Values

Method Detail

getAbsolutePathWithinSlingHome

java.lang.String getAbsolutePathWithinSlingHome(java.lang.String relativePath)

Utility method to generate an absolute path within Sling Home.

Since:

1.1.0

getSlingId

java.lang.String getSlingId()

The identifier of the running Sling instance.

getSlingHomePath

java.lang.String getSlingHomePath()

Returns the value of the SLING_HOME property.

getSlingHome

java.net.URL getSlingHome()

Returns the value of the SLING_HOME_URL property.

getRunModes

java.util.Set<java.lang.String> getRunModes()

Return the set of activate run modes. This set might be empty.

Returns:

A non modifiable set of run modes.