org.jahia.services.modulemanager.spi.impl

Class DefaultBundleService

java.lang.Object

org.jahia.services.modulemanager.spi.impl.DefaultBundleService

All Implemented Interfaces:

BundleService

public class DefaultBundleService
extends Object
implements BundleService

The default implementation of the BundleService which is using direct bundle operations (BundleContext.installBundle(), bundle.start()/stop()/uninstall()). The implementation is used in a standalone DX instance or in case DX clustering is not activated ( cluster.activated=false).

getInfo/getInfos/getAllInfos methods of this implementation return a map containing a single entry whose key is an empty string, and value is local information about the bundle/bundles. These methods do not support the target parameter, because it only makes sense in a cluster; InvalidTargetException will be thrown in case there is a non-null value passed.

Author:

Sergiy Shyrkov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	DefaultBundleService.ExceptionProvider
protected static class	DefaultBundleService.FailingMap<K,V> A special implementation of the Map whose any method simply throws an exception provided by the associated ExceptionProvider.

Nested classes/interfaces inherited from interface org.jahia.services.modulemanager.spi.BundleService

BundleService.BundleInformation, BundleService.FragmentInformation, BundleService.ModuleInformation

Constructor Summary

Constructors

Constructor and Description
DefaultBundleService()

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.
protected static org.osgi.framework.Bundle	getBundleEnsureExists(BundleInfo bundleInfo)
static String	getClusterNodeId() Returns the cluster node ID of this DX node.
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.
protected void	refreshUninstalledBundle(org.osgi.framework.Bundle bundle)
void	resolve(BundleInfo bundleInfo, String target) Performs the resolve operation with the provided bundle on the target group of cluster nodes.
void	setTemplateManagerService(JahiaTemplateManagerService templateManagerService) Injects an instance of the template manager service.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultBundleService

public DefaultBundleService()

Method Detail

getBundleEnsureExists

protected static org.osgi.framework.Bundle getBundleEnsureExists(BundleInfo bundleInfo)
                                                          throws ModuleNotFoundException

Throws:

ModuleNotFoundException

getClusterNodeId

public static String getClusterNodeId()

Returns the cluster node ID of this DX node.

Returns:

the cluster node ID of this DX node

setTemplateManagerService

public void setTemplateManagerService(JahiaTemplateManagerService templateManagerService)

Injects an instance of the template manager service.

Parameters:

templateManagerService - an instance of the template manager service

install

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

Description copied from interface: BundleService

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.

Specified by:

install in interface BundleService

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

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

Description copied from interface: BundleService

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.

Specified by:

install in interface BundleService

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

refreshUninstalledBundle

protected void refreshUninstalledBundle(org.osgi.framework.Bundle bundle)

resolve

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

Description copied from interface: BundleService

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

Specified by:

resolve in interface BundleService

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

public void start(BundleInfo bundleInfo,
                  String target)
           throws ModuleNotFoundException

Description copied from interface: BundleService

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

Specified by:

start in interface BundleService

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:

ModuleNotFoundException - in case the corresponding bundle cannot be found

stop

public void stop(BundleInfo bundleInfo,
                 String target)
          throws ModuleNotFoundException

Description copied from interface: BundleService

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

Specified by:

stop in interface BundleService

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:

ModuleNotFoundException - in case the corresponding bundle cannot be found

uninstall

public void uninstall(BundleInfo bundleInfo,
                      String target)
               throws ModuleNotFoundException

Description copied from interface: BundleService

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

Specified by:

uninstall in interface BundleService

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:

ModuleNotFoundException - in case the corresponding bundle cannot be found

refresh

public void refresh(BundleInfo bundleInfo,
                    String target)
             throws ModuleManagementException

Description copied from interface: BundleService

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

Specified by:

refresh in interface BundleService

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

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

Description copied from interface: BundleService

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

Specified by:

refresh in interface BundleService

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

public void update(BundleInfo bundleInfo,
                   String target)
            throws ModuleManagementException

Description copied from interface: BundleService

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

Specified by:

update in interface BundleService

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

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

Description copied from interface: BundleService

Get info about a bundle.

Specified by:

getInfo in interface BundleService

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

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

Description copied from interface: BundleService

Get info about multiple bundles.

Specified by:

getInfos in interface BundleService

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

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

Description copied from interface: BundleService

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

Specified by:

getInfos in interface BundleService

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

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

Description copied from interface: BundleService

Get info about all installed bundles.

Specified by:

getAllInfos in interface BundleService

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

public BundleState getLocalState(BundleInfo bundleInfo)
                          throws ModuleNotFoundException

Description copied from interface: BundleService

Get current local state of a bundle.

Specified by:

getLocalState in interface BundleService

Parameters:

bundleInfo - The bundle to retrieve status

Returns:

Current local OSGi state of the bundle

Throws:

ModuleNotFoundException

getLocalInfo

public BundleService.BundleInformation getLocalInfo(BundleInfo bundleInfo)
                                             throws ModuleNotFoundException

Description copied from interface: BundleService

Get local info about a bundle.

Specified by:

getLocalInfo in interface BundleService

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:

ModuleNotFoundException

getLocalInfos

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

Description copied from interface: BundleService

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

Specified by:

getLocalInfos in interface BundleService

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

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

Description copied from interface: BundleService

Get local info about all installed bundles.

Specified by:

getAllLocalInfos in interface BundleService

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