Package org.apache.karaf.features

Interface FeaturesService

All Known Implementing Classes:

FeaturesServiceImpl

public interface FeaturesService

The service managing features repositories.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FeaturesService.Option
static class	FeaturesService.ServiceRequirementsBehavior	Configuration options for handling requirements from ServiceNamespace.SERVICE_NAMESPACE namespace
static class	FeaturesService.SnapshotUpdateBehavior	Configuration options for checking whether update'able bundle should really be updated

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_AUTO_REFRESH
static String	DEFAULT_BUNDLE_UPDATE_RANGE
static boolean	DEFAULT_CONFIG_CFG_STORE
static boolean	DEFAULT_DIGRAPH_MBEAN
static int	DEFAULT_DOWNLOAD_THREADS
static String	DEFAULT_FEATURE_RESOLUTION_RANGE
static long	DEFAULT_REPOSITORY_EXPIRATION
static long	DEFAULT_SCHEDULE_DELAY
static int	DEFAULT_SCHEDULE_MAX_RUN
static FeaturesService.SnapshotUpdateBehavior	DEFAULT_UPDATE_SNAPSHOTS
static String	ROOT_REGION
static String	UPDATEABLE_URIS

Method Summary

Modifier and Type	Method	Description
void	addRepository(URI uri)
void	addRepository(URI uri, boolean install)
void	addRequirements(Map<String,Set<String>> requirements, EnumSet<FeaturesService.Option> options)
Repository	createRepository(URI uri)
Feature	getFeature(String name)
Feature	getFeature(String name, String version)
Feature[]	getFeatures(String name)
Feature[]	getFeatures(String name, String version)
String	getFeatureXml(Feature feature)
Repository	getRepository(String repoName)
Repository	getRepository(URI uri)
String	getRepositoryName(URI uri)
String[]	getRepositoryNames()
URI	getRepositoryUriFor(String name, String version)
FeatureState	getState(String featureId)
void	installFeature(String name)
void	installFeature(String name, String version)
void	installFeature(String name, String version, EnumSet<FeaturesService.Option> options)
void	installFeature(String name, EnumSet<FeaturesService.Option> options)
void	installFeature(Feature f, EnumSet<FeaturesService.Option> options)
void	installFeatures(Set<String> features, String region, EnumSet<FeaturesService.Option> options)
void	installFeatures(Set<String> features, EnumSet<FeaturesService.Option> options)
boolean	isInstalled(Feature f)
boolean	isRepositoryUriBlacklisted(URI uri)
boolean	isRequired(Feature f)
Feature[]	listFeatures()
Feature[]	listInstalledFeatures()
Repository[]	listRepositories()
Feature[]	listRequiredFeatures()
Repository[]	listRequiredRepositories()
Map<String,Set<String>>	listRequirements()
void	refreshFeatures(EnumSet<FeaturesService.Option> options)
void	refreshRepositories(Set<URI> uris)
void	refreshRepository(URI uri)
void	registerListener(DeploymentListener listener)
void	registerListener(FeaturesListener listener)
void	removeRepository(URI uri)
void	removeRepository(URI uri, boolean uninstall)
void	removeRequirements(Map<String,Set<String>> requirements, EnumSet<FeaturesService.Option> options)
Feature[]	repositoryProvidedFeatures(URI uri)
void	restoreRepository(URI uri)
void	setResolutionOutputFile(String outputFile)
void	uninstallFeature(String name)
void	uninstallFeature(String name, String version)
void	uninstallFeature(String name, String version, EnumSet<FeaturesService.Option> options)
void	uninstallFeature(String name, EnumSet<FeaturesService.Option> options)
void	uninstallFeatures(Set<String> features, String region, EnumSet<FeaturesService.Option> options)
void	uninstallFeatures(Set<String> features, EnumSet<FeaturesService.Option> options)
void	unregisterListener(DeploymentListener listener)
void	unregisterListener(FeaturesListener listener)
void	updateFeaturesState(Map<String,Map<String,FeatureState>> stateChanges, EnumSet<FeaturesService.Option> options)
void	updateReposAndRequirements(Set<URI> repos, Map<String,Set<String>> requirements, EnumSet<FeaturesService.Option> options)
void	validateRepository(URI uri)	Validate repository contents.

Field Detail

ROOT_REGION

static final String ROOT_REGION

See Also:

Constant Field Values

DEFAULT_UPDATE_SNAPSHOTS

static final FeaturesService.SnapshotUpdateBehavior DEFAULT_UPDATE_SNAPSHOTS

DEFAULT_FEATURE_RESOLUTION_RANGE

static final String DEFAULT_FEATURE_RESOLUTION_RANGE

See Also:

Constant Field Values

DEFAULT_BUNDLE_UPDATE_RANGE

static final String DEFAULT_BUNDLE_UPDATE_RANGE

See Also:

Constant Field Values

UPDATEABLE_URIS

static final String UPDATEABLE_URIS

See Also:

Constant Field Values

DEFAULT_DOWNLOAD_THREADS

static final int DEFAULT_DOWNLOAD_THREADS

See Also:

Constant Field Values

DEFAULT_SCHEDULE_DELAY

static final long DEFAULT_SCHEDULE_DELAY

See Also:

Constant Field Values

DEFAULT_SCHEDULE_MAX_RUN

static final int DEFAULT_SCHEDULE_MAX_RUN

See Also:

Constant Field Values

DEFAULT_REPOSITORY_EXPIRATION

static final long DEFAULT_REPOSITORY_EXPIRATION

See Also:

Constant Field Values

DEFAULT_AUTO_REFRESH

static final boolean DEFAULT_AUTO_REFRESH

See Also:

Constant Field Values

DEFAULT_CONFIG_CFG_STORE

static final boolean DEFAULT_CONFIG_CFG_STORE

See Also:

Constant Field Values

DEFAULT_DIGRAPH_MBEAN

static final boolean DEFAULT_DIGRAPH_MBEAN

See Also:

Constant Field Values

Method Detail

validateRepository

void validateRepository(URI uri)
                 throws Exception

Validate repository contents.

Parameters:

uri - Repository uri.

Throws:

Exception - When validation fails.

isRepositoryUriBlacklisted

boolean isRepositoryUriBlacklisted(URI uri)

repositoryProvidedFeatures

Feature[] repositoryProvidedFeatures(URI uri)
                              throws Exception

Throws:

Exception

addRepository

void addRepository(URI uri)
            throws Exception

Throws:

Exception

addRepository

void addRepository(URI uri,
                   boolean install)
            throws Exception

Throws:

Exception

removeRepository

void removeRepository(URI uri)
               throws Exception

Throws:

Exception

removeRepository

void removeRepository(URI uri,
                      boolean uninstall)
               throws Exception

Throws:

Exception

restoreRepository

void restoreRepository(URI uri)
                throws Exception

Throws:

Exception

listRequiredRepositories

Repository[] listRequiredRepositories()
                               throws Exception

Throws:

Exception

listRepositories

Repository[] listRepositories()
                       throws Exception

Throws:

Exception

getRepository

Repository getRepository(String repoName)
                  throws Exception

Throws:

Exception

getRepository

Repository getRepository(URI uri)
                  throws Exception

Throws:

Exception

getRepositoryName

String getRepositoryName(URI uri)
                  throws Exception

Throws:

Exception

setResolutionOutputFile

void setResolutionOutputFile(String outputFile)

installFeature

void installFeature(String name)
             throws Exception

Throws:

Exception

installFeature

void installFeature(String name,
                    EnumSet<FeaturesService.Option> options)
             throws Exception

Throws:

Exception

installFeature

void installFeature(String name,
                    String version)
             throws Exception

Throws:

Exception

installFeature

void installFeature(String name,
                    String version,
                    EnumSet<FeaturesService.Option> options)
             throws Exception

Throws:

Exception

installFeature

void installFeature(Feature f,
                    EnumSet<FeaturesService.Option> options)
             throws Exception

Throws:

Exception

installFeatures

void installFeatures(Set<String> features,
                     EnumSet<FeaturesService.Option> options)
              throws Exception

Throws:

Exception

installFeatures

void installFeatures(Set<String> features,
                     String region,
                     EnumSet<FeaturesService.Option> options)
              throws Exception

Throws:

Exception

addRequirements

void addRequirements(Map<String,Set<String>> requirements,
                     EnumSet<FeaturesService.Option> options)
              throws Exception

Throws:

Exception

uninstallFeature

void uninstallFeature(String name,
                      EnumSet<FeaturesService.Option> options)
               throws Exception

Throws:

Exception

uninstallFeature

void uninstallFeature(String name)
               throws Exception

Throws:

Exception

uninstallFeature

void uninstallFeature(String name,
                      String version,
                      EnumSet<FeaturesService.Option> options)
               throws Exception

Throws:

Exception

uninstallFeature

void uninstallFeature(String name,
                      String version)
               throws Exception

Throws:

Exception

uninstallFeatures

void uninstallFeatures(Set<String> features,
                       EnumSet<FeaturesService.Option> options)
                throws Exception

Throws:

Exception

uninstallFeatures

void uninstallFeatures(Set<String> features,
                       String region,
                       EnumSet<FeaturesService.Option> options)
                throws Exception

Throws:

Exception

removeRequirements

void removeRequirements(Map<String,Set<String>> requirements,
                        EnumSet<FeaturesService.Option> options)
                 throws Exception

Throws:

Exception

updateFeaturesState

void updateFeaturesState(Map<String,Map<String,FeatureState>> stateChanges,
                         EnumSet<FeaturesService.Option> options)
                  throws Exception

Throws:

Exception

updateReposAndRequirements

void updateReposAndRequirements(Set<URI> repos,
                                Map<String,Set<String>> requirements,
                                EnumSet<FeaturesService.Option> options)
                         throws Exception

Throws:

Exception

createRepository

Repository createRepository(URI uri)
                     throws Exception

Throws:

Exception

listFeatures

Feature[] listFeatures()
                throws Exception

Throws:

Exception

listRequiredFeatures

Feature[] listRequiredFeatures()
                        throws Exception

Throws:

Exception

listInstalledFeatures

Feature[] listInstalledFeatures()
                         throws Exception

Throws:

Exception

listRequirements

Map<String,Set<String>> listRequirements()

isRequired

boolean isRequired(Feature f)

isInstalled

boolean isInstalled(Feature f)

getFeature

Feature getFeature(String name,
                   String version)
            throws Exception

Throws:

Exception

getFeature

Feature getFeature(String name)
            throws Exception

Throws:

Exception

getFeatures

Feature[] getFeatures(String name,
                      String version)
               throws Exception

Throws:

Exception

getFeatures

Feature[] getFeatures(String name)
               throws Exception

Throws:

Exception

refreshRepositories

void refreshRepositories(Set<URI> uris)
                  throws Exception

Throws:

Exception

refreshRepository

void refreshRepository(URI uri)
                throws Exception

Throws:

Exception

getRepositoryUriFor

URI getRepositoryUriFor(String name,
                        String version)

getRepositoryNames

String[] getRepositoryNames()

registerListener

void registerListener(FeaturesListener listener)

unregisterListener

void unregisterListener(FeaturesListener listener)

registerListener

void registerListener(DeploymentListener listener)

unregisterListener

void unregisterListener(DeploymentListener listener)

getState

FeatureState getState(String featureId)

getFeatureXml

String getFeatureXml(Feature feature)

refreshFeatures

void refreshFeatures(EnumSet<FeaturesService.Option> options)
              throws Exception

Throws:

Exception