Package org.apache.sling.settings
Interface SlingSettingsService
-
@ProviderType @Deprecated(since="2020-10-05") public interface SlingSettingsService
Deprecated.AEM as a Cloud Service does not support run modes or file system access at runtime.TheSlingSettingsService
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
Fields Modifier and Type Field Description static String
RUN_MODE_INSTALL_OPTIONS
Deprecated.The name of the framework property defining the list of run mode options for installation time.static String
RUN_MODE_OPTIONS
Deprecated.The name of the framework property defining the list of run mode options The value is a comma separated list of options where each option contains of a set of run modes separated by a | character.static String
RUN_MODES_PROPERTY
Deprecated.The name of the framework property defining the set of used run modes.static String
SLING_HOME
Deprecated.The name of the framework property defining the Sling home directory (value is "sling.home").static String
SLING_HOME_URL
Deprecated.The name of the framework property defining the Sling home directory as an URL (value is "sling.home.url").
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description String
getAbsolutePathWithinSlingHome(String relativePath)
Deprecated.Utility method to generate an absolute path within Sling Home.Set<String>
getRunModes()
Deprecated.Return the set of activate run modes.String
getSlingDescription()
Deprecated.Return the optional description of the instance.URL
getSlingHome()
Deprecated.Returns the value of theSLING_HOME_URL
property.String
getSlingHomePath()
Deprecated.Returns the value of theSLING_HOME
property.String
getSlingId()
Deprecated.The identifier of the running Sling instance.String
getSlingName()
Deprecated.Return the optional name of the instance.
-
-
-
Field Detail
-
SLING_HOME
static final String SLING_HOME
Deprecated.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 String SLING_HOME_URL
Deprecated.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 String RUN_MODES_PROPERTY
Deprecated.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
-
RUN_MODE_OPTIONS
static final String RUN_MODE_OPTIONS
Deprecated.The name of the framework property defining the list of run mode options The value is a comma separated list of options where each option contains of a set of run modes separated by a | character.- Since:
- 1.2.0
- See Also:
- Constant Field Values
-
RUN_MODE_INSTALL_OPTIONS
static final String RUN_MODE_INSTALL_OPTIONS
Deprecated.The name of the framework property defining the list of run mode options for installation time. The value is a comma separated list of options where each option contains of a set of run modes separated by a | character.- Since:
- 1.2.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAbsolutePathWithinSlingHome
String getAbsolutePathWithinSlingHome(String relativePath)
Deprecated.Utility method to generate an absolute path within Sling Home.- Returns:
- the absolute including the sling home directory.
- Since:
- 1.1.0
-
getSlingId
String getSlingId()
Deprecated.The identifier of the running Sling instance.- Returns:
- The unique Sling identifier.
-
getSlingHomePath
String getSlingHomePath()
Deprecated.Returns the value of theSLING_HOME
property.- Returns:
- The sling home.
-
getSlingHome
URL getSlingHome()
Deprecated.Returns the value of theSLING_HOME_URL
property.- Returns:
- Sling home as a URL.
-
getRunModes
Set<String> getRunModes()
Deprecated.Return the set of activate run modes. This set might be empty.- Returns:
- A non modifiable set of run modes.
-
getSlingName
String getSlingName()
Deprecated.Return the optional name of the instance.- Returns:
- The name of the instance or
null
. - Since:
- 1.3
-
getSlingDescription
String getSlingDescription()
Deprecated.Return the optional description of the instance.- Returns:
- The description of the instance or
null
. - Since:
- 1.3
-
-