org.jahia.services.modulemanager.spi

Interface BundleService

All Known Implementing Classes:

BundleServiceDelegate, DefaultBundleService

public interface BundleService

Service for bundle related operations.

The value of the target group of cluster nodes could be specified as null, meaning the default group is concerned, which includes all cluster nodes.

Author:

Sergiy Shyrkov

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BundleService.BundleInformation Info about a bundle.
static interface	BundleService.FragmentInformation Info about a bundle fragment.
static interface	BundleService.ModuleInformation Info about a bundle which is a DX module.

Method Summary

Modifier and Type	Method and Description
Map<String,Map<String,BundleService.BundleInformation>>	getAllInfos(String target) Get info about all installed bundles.
Map<String,BundleService.BundleInformation>	getAllLocalInfos() Get local info about all installed bundles.
Map<String,BundleService.BundleInformation>	getInfo(BundleInfo bundleInfo, String target) Get info about a bundle.
Map<String,Map<String,BundleService.BundleInformation>>	getInfos(BundleBucketInfo bundleBucketInfo, String target) Get info about multiple bundles belonging to a single bundle bucket.
Map<String,Map<String,BundleService.BundleInformation>>	getInfos(Collection<BundleInfo> bundleInfos, String target) Get info about multiple bundles.
BundleService.BundleInformation	getLocalInfo(BundleInfo bundleInfo) Get local info about a bundle.
Map<String,BundleService.BundleInformation>	getLocalInfos(BundleBucketInfo bundleBucketInfo) Get local info about multiple bundles belonging to a single bundle bucket.
BundleState	getLocalState(BundleInfo bundleInfo) Get current local state of a bundle.
void	install(String uri, String target, boolean start) Install the specified bundle on the target group of cluster nodes, optionally starting it right after if the start parameter is true.
void	install(String uri, String target, boolean start, int startLevel) Install the specified bundle on the target group of cluster nodes, optionally starting it right after if the start parameter is true.
void	refresh(BundleInfo bundleInfo, String target) Performs the refresh operation with the provided bundle on the target group of cluster nodes.
void	refresh(Collection<BundleInfo> bundleInfos, String target) Performs the refresh operation with the provided bundles on the target group of cluster nodes.
void	resolve(BundleInfo bundleInfo, String target) Performs the resolve operation with the provided bundle on the target group of cluster nodes.
void	start(BundleInfo bundleInfo, String target) Performs the start operation with the provided bundle on the target group of cluster nodes.
void	stop(BundleInfo bundleInfo, String target) Performs the stop operation with the provided bundle on the target group of cluster nodes.
void	uninstall(BundleInfo bundleInfo, String target) Performs the uninstall operation with the provided bundle on the target group of cluster nodes.
void	update(BundleInfo bundleInfo, String target) Performs the update operation with the provided bundle on the target group of cluster nodes.

Method Detail

install

void install(String uri,
             String target,
             boolean start)
      throws ModuleManagementException,
             InvalidTargetException

Install the specified bundle on the target group of cluster nodes, optionally starting it right after if the start parameter is true. In case the same version of the bundle is already installed, update it with the snapshot referenced by the uri.

Parameters:

uri - The bundle location

target - The group of cluster nodes targeted by the install operation (see JavaDoc of the class)

start - Whether the installed bundle should be started right away

Throws:

ModuleManagementException - in case of operation failure

InvalidTargetException - in case target is not a valid target for module operation

install

void install(String uri,
             String target,
             boolean start,
             int startLevel)
      throws ModuleManagementException,
             InvalidTargetException

Install the specified bundle on the target group of cluster nodes, optionally starting it right after if the start parameter is true. In case the same version of the bundle is already installed, update it with the snapshot referenced by the uri.

Parameters:

uri - The bundle location

target - The group of cluster nodes targeted by the install operation (see JavaDoc of the class)

start - Whether the installed bundle should be started right away

startLevel - The start level to apply to the installed bundle

Throws:

ModuleManagementException - in case of operation failure

InvalidTargetException - in case target is not a valid target for module operation

resolve

void resolve(BundleInfo bundleInfo,
             String target)
      throws ModuleManagementException,
             ModuleNotFoundException,
             InvalidTargetException

Performs the resolve operation with the provided bundle on the target group of cluster nodes.

Parameters:

bundleInfo - The bundle to perform operation for

target - The group of cluster nodes targeted by the resolve operation (see JavaDoc of the class)

Throws:

ModuleManagementException - in case of operation failure

ModuleNotFoundException - in case the corresponding bundle cannot be found

InvalidTargetException - in case target is not a valid target for module operation

start

void start(BundleInfo bundleInfo,
           String target)
    throws ModuleManagementException,
           ModuleNotFoundException,
           InvalidTargetException

Performs the start operation with the provided bundle on the target group of cluster nodes.

Parameters:

bundleInfo - The bundle to perform operation for

target - The group of cluster nodes targeted by the start operation (see JavaDoc of the class)

Throws:

ModuleManagementException - in case of operation failure

ModuleNotFoundException - in case the corresponding bundle cannot be found

InvalidTargetException - in case target is not a valid target for module operation

stop

void stop(BundleInfo bundleInfo,
          String target)
   throws ModuleManagementException,
          ModuleNotFoundException,
          InvalidTargetException

Performs the stop operation with the provided bundle on the target group of cluster nodes.

Parameters:

bundleInfo - The bundle to perform operation for

target - The group of cluster nodes targeted by the stop operation (see JavaDoc of the class)

Throws:

ModuleManagementException - in case of operation failure

ModuleNotFoundException - in case the corresponding bundle cannot be found

InvalidTargetException - in case target is not a valid target for module operation

uninstall

void uninstall(BundleInfo bundleInfo,
               String target)
        throws ModuleManagementException,
               ModuleNotFoundException,
               InvalidTargetException

Performs the uninstall operation with the provided bundle on the target group of cluster nodes.

Parameters:

bundleInfo - The bundle to perform operation for

target - The group of cluster nodes targeted by the uninstall operation (see JavaDoc of the class)

Throws:

ModuleManagementException - in case of operation failure

ModuleNotFoundException - in case the corresponding bundle cannot be found

InvalidTargetException - in case target is not a valid target for module operation

refresh

void refresh(BundleInfo bundleInfo,
             String target)
      throws ModuleManagementException,
             ModuleNotFoundException,
             InvalidTargetException

Performs the refresh operation with the provided bundle on the target group of cluster nodes.

Parameters:

bundleInfo - The bundle to perform operation for

target - The group of cluster nodes targeted by the refresh operation (see JavaDoc of the class)

Throws:

ModuleManagementException - in case of operation failure

ModuleNotFoundException - in case the corresponding bundle cannot be found

InvalidTargetException - in case target is not a valid target for module operation

refresh

void refresh(Collection<BundleInfo> bundleInfos,
             String target)
      throws ModuleManagementException,
             ModuleNotFoundException,
             InvalidTargetException

Performs the refresh operation with the provided bundles on the target group of cluster nodes.

Parameters:

bundleInfos - The bundles to perform operation for

target - The group of cluster nodes targeted by the refresh operation (see JavaDoc of the class)

Throws:

ModuleManagementException - in case of operation failure

ModuleNotFoundException - in case any if the corresponding bundles cannot be found

InvalidTargetException - in case target is not a valid target for module operation

update

void update(BundleInfo bundleInfo,
            String target)
     throws ModuleManagementException,
            ModuleNotFoundException,
            InvalidTargetException

Performs the update operation with the provided bundle on the target group of cluster nodes.

Parameters:

bundleInfo - The bundle to perform operation for

target - The group of cluster nodes targeted by the update operation (see JavaDoc of the class)

Throws:

ModuleManagementException - in case of operation failure

ModuleNotFoundException - in case the corresponding bundle cannot be found

InvalidTargetException - in case target is not a valid target for module operation

getInfo

Map<String,BundleService.BundleInformation> getInfo(BundleInfo bundleInfo,
                                                    String target)
                                             throws ModuleManagementException,
                                                    InvalidTargetException

Get info about a bundle.

Parameters:

bundleInfo - The bundle to retrieve info about

target - The group of cluster nodes to get info from (see JavaDoc of the class)

Returns:

A map of bundle info by cluster node name; each map value is either a LocalModuleInfo instance in case the bundle is a DX module, or a LocalBundleInfo instance otherwise

Throws:

InvalidTargetException - in case the target is not a valid one

ModuleManagementException

getInfos

Map<String,Map<String,BundleService.BundleInformation>> getInfos(Collection<BundleInfo> bundleInfos,
                                                                 String target)
                                                          throws ModuleManagementException,
                                                                 InvalidTargetException

Get info about multiple bundles.

Parameters:

bundleInfos - The bundles to retrieve info about

target - The group of cluster nodes to get info from (see JavaDoc of the class)

Returns:

A map of bundle info by bundle key by cluster node name; each map value is either a LocalModuleInfo instance in case the bundle is a DX module, or a LocalBundleInfo instance otherwise

Throws:

InvalidTargetException - in case the target is not a valid one

ModuleManagementException

getInfos

Map<String,Map<String,BundleService.BundleInformation>> getInfos(BundleBucketInfo bundleBucketInfo,
                                                                 String target)
                                                          throws ModuleManagementException,
                                                                 InvalidTargetException

Get info about multiple bundles belonging to a single bundle bucket.

Parameters:

bundleBucketInfo - The bundle bucket

target - The group of cluster nodes to get info from (see JavaDoc of the class)

Returns:

A map of bundle info by bundle key by cluster node name; each map value is either a LocalModuleInfo instance in case the bundle is a DX module, or a LocalBundleInfo instance otherwise

Throws:

ModuleManagementException

InvalidTargetException

getAllInfos

Map<String,Map<String,BundleService.BundleInformation>> getAllInfos(String target)
                                                             throws ModuleManagementException,
                                                                    InvalidTargetException

Get info about all installed bundles.

Parameters:

target - The group of cluster nodes to get info from (see JavaDoc of the class)

Returns:

A map of bundle info by bundle key by cluster node name; each map value is either a LocalModuleInfo instance in case the bundle is a DX module, or a LocalBundleInfo instance otherwise

Throws:

InvalidTargetException - in case the target is not a valid one

ModuleManagementException

getLocalState

BundleState getLocalState(BundleInfo bundleInfo)
                   throws ModuleManagementException,
                          ModuleNotFoundException

Get current local state of a bundle.

Parameters:

bundleInfo - The bundle to retrieve status

Returns:

Current local OSGi state of the bundle

Throws:

ModuleManagementException

ModuleNotFoundException

getLocalInfo

BundleService.BundleInformation getLocalInfo(BundleInfo bundleInfo)
                                      throws ModuleManagementException,
                                             ModuleNotFoundException

Get local info about a bundle.

Parameters:

bundleInfo - The bundle to retrieve info about

Returns:

Local info about the bundle; represented by either a LocalModuleInfo instance in case the bundle is a DX module, or a LocalBundleInfo instance otherwise

Throws:

ModuleManagementException

ModuleNotFoundException

getLocalInfos

Map<String,BundleService.BundleInformation> getLocalInfos(BundleBucketInfo bundleBucketInfo)
                                                   throws ModuleManagementException

Get local info about multiple bundles belonging to a single bundle bucket.

Parameters:

bundleBucketInfo - The bundle bucket

Returns:

A map of bundle info by bundle key; each map value is either a LocalModuleInfo instance in case the bundle is a DX module, or a LocalBundleInfo instance otherwise

Throws:

ModuleManagementException

getAllLocalInfos

Map<String,BundleService.BundleInformation> getAllLocalInfos()
                                                      throws ModuleManagementException

Get local info about all installed bundles.

Returns:

A map of bundle info by bundle key; each map value is either a LocalModuleInfo instance in case the bundle is a DX module, or a LocalBundleInfo instance otherwise

Throws:

ModuleManagementException