- add(Artifact) - Method in class org.apache.sling.feature.Artifacts
-
Add an artifact.
- addArtifactsOverride(ArtifactId) - Method in class org.apache.sling.feature.builder.BuilderContext
-
Add an override for artifact clashes.
- addArtifactsOverrides(List<String>) - Method in class org.apache.sling.feature.builder.BuilderContext
-
- addConfigsOverrides(Map<String, String>) - Method in class org.apache.sling.feature.builder.BuilderContext
-
Add merge policies for configuration clashes.
- addFrameworkPropertiesOverrides(Map<String, String>) - Method in class org.apache.sling.feature.builder.BuilderContext
-
Add overrides for the framework properties.
- addMergeExtensions(MergeHandler...) - Method in class org.apache.sling.feature.builder.BuilderContext
-
Add merge extensions
- addPostProcessExtensions(PostProcessHandler...) - Method in class org.apache.sling.feature.builder.BuilderContext
-
Add post process extensions
- addVariablesOverrides(Map<String, String>) - Method in class org.apache.sling.feature.builder.BuilderContext
-
Add overrides for the variables.
- ARCHIVE_VERSION - Static variable in class org.apache.sling.feature.io.archive.ArchiveWriter
-
Current support version of the feature model archive.
- ArchiveReader - Class in org.apache.sling.feature.io.archive
-
The feature archive reader can be used to read an archive based on a feature
model.
- ArchiveReader() - Constructor for class org.apache.sling.feature.io.archive.ArchiveReader
-
- ArchiveReader.ArtifactConsumer - Interface in org.apache.sling.feature.io.archive
-
- ArchiveWriter - Class in org.apache.sling.feature.io.archive
-
The feature archive writer can be used to create an archive based on a
feature model.
- ArchiveWriter() - Constructor for class org.apache.sling.feature.io.archive.ArchiveWriter
-
- Artifact - Class in org.apache.sling.feature
-
An artifact consists of
An id
metadata
optional alias and start order properties (which are part of the metadata)
This class is not thread-safe.
- Artifact(ArtifactId) - Constructor for class org.apache.sling.feature.Artifact
-
Construct a new artifact
- Artifact(JsonValue) - Constructor for class org.apache.sling.feature.Artifact
-
Construct a new artifact
- ArtifactHandler - Class in org.apache.sling.feature.io.artifacts
-
A handler provides a file object for an artifact.
- ArtifactHandler(String, URL) - Constructor for class org.apache.sling.feature.io.artifacts.ArtifactHandler
-
Create a new handler.
- ArtifactHandler(File) - Constructor for class org.apache.sling.feature.io.artifacts.ArtifactHandler
-
Create a new handler.
- ArtifactId - Class in org.apache.sling.feature
-
An artifact identifier.
- ArtifactId(String, String, String, String, String) - Constructor for class org.apache.sling.feature.ArtifactId
-
Create a new artifact object
- ArtifactManager - Class in org.apache.sling.feature.io.artifacts
-
The artifact manager is the central service to get artifacts.
- ArtifactManagerConfig - Class in org.apache.sling.feature.io.artifacts
-
This class holds the configuration of artifact manager.
- ArtifactManagerConfig() - Constructor for class org.apache.sling.feature.io.artifacts.ArtifactManagerConfig
-
Create a new configuration object.
- ArtifactProvider - Interface in org.apache.sling.feature.builder
-
The artifact provider provides a URL for an artifact.
- ArtifactProvider - Interface in org.apache.sling.feature.io.artifacts.spi
-
The artifact provider is an extension point for providing artifacts
from different sources, like for example s3.
- ArtifactProviderContext - Interface in org.apache.sling.feature.io.artifacts.spi
-
This is the context for the artifact providers
- Artifacts - Class in org.apache.sling.feature
-
Groups a list of Artifacts.
- Artifacts() - Constructor for class org.apache.sling.feature.Artifacts
-
- assemble(Feature, BuilderContext) - Static method in class org.apache.sling.feature.builder.FeatureBuilder
-
Assemble the full feature by processing its prototype.
- assemble(ArtifactId, BuilderContext, Feature...) - Static method in class org.apache.sling.feature.builder.FeatureBuilder
-
Assemble a feature based on the provided features.
- canMerge(Extension) - Method in interface org.apache.sling.feature.builder.MergeHandler
-
Checks whether this merger can merge the given extension.
- changeClassifier(String) - Method in class org.apache.sling.feature.ArtifactId
-
Provide artifact id with a different classifier.
- changeType(String) - Method in class org.apache.sling.feature.ArtifactId
-
Provide artifact id with a different type.
- changeVersion(String) - Method in class org.apache.sling.feature.ArtifactId
-
Provide artifact id with a different version.
- close() - Method in class org.apache.sling.feature.io.artifacts.ArtifactManager
-
- close() - Method in class org.apache.sling.feature.io.CloseShieldWriter
-
Deprecated.
- CloseShieldWriter - Class in org.apache.sling.feature.io
-
Deprecated.
- CloseShieldWriter(Writer) - Constructor for class org.apache.sling.feature.io.CloseShieldWriter
-
Deprecated.
- compareTo(Artifact) - Method in class org.apache.sling.feature.Artifact
-
- compareTo(ArtifactId) - Method in class org.apache.sling.feature.ArtifactId
-
- compareTo(Configuration) - Method in class org.apache.sling.feature.Configuration
-
- compareTo(Feature) - Method in class org.apache.sling.feature.Feature
-
- compareTo(Prototype) - Method in class org.apache.sling.feature.Prototype
-
- CONFIG_FAIL_ON_CLASH - Static variable in class org.apache.sling.feature.builder.BuilderContext
-
Used to handle configuration merging - fail the merge when there is a clash for a PID - this is the default
- CONFIG_FAIL_ON_PROPERTY_CLASH - Static variable in class org.apache.sling.feature.builder.BuilderContext
-
Used to handle configuration merging - fail the merge only when there is a clash on a property level
- CONFIG_MERGE_FIRST - Static variable in class org.apache.sling.feature.builder.BuilderContext
-
Used to handle configuration merging - merge the first configuration in, latest props will not override previous values
- CONFIG_MERGE_LATEST - Static variable in class org.apache.sling.feature.builder.BuilderContext
-
Used to handle configuration merging - merge the latest configuration in, latest props might override previous values
- CONFIG_USE_FIRST - Static variable in class org.apache.sling.feature.builder.BuilderContext
-
Used to handle configuration merging - use the first configuration, don't merge
- CONFIG_USE_LATEST - Static variable in class org.apache.sling.feature.builder.BuilderContext
-
Used to handle configuration merging - use the latest configuration, but don't merge
- Configuration - Class in org.apache.sling.feature
-
A configuration has either
a pid
or a factory pid and a name
and properties.
- Configuration(String) - Constructor for class org.apache.sling.feature.Configuration
-
Create a new configuration
- ConfigurationJSONReader - Class in org.apache.sling.feature.io.json
-
JSON Reader for configurations.
- ConfigurationJSONReader() - Constructor for class org.apache.sling.feature.io.json.ConfigurationJSONReader
-
- ConfigurationJSONWriter - Class in org.apache.sling.feature.io.json
-
JSON writer for configurations
- ConfigurationJSONWriter() - Constructor for class org.apache.sling.feature.io.json.ConfigurationJSONWriter
-
- Configurations - Class in org.apache.sling.feature
-
A container for configurations.
- Configurations() - Constructor for class org.apache.sling.feature.Configurations
-
- CONFIGURATOR_PREFIX - Static variable in class org.apache.sling.feature.Configuration
-
Prefix for instructions for the configurator.
- ConfiguratorUtil - Class in org.apache.sling.feature.io
-
- consume(ArtifactId, InputStream) - Method in interface org.apache.sling.feature.io.archive.ArchiveReader.ArtifactConsumer
-
Consume the artifact from the archive The input stream must not be closed by
the consumer.
- containsExact(ArtifactId) - Method in class org.apache.sling.feature.Artifacts
-
Checks whether the exact artifact is available
- containsSame(ArtifactId) - Method in class org.apache.sling.feature.Artifacts
-
Checks whether the same artifact is available, neglecting the version
- CONTENTS_HEADER - Static variable in class org.apache.sling.feature.io.archive.ArchiveWriter
-
The manifest header listing the features in this archive.
- COORDINATE_MATCH_ALL - Static variable in class org.apache.sling.feature.builder.BuilderContext
-
Used in override rule to match all coordinates
- copy(ArtifactId) - Method in class org.apache.sling.feature.Artifact
-
Create a copy of the artifact with a different id
- copy(String) - Method in class org.apache.sling.feature.Configuration
-
Create a copy of the configuration with a provided PID.
- copy() - Method in class org.apache.sling.feature.Extension
-
Create a copy of the Extension
- copy() - Method in class org.apache.sling.feature.Feature
-
Create a copy of the feature
- copy(ArtifactId) - Method in class org.apache.sling.feature.Feature
-
Create a copy of the feature with a different id For contained items like
bundles, artifacts and configurations a copy is created as well.
- getAliases(boolean) - Method in class org.apache.sling.feature.Artifact
-
Obtain the alias or aliases for the artifact.
- getArtifact(String, String) - Method in interface org.apache.sling.feature.io.artifacts.spi.ArtifactProvider
-
Get a local file for the artifact URL.
- getArtifactExtensionRemovals() - Method in class org.apache.sling.feature.Prototype
-
Get the list of artifacts removed from extensions The returned object is
modifiable.
- getArtifactHandler(String) - Method in class org.apache.sling.feature.io.artifacts.ArtifactManager
-
Get the full artifact url and file for an artifact.
- getArtifactId() - Method in class org.apache.sling.feature.ArtifactId
-
Return the artifact id.
- getArtifactManager(ArtifactManagerConfig) - Static method in class org.apache.sling.feature.io.artifacts.ArtifactManager
-
Get an artifact manager based on the configuration
- getArtifactProvider() - Method in interface org.apache.sling.feature.builder.HandlerContext
-
Provide the artifact provider.
- getArtifacts() - Method in class org.apache.sling.feature.Extension
-
Get the artifacts of the extension
- getBundleRemovals() - Method in class org.apache.sling.feature.Prototype
-
Get the list of artifact removals The returned object is modifiable.
- getBundles() - Method in class org.apache.sling.feature.Feature
-
Get the bundles.
- getBundlesByStartOrder() - Method in class org.apache.sling.feature.Bundles
-
Get the map of all bundles sorted by start order.
- getByName(String) - Method in class org.apache.sling.feature.Extensions
-
Get an extension by name
- getCachedArtifacts() - Method in class org.apache.sling.feature.io.artifacts.ArtifactManagerConfig
-
Get the number of cached artifacts
- getCacheDirectory() - Method in class org.apache.sling.feature.io.artifacts.ArtifactManagerConfig
-
Get the cache directory
- getCacheDirectory() - Method in interface org.apache.sling.feature.io.artifacts.spi.ArtifactProviderContext
-
Get the cache directory
- getCapabilities() - Method in class org.apache.sling.feature.Feature
-
Get the list of capabilities.
- getCapabilityRemovals() - Method in class org.apache.sling.feature.Prototype
-
Get the list of capability removals.
- getClassifier() - Method in class org.apache.sling.feature.ArtifactId
-
Return the optional classifier.
- getConfiguration() - Method in interface org.apache.sling.feature.builder.HandlerContext
-
Configuration for the handler
- getConfiguration(String) - Method in class org.apache.sling.feature.Configurations
-
Get the configuration
- getConfigurationProperties() - Method in class org.apache.sling.feature.Configuration
-
Get the configuration properties of the configuration.
- getConfigurationRemovals() - Method in class org.apache.sling.feature.Prototype
-
Get the list of configuration removals The returned object is modifiable.
- getConfigurations() - Method in class org.apache.sling.feature.Feature
-
Get the configurations.
- getDescription() - Method in class org.apache.sling.feature.Feature
-
Get the description
- getDownloadedArtifacts() - Method in class org.apache.sling.feature.io.artifacts.ArtifactManagerConfig
-
Get the number of downloaded artifacts
- getExact(ArtifactId) - Method in class org.apache.sling.feature.Artifacts
-
Get the artifact for the given id
- getExecutionEnvironmentExtension(Feature) - Static method in class org.apache.sling.feature.ExecutionEnvironmentExtension
-
Get the execution environment from the feature - if it exists.
- getExecutionEnvironmentExtension(Extension) - Static method in class org.apache.sling.feature.ExecutionEnvironmentExtension
-
Get the execution environment from the extension.
- getExtensionRemovals() - Method in class org.apache.sling.feature.Prototype
-
Get the list of extension removals The returned object is modifiable.
- getExtensions() - Method in class org.apache.sling.feature.Feature
-
Get the list of extensions.
- getFactoryConfigurations(String) - Method in class org.apache.sling.feature.Configurations
-
Get all factory configurations matching the factory pid.
- getFactoryPid() - Method in class org.apache.sling.feature.Configuration
-
Return the factory pid of a pid if it's a factory configuration
- getFactoryPid(String) - Static method in class org.apache.sling.feature.Configuration
-
Return the factory pid of a pid if it's a factory configuration
- getFeatureFiles(File, String...) - Static method in class org.apache.sling.feature.io.IOUtils
-
Get the list of feature files.
- getFeatureOrigins() - Method in class org.apache.sling.feature.Artifact
-
- getFileContents(ArtifactHandler) - Method in class org.apache.sling.feature.io.artifacts.ArtifactManager
-
- getFileFromURL(URL, boolean, File) - Static method in class org.apache.sling.feature.io.IOUtils
-
Get a File from a local URL (if possible)
- getFramework() - Method in class org.apache.sling.feature.ExecutionEnvironmentExtension
-
Get the specified framework
- getFrameworkProperties() - Method in class org.apache.sling.feature.Feature
-
Get the framework properties
The returned object is modifiable.
- getFrameworkPropertiesRemovals() - Method in class org.apache.sling.feature.Prototype
-
Get the list of framework property removals The returned object is
modifiable.
- getGroupId() - Method in class org.apache.sling.feature.ArtifactId
-
Return the group id.
- getId() - Method in class org.apache.sling.feature.Artifact
-
Get the id of the artifact.
- getId() - Method in class org.apache.sling.feature.Feature
-
Get the id of the artifact.
- getId() - Method in class org.apache.sling.feature.Prototype
-
Get the id of the artifact.
- getJarFileFromURL(URL, boolean, File) - Static method in class org.apache.sling.feature.io.IOUtils
-
Get a JarFile from a local URL (if possible)
- getJavaOptions() - Method in class org.apache.sling.feature.ExecutionEnvironmentExtension
-
Get the specified java options
- getJavaVersion() - Method in class org.apache.sling.feature.ExecutionEnvironmentExtension
-
Get the specified java version
- getJSON() - Method in class org.apache.sling.feature.Extension
-
Get the JSON of the extension
- getJSONStructure() - Method in class org.apache.sling.feature.Extension
-
Get the JSON structure of the extension
- getLatestSnapshot(String) - Static method in class org.apache.sling.feature.io.artifacts.ArtifactManager
-
- getLicense() - Method in class org.apache.sling.feature.Feature
-
Get the license
- getLocalArtifacts() - Method in class org.apache.sling.feature.io.artifacts.ArtifactManagerConfig
-
Get the number of local artifacts
- getLocalURL() - Method in class org.apache.sling.feature.io.artifacts.ArtifactHandler
-
Get a local url for the artifact
- getLocation() - Method in class org.apache.sling.feature.Feature
-
Get the location.
- getMetadata() - Method in class org.apache.sling.feature.Artifact
-
Get the metadata of the artifact.
- getName() - Method in class org.apache.sling.feature.Configuration
-
Return the name for a factory configuration if it is a factory configuration.
- getName(String) - Static method in class org.apache.sling.feature.Configuration
-
Return the name for a factory configuration if it is a factory configuration.
- getName() - Method in class org.apache.sling.feature.Extension
-
Get the extension name
- getOSGiVersion() - Method in class org.apache.sling.feature.ArtifactId
-
Return the OSGi version
- getPid() - Method in class org.apache.sling.feature.Configuration
-
Get the pid.
- getProperties() - Method in class org.apache.sling.feature.Configuration
-
Get all properties of the configuration.
- getProtocol() - Method in interface org.apache.sling.feature.io.artifacts.spi.ArtifactProvider
-
The protocol name of the provider, e.g.
- getPrototype() - Method in class org.apache.sling.feature.Feature
-
Get the optional prototype feature.
- getRepositoryUrls() - Method in class org.apache.sling.feature.io.artifacts.ArtifactManagerConfig
-
Get the repository urls.
- getRequirementRemovals() - Method in class org.apache.sling.feature.Prototype
-
Get the list of requirement removals.
- getRequirements() - Method in class org.apache.sling.feature.Feature
-
Get the list of requirements.
- getSame(ArtifactId) - Method in class org.apache.sling.feature.Artifacts
-
Get the artifact for the given id, neglecting the version
- getStartOrder() - Method in class org.apache.sling.feature.Artifact
-
Get the start order of the artifact.
- getState() - Method in class org.apache.sling.feature.Extension
-
Get the extension state
- getText() - Method in class org.apache.sling.feature.Extension
-
Get the text of the extension
- getTitle() - Method in class org.apache.sling.feature.Feature
-
Get the title
- getType() - Method in class org.apache.sling.feature.ArtifactId
-
Return the type.
- getType() - Method in class org.apache.sling.feature.Extension
-
Get the extension type
- getUrl() - Method in class org.apache.sling.feature.io.artifacts.ArtifactHandler
-
Get the url of the artifact
- getValue(String, String[]) - Static method in class org.apache.sling.feature.io.artifacts.ArtifactManager
-
- getVariables() - Method in class org.apache.sling.feature.Feature
-
Obtain the variables of the feature
- getVendor() - Method in class org.apache.sling.feature.Feature
-
Get the vendor
- getVersion() - Method in class org.apache.sling.feature.ArtifactId
-
Return the version.