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

A

add(Artifact) - Method in class org.apache.sling.provisioning.model.ArtifactGroup
 
add(T) - Method in class org.apache.sling.provisioning.model.ItemList
Add a new item
applyArtifactVersions(Model, ModelUtility.ArtifactVersionResolver) - Static method in class org.apache.sling.provisioning.model.ModelUtility
Resolves artifact versions that are no set explicitly in the provisioning file via the given resolver (version = "LATEST").
applyVariables(Model, ModelUtility.VariableResolver) - Static method in class org.apache.sling.provisioning.model.ModelUtility
Applies a set of variables to the given model.
ARCHIVE_VERSION - Static variable in class org.apache.sling.provisioning.model.io.ModelArchiveWriter
Current support version of the model archive.
Artifact - Class in org.apache.sling.provisioning.model
Description of an artifact.
Artifact(String, String, String, String, String) - Constructor for class org.apache.sling.provisioning.model.Artifact
Create a new artifact object
Artifact(String, String, String, String, String, Map<String, String>) - Constructor for class org.apache.sling.provisioning.model.Artifact
Create a new artifact object
ArtifactGroup - Class in org.apache.sling.provisioning.model
A artifact group holds a set of artifacts.
ArtifactGroup(int) - Constructor for class org.apache.sling.provisioning.model.ArtifactGroup
Create a new artifact group with the level.
ARTIFACTS_PREFIX - Static variable in class org.apache.sling.provisioning.model.io.ModelArchiveWriter
Artifacts prefix.
artifactVersionResolver(ModelUtility.ArtifactVersionResolver) - Method in class org.apache.sling.provisioning.model.ModelUtility.ResolverOptions
 

C

CFG_FORMAT_FELIX_CA - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Format of the Apache Felix Config Admin.
CFG_FORMAT_PROPERTIES - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Property file format.
CFG_LAUNCHPAD_BOOTSTRAP - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Name of the configuration for the bootstrap contents.
CFG_LAUNCHPAD_WEB_XML - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Name of the configuration containing the web.xml.
CFG_MODE_MERGE - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Mode for merging a configuration
CFG_MODE_OVERWRITE - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Mode for overwriting a configuration.
CFG_UNPROCESSED - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Unprocessed configuration values.
CFG_UNPROCESSED_FORMAT - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Format of the unprocessed configuration values.
CFG_UNPROCESSED_MODE - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Format of the unprocessed configuration values.
clear() - Method in class org.apache.sling.provisioning.model.KeyValueMap
Clear the map
Commentable - Class in org.apache.sling.provisioning.model
A commentable has a comment and a location.
Commentable() - Constructor for class org.apache.sling.provisioning.model.Commentable
 
compareTo(Object) - Method in class org.apache.sling.provisioning.model.Artifact
 
compareTo(ArtifactGroup) - Method in class org.apache.sling.provisioning.model.ArtifactGroup
 
compareTo(Configuration) - Method in class org.apache.sling.provisioning.model.Configuration
 
compareTo(Feature) - Method in class org.apache.sling.provisioning.model.Feature
 
compareTo(RunMode) - Method in class org.apache.sling.provisioning.model.RunMode
 
compareTo(Version) - Method in class org.apache.sling.provisioning.model.Version
Compares this Version object to another Version.
Configuration - Class in org.apache.sling.provisioning.model
A configuration has either - a pid - or a factory pid and an alias (pid) and properties.
Configuration(String, String) - Constructor for class org.apache.sling.provisioning.model.Configuration
Create a new configuration
consume(Artifact, InputStream) - Method in interface org.apache.sling.provisioning.model.io.ModelArchiveReader.ArtifactConsumer
Consume the artifact from the archive The input stream must not be closed by the consumer.

D

DEFAULT_EXTENSION - Static variable in class org.apache.sling.provisioning.model.io.ModelArchiveWriter
Default extension for model archives.
DEFAULT_RUN_MODE - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Default run mode value
DEFAULT_START_LEVEL - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Default start level value

E

equals(Object) - Method in class org.apache.sling.provisioning.model.Artifact
 
equals(Object) - Method in class org.apache.sling.provisioning.model.Version
 

F

Feature - Class in org.apache.sling.provisioning.model
A feature is a collection of - a name - a version - variables - run modes
Feature(String) - Constructor for class org.apache.sling.provisioning.model.Feature
Construct a new feature.
FEATURE_BOOT - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Name of the boot feature
FEATURE_LAUNCHPAD - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Name of Sling's launchpad feature.
FeatureTypes - Class in org.apache.sling.provisioning.model
Constants for common feature types.
FeatureTypes() - Constructor for class org.apache.sling.provisioning.model.FeatureTypes
 
fromMvnUrl(String) - Static method in class org.apache.sling.provisioning.model.Artifact
Create a new artifact from a maven url, 'mvn:' [ repository-url '!' ] group-id '/' artifact-id [ '/' [version] [ '/' [type] [ '/' classifier ] ] ] ]

G

get(String) - Method in class org.apache.sling.provisioning.model.KeyValueMap
Get an item from the map.
getAdditionalSections() - Method in class org.apache.sling.provisioning.model.Feature
Get all additional sections
getAdditionalSections(String) - Method in class org.apache.sling.provisioning.model.Feature
Get all sections with the given name.
getArtifactGroup(int) - Method in class org.apache.sling.provisioning.model.RunMode
Find the artifact group.
getArtifactGroups() - Method in class org.apache.sling.provisioning.model.RunMode
Get all artifact groups
getArtifactId() - Method in class org.apache.sling.provisioning.model.Artifact
Return the artifact id.
getArtifactVersionResolver() - Method in class org.apache.sling.provisioning.model.ModelUtility.ResolverOptions
 
getAttributes() - Method in class org.apache.sling.provisioning.model.Section
Get all attributes
getClassifier() - Method in class org.apache.sling.provisioning.model.Artifact
Return the optional classifier.
getComment() - Method in class org.apache.sling.provisioning.model.Commentable
Get the comment.
getConfiguration(String) - Method in class org.apache.sling.provisioning.model.RunMode
Search a configuration with a pid
getConfiguration(String, String) - Method in class org.apache.sling.provisioning.model.RunMode
Search a configuration with pid and factory pid
getConfigurations() - Method in class org.apache.sling.provisioning.model.RunMode
Get all configurations
getContents() - Method in class org.apache.sling.provisioning.model.Section
Get the contents of the section.
getEffectiveModel(Model, ModelUtility.VariableResolver) - Static method in class org.apache.sling.provisioning.model.ModelUtility
getEffectiveModel(Model) - Static method in class org.apache.sling.provisioning.model.ModelUtility
Replace all variables in the model and return a new model with the replaced values.
getEffectiveModel(Model, ModelUtility.ResolverOptions) - Static method in class org.apache.sling.provisioning.model.ModelUtility
Replace all variables in the model and return a new model with the replaced values.
getFactoryPid() - Method in class org.apache.sling.provisioning.model.Configuration
Return the factory pid
getFeature(String) - Method in class org.apache.sling.provisioning.model.Model
Find the feature if available
getFeatures() - Method in class org.apache.sling.provisioning.model.Model
Return all features.
getGroupId() - Method in class org.apache.sling.provisioning.model.Artifact
Return the group id.
getInputStream(Artifact) - Method in interface org.apache.sling.provisioning.model.io.ModelArchiveWriter.ArtifactProvider
Provide an input stream for the artifact.
getLocation() - Method in class org.apache.sling.provisioning.model.Traceable
Get the location.
getMajorVersion() - Method in class org.apache.sling.provisioning.model.Version
Get the major version
getMetadata() - Method in class org.apache.sling.provisioning.model.Artifact
Get the metadata of the artifact.
getMicroVersion() - Method in class org.apache.sling.provisioning.model.Version
Get the minor version
getMinorVersion() - Method in class org.apache.sling.provisioning.model.Version
Get the major version
getName() - Method in class org.apache.sling.provisioning.model.Feature
Get the name of the feature.
getName() - Method in class org.apache.sling.provisioning.model.Section
Get the name of the section.
getNames() - Method in class org.apache.sling.provisioning.model.RunMode
Return the run mode names.
getOrCreateArtifactGroup(int) - Method in class org.apache.sling.provisioning.model.RunMode
Get or create an artifact group
getOrCreateConfiguration(String, String) - Method in class org.apache.sling.provisioning.model.RunMode
Get or create the configuration
getOrCreateFeature(String) - Method in class org.apache.sling.provisioning.model.Model
Get or create the feature.
getOrCreateRunMode(String[]) - Method in class org.apache.sling.provisioning.model.Feature
Get or create the run mode.
getPid() - Method in class org.apache.sling.provisioning.model.Configuration
Get the pid.
getProperties() - Method in class org.apache.sling.provisioning.model.Configuration
Get all properties of the configuration.
getQualifier() - Method in class org.apache.sling.provisioning.model.Version
Get the qualifier
getRepositoryPath() - Method in class org.apache.sling.provisioning.model.Artifact
Create a Maven like relative repository path.
getRunMode(String...) - Method in class org.apache.sling.provisioning.model.Feature
Find the run mode if available
getRunModes() - Method in class org.apache.sling.provisioning.model.Feature
Get all run modes.
getSettings() - Method in class org.apache.sling.provisioning.model.RunMode
Get the settings
getSortedRunModesArray(String[]) - Static method in class org.apache.sling.provisioning.model.RunMode
Get an alphabetical sorted array of the run mode names.
getStartLevel() - Method in class org.apache.sling.provisioning.model.ArtifactGroup
Get the start level.
getType() - Method in class org.apache.sling.provisioning.model.Artifact
Return the type.
getType() - Method in class org.apache.sling.provisioning.model.Feature
Get the feature type.
getVariableResolver() - Method in class org.apache.sling.provisioning.model.ModelUtility.ResolverOptions
 
getVariables() - Method in class org.apache.sling.provisioning.model.Feature
Get all variables
getVersion() - Method in class org.apache.sling.provisioning.model.Artifact
Return the version.
getVersion() - Method in class org.apache.sling.provisioning.model.Feature
Get the version of the feature.

H

hashCode() - Method in class org.apache.sling.provisioning.model.Artifact
 
hashCode() - Method in class org.apache.sling.provisioning.model.Version
 

I

isActive(Set<String>) - Method in class org.apache.sling.provisioning.model.RunMode
Check if this run mode is active wrt the given set of active run modes.
isEmpty() - Method in class org.apache.sling.provisioning.model.ItemList
Check if the list is empty.
isEmpty() - Method in class org.apache.sling.provisioning.model.KeyValueMap
Check whether this map is empty.
isHandleRemoveRunMode() - Method in class org.apache.sling.provisioning.model.MergeUtility.MergeOptions
Returns true if the remove run mode should be respected.
isLatestArtifactWins() - Method in class org.apache.sling.provisioning.model.MergeUtility.MergeOptions
Returns true if the latest artifact should win on a merge.
isRunMode(String) - Method in class org.apache.sling.provisioning.model.RunMode
Check if this run mode is tied to a single specific run mode name.
isSpecial() - Method in class org.apache.sling.provisioning.model.Configuration
Is this a special configuration?
isSpecial() - Method in class org.apache.sling.provisioning.model.Feature
Special feature?
isSpecial() - Method in class org.apache.sling.provisioning.model.RunMode
Check whether this run mode is a special one
ItemList<T> - Class in org.apache.sling.provisioning.model
Helper class to hold a list of items.
ItemList() - Constructor for class org.apache.sling.provisioning.model.ItemList
 
items - Variable in class org.apache.sling.provisioning.model.ItemList
The list holding the items.
iterator() - Method in class org.apache.sling.provisioning.model.ItemList
 
iterator() - Method in class org.apache.sling.provisioning.model.KeyValueMap
 

K

KeyValueMap<T> - Class in org.apache.sling.provisioning.model
Helper class to hold key value pairs.
KeyValueMap() - Constructor for class org.apache.sling.provisioning.model.KeyValueMap
 

M

MANIFEST_HEADER - Static variable in class org.apache.sling.provisioning.model.io.ModelArchiveWriter
The manifest header marking an archive as a model archive.
merge(Model, Model) - Static method in class org.apache.sling.provisioning.model.MergeUtility
Merge the additional model into the base model.
merge(Model, Model, MergeUtility.MergeOptions) - Static method in class org.apache.sling.provisioning.model.MergeUtility
Merge the additional model into the base model.
merge(Model, Model) - Static method in class org.apache.sling.provisioning.model.ModelUtility
Deprecated.
merge(Model, Model, boolean) - Static method in class org.apache.sling.provisioning.model.ModelUtility
mergeComments(Commentable, Commentable) - Static method in class org.apache.sling.provisioning.model.MergeUtility
Merge the comments
MergeOptions() - Constructor for class org.apache.sling.provisioning.model.MergeUtility.MergeOptions
 
MergeUtility - Class in org.apache.sling.provisioning.model
Utility for merging two models.
MergeUtility() - Constructor for class org.apache.sling.provisioning.model.MergeUtility
 
MergeUtility.MergeOptions - Class in org.apache.sling.provisioning.model
Options for specifying some parts of the merge operation.
Model - Class in org.apache.sling.provisioning.model
A model is the central object.
Model() - Constructor for class org.apache.sling.provisioning.model.Model
 
MODEL_NAME - Static variable in class org.apache.sling.provisioning.model.io.ModelArchiveWriter
Model name.
ModelArchiveReader - Class in org.apache.sling.provisioning.model.io
The model archive reader can be used to read an archive based on a model The archive contains the model file and all artifacts.
ModelArchiveReader() - Constructor for class org.apache.sling.provisioning.model.io.ModelArchiveReader
 
ModelArchiveReader.ArtifactConsumer - Interface in org.apache.sling.provisioning.model.io
 
ModelArchiveWriter - Class in org.apache.sling.provisioning.model.io
The model archive writer can be used to create an archive based on a model The archive contains the model file and all artifacts.
ModelArchiveWriter() - Constructor for class org.apache.sling.provisioning.model.io.ModelArchiveWriter
 
ModelArchiveWriter.ArtifactProvider - Interface in org.apache.sling.provisioning.model.io
 
ModelConstants - Class in org.apache.sling.provisioning.model
Constants for the provisioning model.
ModelConstants() - Constructor for class org.apache.sling.provisioning.model.ModelConstants
 
ModelReader - Class in org.apache.sling.provisioning.model.io
This class offers a method to read a model using a Reader instance.
ModelResolveUtility - Class in org.apache.sling.provisioning.model
Helper methods for resolving variables and artifact versions in models.
ModelUtility - Class in org.apache.sling.provisioning.model
Model utility
ModelUtility() - Constructor for class org.apache.sling.provisioning.model.ModelUtility
 
ModelUtility.ArtifactVersionResolver - Interface in org.apache.sling.provisioning.model
Optional artifact dependency version resolver
ModelUtility.ResolverOptions - Class in org.apache.sling.provisioning.model
Parameter builder class for ModelUtility.getEffectiveModel(Model, ResolverOptions) method.
ModelUtility.VariableResolver - Interface in org.apache.sling.provisioning.model
Optional variable resolver
ModelWriter - Class in org.apache.sling.provisioning.model.io
Simple writer for the a model
ModelWriter() - Constructor for class org.apache.sling.provisioning.model.io.ModelWriter
 

O

org.apache.sling.provisioning.model - package org.apache.sling.provisioning.model
 
org.apache.sling.provisioning.model.io - package org.apache.sling.provisioning.model.io
 

P

PLAIN - Static variable in class org.apache.sling.provisioning.model.FeatureTypes
 
put(String, T) - Method in class org.apache.sling.provisioning.model.KeyValueMap
Put an item in the map
putAll(KeyValueMap<T>) - Method in class org.apache.sling.provisioning.model.KeyValueMap
Put all items from the other map in this map

R

read(InputStream, ModelArchiveReader.ArtifactConsumer) - Static method in class org.apache.sling.provisioning.model.io.ModelArchiveReader
Read a model archive.
read(Reader, String) - Static method in class org.apache.sling.provisioning.model.io.ModelReader
Reads the model file The reader is not closed.
remove(T) - Method in class org.apache.sling.provisioning.model.ItemList
Remove an item.
remove(String) - Method in class org.apache.sling.provisioning.model.KeyValueMap
Remove an item from the map
replace(Feature, String, ModelUtility.VariableResolver) - Static method in class org.apache.sling.provisioning.model.ModelResolveUtility
Replace properties in the string.
resolve(Artifact) - Method in interface org.apache.sling.provisioning.model.ModelUtility.ArtifactVersionResolver
Setting a version for an artifact dependency in a Sling Provisioning file is optional.
resolve(Feature, String) - Method in interface org.apache.sling.provisioning.model.ModelUtility.VariableResolver
Resolve the variable.
ResolverOptions() - Constructor for class org.apache.sling.provisioning.model.ModelUtility.ResolverOptions
 
RUN_MODE_REMOVE - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Name of the run mode to remove things from the base model.
RUN_MODE_STANDALONE - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Name of the standalone run mode.
RUN_MODE_WEBAPP - Static variable in class org.apache.sling.provisioning.model.ModelConstants
Name of the webapp run mode.
RunMode - Class in org.apache.sling.provisioning.model
A run mode is a collection of - artifacts (through start levels) - configurations - settings Only if all run modes are active, this run mode is active.
RunMode(String[]) - Constructor for class org.apache.sling.provisioning.model.RunMode
Create a new run mode

S

search(Artifact) - Method in class org.apache.sling.provisioning.model.ArtifactGroup
Search an artifact with the same groupId, artifactId, type and classifier.
Section - Class in org.apache.sling.provisioning.model
An additional section in the provisioning model.
Section(String) - Constructor for class org.apache.sling.provisioning.model.Section
Construct a new feature.
setComment(String) - Method in class org.apache.sling.provisioning.model.Commentable
Set the comment.
setContents(String) - Method in class org.apache.sling.provisioning.model.Section
Set the contents of the section.
setHandleRemoveRunMode(boolean) - Method in class org.apache.sling.provisioning.model.MergeUtility.MergeOptions
Set to true if the remove run mode should be respected.
setLatestArtifactWins(boolean) - Method in class org.apache.sling.provisioning.model.MergeUtility.MergeOptions
Set to true if the latest artifact should win on a merge.
setLocation(String) - Method in class org.apache.sling.provisioning.model.Traceable
Set the location.
setType(String) - Method in class org.apache.sling.provisioning.model.Feature
Set the feature type.
setVersion(String) - Method in class org.apache.sling.provisioning.model.Feature
Set the version.
size() - Method in class org.apache.sling.provisioning.model.KeyValueMap
Get the size of the map.
SUBSYSTEM_APPLICATION - Static variable in class org.apache.sling.provisioning.model.FeatureTypes
 
SUBSYSTEM_COMPOSITE - Static variable in class org.apache.sling.provisioning.model.FeatureTypes
 
SUBSYSTEM_FEATURE - Static variable in class org.apache.sling.provisioning.model.FeatureTypes
 

T

toMvnUrl() - Method in class org.apache.sling.provisioning.model.Artifact
Return a mvn url
toString() - Method in class org.apache.sling.provisioning.model.Artifact
 
toString() - Method in class org.apache.sling.provisioning.model.ArtifactGroup
 
toString() - Method in class org.apache.sling.provisioning.model.Commentable
 
toString() - Method in class org.apache.sling.provisioning.model.Configuration
 
toString() - Method in class org.apache.sling.provisioning.model.Feature
 
toString() - Method in class org.apache.sling.provisioning.model.ItemList
 
toString() - Method in class org.apache.sling.provisioning.model.KeyValueMap
 
toString() - Method in class org.apache.sling.provisioning.model.Model
 
toString() - Method in class org.apache.sling.provisioning.model.RunMode
 
toString() - Method in class org.apache.sling.provisioning.model.Section
 
toString() - Method in class org.apache.sling.provisioning.model.Traceable
 
toString() - Method in class org.apache.sling.provisioning.model.Version
 
Traceable - Class in org.apache.sling.provisioning.model
A traceable has an optional location.
Traceable() - Constructor for class org.apache.sling.provisioning.model.Traceable
 

V

validate(Model) - Static method in class org.apache.sling.provisioning.model.ModelUtility
Validates the model.
validateIncludingVersion(Model) - Static method in class org.apache.sling.provisioning.model.ModelUtility
Validates the model and checks that each feature has a valid version.
variableResolver(ModelUtility.VariableResolver) - Method in class org.apache.sling.provisioning.model.ModelUtility.ResolverOptions
 
Version - Class in org.apache.sling.provisioning.model
Version object supporting Maven and OSGi versions.
Version(String) - Constructor for class org.apache.sling.provisioning.model.Version
Creates a version identifier from the specified string.

W

write(OutputStream, Model, Manifest, ModelArchiveWriter.ArtifactProvider) - Static method in class org.apache.sling.provisioning.model.io.ModelArchiveWriter
Create a model archive.
write(Writer, Model) - Static method in class org.apache.sling.provisioning.model.io.ModelWriter
Writes the model to the writer.
A C D E F G H I K M O P R S T V W 
Skip navigation links

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