org.apache.karaf.cellar.features.management

Interface CellarFeaturesMBean

All Known Implementing Classes:

CellarFeaturesMBeanImpl

public interface CellarFeaturesMBean

Describe the operations and attributes on the Cellar Features MBean.

Method Summary

Modifier and Type	Method and Description
void	addRepository(String group, String nameOrUrl) Add a features repository in a cluster group.
void	addRepository(String group, String nameOrUrl, String version) Add a features repository in a cluster group.
void	addRepository(String group, String nameOrUrl, String version, boolean install) Add a features repository in a cluster group.
void	block(String group, String pattern, boolean whitelist, boolean blacklist, boolean in, boolean out) Change the blocking policy for a feature pattern.
TabularData	getFeatures(String group) Get the list of features in a cluster group.
List<String>	getRepositories(String group) Get the list of features repository URLs in a cluster group.
void	installFeature(String group, String name) Install a feature in a cluster group.
void	installFeature(String group, String name, boolean noClean, boolean noRefresh) Install a feature in a cluster group.
void	installFeature(String group, String name, boolean noClean, boolean noRefresh, boolean noStart) Install a feature in a cluster group.
void	installFeature(String group, String name, String version) Install a feature in a cluster group.
void	installFeature(String group, String name, String version, boolean noClean, boolean noRefresh) Install a feature in a cluster group.
void	installFeature(String group, String name, String version, boolean noClean, boolean noRefresh, boolean noStart) Install a feature in a cluster group.
void	refreshRepository(String group, String repository, String version) Refresh a features repository in a cluster group.
void	removeRepository(String group, String repository) Remove a features repository from a cluster group.
void	removeRepository(String group, String repository, boolean uninstall) Remove a features repository from a cluster group, eventually uninstalling all features described in the repository.
void	uninstallFeature(String group, String name) Uninstall a feature from a cluster group.
void	uninstallFeature(String group, String name, boolean noRefresh) Uninstall a feature from a cluster group.
void	uninstallFeature(String group, String name, String version) Uninstall a feature from a cluster group.
void	uninstallFeature(String group, String name, String version, boolean noRefresh) Uninstall a feature from a cluster group.

Method Detail

addRepository

void addRepository(String group,
                   String nameOrUrl)
            throws Exception

Add a features repository in a cluster group.

Parameters:

group - the cluster group name.

nameOrUrl - the features repository name or URL.

Throws:

Exception - in case of add failure.

addRepository

void addRepository(String group,
                   String nameOrUrl,
                   String version)
            throws Exception

Add a features repository in a cluster group.

Parameters:

group - the cluster group name.

nameOrUrl - the features repository name or URL.

version - the features repository version (when name is provided).

Throws:

Exception - in case of add failure.

addRepository

void addRepository(String group,
                   String nameOrUrl,
                   String version,
                   boolean install)
            throws Exception

Add a features repository in a cluster group.

Parameters:

group - the cluster group name.

nameOrUrl - the features repository URL.

version - the features repository version (when name is provided).

install - true to install all features contained in the repository, false else.

Throws:

Exception - in case of add failure.

removeRepository

void removeRepository(String group,
                      String repository)
               throws Exception

Remove a features repository from a cluster group.

Parameters:

group - the cluster group name.

repository - the features repository name or URL.

Throws:

Exception - in case of remove failure.

removeRepository

void removeRepository(String group,
                      String repository,
                      boolean uninstall)
               throws Exception

Remove a features repository from a cluster group, eventually uninstalling all features described in the repository.

Parameters:

group - the cluster group name.

repository - the features repository name or URL.

uninstall - true to uninstall all features described in the repository URL.

Throws:

Exception

refreshRepository

void refreshRepository(String group,
                       String repository,
                       String version)
                throws Exception

Refresh a features repository in a cluster group.

Parameters:

group - the cluster group name.

repository - the features repository name or URL.

version - the features repository version.

Throws:

Exception

installFeature

void installFeature(String group,
                    String name)
             throws Exception

Install a feature in a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

Throws:

Exception - in case of install failure.

installFeature

void installFeature(String group,
                    String name,
                    boolean noClean,
                    boolean noRefresh)
             throws Exception

Install a feature in a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

noClean - true to not uninstall the bundles if the installation of the feature failed, false else.

noRefresh - true to not automatically refresh the bundles, false else.

Throws:

Exception - in case of install failure.

installFeature

void installFeature(String group,
                    String name,
                    boolean noClean,
                    boolean noRefresh,
                    boolean noStart)
             throws Exception

Install a feature in a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

noClean - true to not uninstall the bundles if the installation of the feature failed, false else.

noRefresh - true to not automatically refresh the bundles, false else.

noStart - true to not automatically start the bundles, false else.

Throws:

Exception - in case of install failure.

installFeature

void installFeature(String group,
                    String name,
                    String version)
             throws Exception

Install a feature in a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

version - the feature version.

Throws:

Exception - in case of install failure.

installFeature

void installFeature(String group,
                    String name,
                    String version,
                    boolean noClean,
                    boolean noRefresh)
             throws Exception

Install a feature in a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

version - the feature version.

noClean - true to not uninstall the bundles if the installation of the feature failed, false else.

noRefresh - true to not automatically refresh the bundles, false else.

Throws:

Exception - in case of install failure.

installFeature

void installFeature(String group,
                    String name,
                    String version,
                    boolean noClean,
                    boolean noRefresh,
                    boolean noStart)
             throws Exception

Install a feature in a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

version - the feature version.

noClean - true to not uninstall the bundles if the installation of the feature failued, false else.

noRefresh - true to not automatically refresh the bundles, false else.

noStart - true to not automatically start the bundles, false else.

Throws:

Exception - in case of install failure.

uninstallFeature

void uninstallFeature(String group,
                      String name)
               throws Exception

Uninstall a feature from a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

Throws:

Exception - in case of uninstall failure.

uninstallFeature

void uninstallFeature(String group,
                      String name,
                      boolean noRefresh)
               throws Exception

Uninstall a feature from a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

noRefresh - true to not automatically refresh the bundles, false else.

Throws:

Exception - in case of uninstall failure.

uninstallFeature

void uninstallFeature(String group,
                      String name,
                      String version)
               throws Exception

Uninstall a feature from a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

version - the feature version.

Throws:

Exception - in case of uninstall failure.

uninstallFeature

void uninstallFeature(String group,
                      String name,
                      String version,
                      boolean noRefresh)
               throws Exception

Uninstall a feature from a cluster group.

Parameters:

group - the cluster group name.

name - the feature name.

version - the feature version.

noRefresh - true to not automatically refresh the bundles, false else.

Throws:

Exception - in case of uninstall failure.

block

void block(String group,
           String pattern,
           boolean whitelist,
           boolean blacklist,
           boolean in,
           boolean out)
    throws Exception

Change the blocking policy for a feature pattern.

Parameters:

group - the cluster group name.

pattern - the feature pattern.

whitelist - true to allow the feature by updating the whitelist.

blacklist - true to block the feature by updating the blacklist

in - true to change the inbound blocking policy.

out - true to change the outbound blocking policy.

Throws:

Exception

getRepositories

List<String> getRepositories(String group)
                      throws Exception

Get the list of features repository URLs in a cluster group.

Parameters:

group - the cluster group name.

Returns:

the list of features repository URLs.

Throws:

Exception - in case of retrieval failure.

getFeatures

TabularData getFeatures(String group)
                 throws Exception

Get the list of features in a cluster group.

Parameters:

group - the cluster group name.

Returns:

the list of features.

Throws:

Exception - in case of retrieval failure.