org.apache.sling.settings.SlingSettingsService Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.sling.settings;
import java.net.URL;
import java.util.Set;
import org.osgi.annotation.versioning.ProviderType;
/**
* 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.
*/
@ProviderType
public interface SlingSettingsService {
/**
* 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 #SLING_HOME_URL
*
* @deprecated File handling is not supported in Cloud Service.
*/
@Deprecated()
String SLING_HOME = "sling.home";
/**
* 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 #SLING_HOME
*
* @deprecated File handling is not supported in Cloud Service.
*/
@Deprecated()
String SLING_HOME_URL = "sling.home.url";
/**
* The name of the framework property defining the set of used
* run modes.
* The value is a comma separated list of run modes.
*
* @deprecated Custom run modes are not supported in Cloud Service
*/
@Deprecated()
String RUN_MODES_PROPERTY = "sling.run.modes";
/**
* 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
*
* @deprecated Custom run modes are not supported in Cloud Service
*/
@Deprecated()
String RUN_MODE_OPTIONS = "sling.run.mode.options";
/**
* 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
*
* @deprecated Custom run modes are not supported in Cloud Service
*/
@Deprecated()
String RUN_MODE_INSTALL_OPTIONS = "sling.run.mode.install.options";
String RUN_MODE_SPEC_OR_SEPARATOR = ",";
String RUN_MODE_SPEC_AND_SEPARATOR = ".";
String RUN_MODE_SPEC_NOT_PREFIX = "-";
/**
* Utility method to generate an absolute path
* within Sling Home.
*
* @return the absolute including the sling home directory.
* @since 1.1.0
*
* @deprecated File handling is not supported in Cloud Service.
*/
@Deprecated()
String getAbsolutePathWithinSlingHome(String relativePath);
/**
* The identifier of the running Sling instance.
* @return The unique Sling identifier.
*/
String getSlingId();
/**
* Returns the value of the {@link #SLING_HOME}
* property.
* @return The sling home.
*
* @deprecated File handling is not supported in Cloud Service.
*/
@Deprecated()
String getSlingHomePath();
/**
* Returns the value of the {@link #SLING_HOME_URL}
* property.
* @return Sling home as a URL.
*
* @deprecated File handling is not supported in Cloud Service.
*/
@Deprecated()
URL getSlingHome();
/**
* Return the set of activate run modes.
* This set might be empty.
* @return A non modifiable set of run modes.
*/
Set getRunModes();
/**
* Checks if a given run mode spec is satisfied by the active run modes.
* A run mode spec consists out of run modes and operators (AND = ".", OR = "," and NOT = "-")
* and follows the following grammar in EBNF:
*
* run mode spec ::= conjunctions { "," conjunctions }
* conjunctions ::= conjunction { '.' conjunction }
* conjunction ::= notrunmode | runmode
* notrunmode ::= '-' runmode
*
*
* The operator order is first "-" (not), second "." (AND), last "," (OR).
* @param spec the run mode spec string to check against
* @return the number of matching run modes or 0 if no match. If multiple disjunctions match the one with the highest number of matching run modes is returned.
* @since 1.4.0 (Sling Settings Bundle 1.3.12)
*/
int getBestRunModeMatchCountFromSpec(String spec);
/**
* Return the optional name of the instance.
* @return The name of the instance or null.
* @since 1.3
*/
String getSlingName();
/**
* Return the optional description of the instance.
* @return The description of the instance or null.
* @since 1.3
*/
String getSlingDescription();
}