Skip navigation links
A B C D E F G H I K M O P R S T V 

A

add(Artifact) - Method in class org.apache.sling.feature.Artifacts
Add an artifact.
addArtifactsOverrides(List<String>) - Method in class org.apache.sling.feature.builder.BuilderContext
Add overrides for artifact 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
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
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
ArtifactProvider - Interface in org.apache.sling.feature.builder
The artifact provider provides a URL for an artifact.
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.

B

BuilderContext - Class in org.apache.sling.feature.builder
Builder context holds services used by FeatureBuilder.
BuilderContext(FeatureProvider) - Constructor for class org.apache.sling.feature.builder.BuilderContext
Create a new context
Bundles - Class in org.apache.sling.feature
Groups a list of bundles Artifact and provides a means to sort them based on start order.
Bundles() - Constructor for class org.apache.sling.feature.Bundles
 

C

canMerge(Extension) - Method in interface org.apache.sling.feature.builder.MergeHandler
Checks whether this merger can merge extensions with that name
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
 
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
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.
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
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.

D

deduplicate(BuilderContext, Feature...) - Static method in class org.apache.sling.feature.builder.FeatureBuilder
Remove duplicate and prototype features.

E

equals(Object) - Method in class org.apache.sling.feature.Artifact
 
equals(Object) - Method in class org.apache.sling.feature.ArtifactId
 
equals(Object) - Method in class org.apache.sling.feature.Extension
 
equals(Object) - Method in class org.apache.sling.feature.Feature
 
equals(Object) - Method in class org.apache.sling.feature.Prototype
 
Extension - Class in org.apache.sling.feature
An Extension can either be of type Artifacts : it contains a list of artifacts Text : it contains text JSON : it contains a blob of JSON This class is not thread-safe.
Extension(ExtensionType, String, boolean) - Constructor for class org.apache.sling.feature.Extension
Create a new extension
EXTENSION_NAME_ASSEMBLED_FEATURES - Static variable in class org.apache.sling.feature.Extension
Extension name containing the assembled features as produced by FeatureBuilder.assemble(ArtifactId, BuilderContext, Feature...).
EXTENSION_NAME_CONTENT_PACKAGES - Static variable in class org.apache.sling.feature.Extension
Common extension name to specify the content packages for Apache Sling.
EXTENSION_NAME_REPOINIT - Static variable in class org.apache.sling.feature.Extension
Common extension name to specify the repoinit part for Apache Sling.
Extensions - Class in org.apache.sling.feature
A container for extensions This class is not thread-safe.
Extensions() - Constructor for class org.apache.sling.feature.Extensions
 
ExtensionType - Enum in org.apache.sling.feature
Enumeration for Extension types.

F

Feature - Class in org.apache.sling.feature
A feature consists of A unique id ArtifactId Bundles Configurations Framework properties Requirements and capabilities Prototype Extensions This class is not thread-safe.
Feature(ArtifactId) - Constructor for class org.apache.sling.feature.Feature
Construct a new feature.
FeatureBuilder - Class in org.apache.sling.feature.builder
 
FeatureBuilder() - Constructor for class org.apache.sling.feature.builder.FeatureBuilder
 
FeatureProvider - Interface in org.apache.sling.feature.builder
The feature provider is used to find features while assembling using FeatureBuilder.
fromMvnId(String) - Static method in class org.apache.sling.feature.ArtifactId
Create a new artifact id from maven coordinates/id groupId:artifactId[:packaging[:classifier]]:version
fromMvnUrl(String) - Static method in class org.apache.sling.feature.ArtifactId
Create a new artifact id from a maven url, 'mvn:' group-id '/' artifact-id [ '/' [version] [ '/' [type] [ '/' classifier ] ] ] ]

G

getAliases(boolean) - Method in class org.apache.sling.feature.Artifact
Obtain the alias or aliases for the artifact.
getArtifactExtensionRemovals() - Method in class org.apache.sling.feature.Prototype
 
getArtifactId() - Method in class org.apache.sling.feature.ArtifactId
Return the artifact id.
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
 
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
getCapabilities() - Method in class org.apache.sling.feature.Feature
Get the list of capabilities.
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
 
getConfigurations() - Method in class org.apache.sling.feature.Feature
Get the configurations.
getDescription() - Method in class org.apache.sling.feature.Feature
Get the description
getExtensionRemovals() - Method in class org.apache.sling.feature.Prototype
 
getExtensions() - Method in class org.apache.sling.feature.Feature
Get the list of extensions.
getFactoryPid(String) - Static method in class org.apache.sling.feature.Configuration
Return the factory pid of a pid if it's a factory configuration
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
 
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.
getJSON() - Method in class org.apache.sling.feature.Extension
Get the JSON of the extension
getLicense() - Method in class org.apache.sling.feature.Feature
Get the license
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(String) - Static method in class org.apache.sling.feature.Configuration
Return the name for 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.
getPrototype() - Method in class org.apache.sling.feature.Feature
Get the optional prototype feature.
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.
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
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.

H

HandlerContext - Interface in org.apache.sling.feature.builder
Context for an extension handler.
hashCode() - Method in class org.apache.sling.feature.Artifact
 
hashCode() - Method in class org.apache.sling.feature.ArtifactId
 
hashCode() - Method in class org.apache.sling.feature.Extension
 
hashCode() - Method in class org.apache.sling.feature.Feature
 
hashCode() - Method in class org.apache.sling.feature.Prototype
 

I

isAssembled() - Method in class org.apache.sling.feature.Feature
Check whether the feature is already assembled
isComplete() - Method in class org.apache.sling.feature.Feature
Check whether the feature is complete.
isFactoryConfiguration(String) - Static method in class org.apache.sling.feature.Configuration
Check whether the pid is a factory pid
isFinal() - Method in class org.apache.sling.feature.Feature
Check whether the feature is final.
isOptional() - Method in class org.apache.sling.feature.Extension
Return whether the extension is required or optional
isRequired() - Method in class org.apache.sling.feature.Extension
Return whether the extension is required or optional
isSame(ArtifactId) - Method in class org.apache.sling.feature.ArtifactId
Test whether the artifact id is pointing to the same artifact but potentially a different version

K

KEY_ALIAS - Static variable in class org.apache.sling.feature.Artifact
Can be used in artifact metadata to specify an alias.
KEY_START_ORDER - Static variable in class org.apache.sling.feature.Artifact
This key might be used by bundles to define the start order.

M

matches(Capability) - Method in interface org.apache.sling.feature.MatchingRequirement
 
MatchingRequirement - Interface in org.apache.sling.feature
 
merge(HandlerContext, Feature, Feature, Extension, Extension) - Method in interface org.apache.sling.feature.builder.MergeHandler
Merge the source extension into the target extension.
MergeHandler - Interface in org.apache.sling.feature.builder
A feature merge handler can merge a feature of a particular type.

O

org.apache.sling.feature - package org.apache.sling.feature
 
org.apache.sling.feature.builder - package org.apache.sling.feature.builder
 

P

parse(String) - Static method in class org.apache.sling.feature.ArtifactId
Create a new artifact id from a string, the string must either be a mvn url or a mvn id (= coordinates)
postProcess(HandlerContext, Feature, Extension) - Method in interface org.apache.sling.feature.builder.PostProcessHandler
Post process the feature with respect to the extension.
PostProcessHandler - Interface in org.apache.sling.feature.builder
A Post Process Handler processes features after a merge operation.
PROP_ARTIFACT_ID - Static variable in class org.apache.sling.feature.Configuration
This optional configuration property stores the artifact id (mvn id) of the bundle this configuration belongs to.
PROP_PREFIX - Static variable in class org.apache.sling.feature.Configuration
Prefix for special properties which are not configuration properties.
Prototype - Class in org.apache.sling.feature
A prototype is a blueprint of a feature with optional removals of Configurations / configuration properties Bundles Framework properties Extensions or artifacts from extensions This class is not thread-safe.
Prototype(ArtifactId) - Constructor for class org.apache.sling.feature.Prototype
Construct a new Include.
provide(ArtifactId) - Method in interface org.apache.sling.feature.builder.ArtifactProvider
Provide the artifact with the given id.
provide(ArtifactId) - Method in interface org.apache.sling.feature.builder.FeatureProvider
Provide the feature with the given id.

R

removeExact(ArtifactId) - Method in class org.apache.sling.feature.Artifacts
Remove the exact artifact.
removeSame(ArtifactId) - Method in class org.apache.sling.feature.Artifacts
Remove the same artifact, neglecting the version.
resolve(BuilderContext, String...) - Static method in class org.apache.sling.feature.builder.FeatureBuilder
Resolve a set of features based on their ids.
resolveVariables(Feature, Map<String, String>) - Static method in class org.apache.sling.feature.builder.FeatureBuilder
Resolve variables in the feature.

S

setArtifactProvider(ArtifactProvider) - Method in class org.apache.sling.feature.builder.BuilderContext
Set the artifact provider
setAssembled(boolean) - Method in class org.apache.sling.feature.Feature
Set the assembled flag
setComplete(boolean) - Method in class org.apache.sling.feature.Feature
Set the complete flag
setDescription(String) - Method in class org.apache.sling.feature.Feature
Set the description
setFinal(boolean) - Method in class org.apache.sling.feature.Feature
Set the final flag
setHandlerConfiguration(String, Map<String, String>) - Method in class org.apache.sling.feature.builder.BuilderContext
Set a handler configuration
setJSON(String) - Method in class org.apache.sling.feature.Extension
Set the JSON of the extension
setLicense(String) - Method in class org.apache.sling.feature.Feature
Set the vendor
setLocation(String) - Method in class org.apache.sling.feature.Feature
Set the location.
setPrototype(Prototype) - Method in class org.apache.sling.feature.Feature
Set the optional prototype feature.
setStartOrder(int) - Method in class org.apache.sling.feature.Artifact
Set the start order of the artifact This is a convenience method which sets the value of the property named #KEY_START_ORDER from the metadata.
setText(String) - Method in class org.apache.sling.feature.Extension
Set the text of the extension
setTitle(String) - Method in class org.apache.sling.feature.Feature
Set the title
setVendor(String) - Method in class org.apache.sling.feature.Feature
Set the vendor

T

toMvnId() - Method in class org.apache.sling.feature.ArtifactId
Return a mvn id
toMvnPath() - Method in class org.apache.sling.feature.ArtifactId
Create a Maven like relative repository path.
toMvnUrl() - Method in class org.apache.sling.feature.ArtifactId
Return a mvn url
toString() - Method in class org.apache.sling.feature.Artifact
 
toString() - Method in class org.apache.sling.feature.ArtifactId
 
toString() - Method in class org.apache.sling.feature.Configuration
 
toString() - Method in class org.apache.sling.feature.Extension
 
toString() - Method in class org.apache.sling.feature.Feature
 
toString() - Method in class org.apache.sling.feature.Prototype
 

V

valueOf(String) - Static method in enum org.apache.sling.feature.ExtensionType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.sling.feature.ExtensionType
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I K M O P R S T V 
Skip navigation links

Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.