org.jahia.services.modulemanager

Interface ModuleManager

All Known Implementing Classes:

ModuleManagerImpl

public interface ModuleManager

Entry point interface for the module management service, providing functionality for module deployment, undeployment, start and stop operations, which are performed in a seamless way on a standalone installation as well as across the platform cluster.

The following bundle key format is supported in the most of operations of this service:

<groupId>/<symbolicName>/<version>

For example:

org.jahia.modules/article/2.0.2

Note, please, the version here is the Bundle-Version. In case of SNAPSHOT versions it can differ in the format from the module version.

In cases, when the bundle can be unambiguously identified either by the symbolic name and version or by the symbolic name alone, the group ID or the group ID and version correspondingly could me omitted, i.e.:

article/2.0.2

or

article

Author:

Sergiy Shyrkov

Method Summary

Modifier and Type	Method and Description
OperationResult	applyBundlesPersistentStates(String target) Restores persistent state of all bundles from the internal storage.
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,Map<String,BundleService.BundleInformation>>	getBucketInfos(String bundleBucketKey, String target) Get info about multiple bundles belonging to a single bundle bucket.
Map<String,BundleService.BundleInformation>	getBucketLocalInfos(String bundleBucketKey) Get local info about multiple bundles belonging to a single bundle bucket.
Map<String,BundleService.BundleInformation>	getInfo(String bundleKey, String target) Get info about a bundle.
Map<String,Map<String,BundleService.BundleInformation>>	getInfos(Collection<String> bundleKeys, String target) Get info about multiple bundles.
BundleService.BundleInformation	getLocalInfo(String bundleKey) Get local info about a bundle.
BundleState	getLocalState(String bundleKey) Get current local state of a bundle.
OperationResult	install(Collection<org.springframework.core.io.Resource> bundleResources, String target, boolean start) Install specified bundles on the target group of cluster nodes, optionally starting them right after.
OperationResult	install(org.springframework.core.io.Resource bundleResource, String target) Install the specified bundle on the target group of cluster nodes.
OperationResult	install(org.springframework.core.io.Resource bundleResource, String target, boolean start) Install the specified bundle on the target group of cluster nodes, optionally starting it right after.
OperationResult	refresh(String bundleKey, String target) Refresh the specified bundle on the target group of cluster nodes.
OperationResult	start(String bundleKey, String target) Start the specified bundle on the target group of cluster nodes.
OperationResult	stop(String bundleKey, String target) Stop the specified bundle on the target group of cluster nodes.
Collection<BundlePersistentInfo>	storeAllLocalPersistentStates() Store persistent state of all bundles in the internal storage for the purpose of restore in the future.
OperationResult	uninstall(String bundleKey, String target) Uninstall the specified bundle on the target group of cluster nodes.
OperationResult	update(String bundleKey, String target) Update the specified bundle on the target group of cluster nodes.

Method Detail

install

OperationResult install(org.springframework.core.io.Resource bundleResource,
                        String target)
                 throws ModuleManagementException

Install the specified bundle on the target group of cluster nodes.

Parameters:

bundleResource - The resource representing a bundle to install

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

Returns:

The result of the install operation

Throws:

ModuleManagementException - Is case of problems

install

OperationResult install(org.springframework.core.io.Resource bundleResource,
                        String target,
                        boolean start)
                 throws ModuleManagementException

Install the specified bundle on the target group of cluster nodes, optionally starting it right after.

Parameters:

bundleResource - The resource, representing a bundle to install

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

start - Whether the installed bundle should be started right away

Returns:

The result of the install operation

Throws:

ModuleManagementException - In case of problems

install

OperationResult install(Collection<org.springframework.core.io.Resource> bundleResources,
                        String target,
                        boolean start)
                 throws ModuleManagementException

Install specified bundles on the target group of cluster nodes, optionally starting them right after.

Parameters:

bundleResources - A collection of resources, representing bundles to install

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

start - Whether installed bundles should be started right away

Returns:

The result of the install operation

Throws:

ModuleManagementException - In case of problems

start

OperationResult start(String bundleKey,
                      String target)
               throws ModuleManagementException

Start the specified bundle on the target group of cluster nodes.

Parameters:

bundleKey - Bundle key to start (see class JavaDoc for the supported key format)

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

Returns:

The result of the start operation

Throws:

ModuleManagementException - In case of problems

stop

OperationResult stop(String bundleKey,
                     String target)
              throws ModuleManagementException

Stop the specified bundle on the target group of cluster nodes.

Parameters:

bundleKey - Bundle key to stop (see class JavaDoc for the supported key format)

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

Returns:

The result of the stop operation

Throws:

ModuleManagementException - In case of problems

uninstall

OperationResult uninstall(String bundleKey,
                          String target)
                   throws ModuleManagementException

Uninstall the specified bundle on the target group of cluster nodes.

Parameters:

bundleKey - Bundle key to uninstall (see class JavaDoc for the supported key format)

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

Returns:

The result of the uninstall operation

Throws:

ModuleManagementException - In case of problems

refresh

OperationResult refresh(String bundleKey,
                        String target)
                 throws ModuleManagementException

Refresh the specified bundle on the target group of cluster nodes.

Parameters:

bundleKey - Bundle key to refresh (see class JavaDoc for the supported key format)

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

Returns:

The result of the refresh operation

Throws:

ModuleManagementException - In case of problems

update

OperationResult update(String bundleKey,
                       String target)
                throws ModuleManagementException

Update the specified bundle on the target group of cluster nodes.

Parameters:

bundleKey - Bundle key to update (see class JavaDoc for the supported key format)

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

Returns:

The result of the update operation

Throws:

ModuleManagementException - in case of problems

getInfo

Map<String,BundleService.BundleInformation> getInfo(String bundleKey,
                                                    String target)
                                             throws ModuleManagementException

Get info about a bundle.

Parameters:

bundleKey - Bundle key (see class JavaDoc for the supported key format; note that bundle version is required)

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

Returns:

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

Throws:

ModuleManagementException

getInfos

Map<String,Map<String,BundleService.BundleInformation>> getInfos(Collection<String> bundleKeys,
                                                                 String target)
                                                          throws ModuleManagementException

Get info about multiple bundles.

Parameters:

bundleKeys - Bundle keys (see class JavaDoc for the supported key format; note that bundle version is required)

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

Returns:

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

Throws:

ModuleManagementException

getBucketInfos

Map<String,Map<String,BundleService.BundleInformation>> getBucketInfos(String bundleBucketKey,
                                                                       String target)
                                                                throws ModuleManagementException

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

Parameters:

bundleBucketKey - Bundle bucket key

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

Returns:

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

Throws:

ModuleManagementException

getAllInfos

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

Get info about all installed bundles.

Parameters:

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

Returns:

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

Throws:

ModuleManagementException

getLocalState

BundleState getLocalState(String bundleKey)
                   throws ModuleManagementException

Get current local state of a bundle.

Parameters:

bundleKey - Bundle key (see class JavaDoc for the supported key format; note that bundle version is required)

Returns:

Current local OSGi state of the bundle

Throws:

ModuleManagementException

getLocalInfo

BundleService.BundleInformation getLocalInfo(String bundleKey)
                                      throws ModuleManagementException

Get local info about a bundle.

Parameters:

bundleKey - Bundle key (see class JavaDoc for the supported key format; note that bundle version is required)

Returns:

Local info about the bundle; represented by either a BundleService.ModuleInfo instance in case the bundle is a DX module, or a BundleService.BundleInfo instance otherwise

Throws:

ModuleManagementException

getBucketLocalInfos

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

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

Parameters:

bundleBucketKey - Bundle bucket key

Returns:

A map of local bundle info by bundle key; each map value is either a BundleService.ModuleInfo instance in case the bundle is a DX module, or a BundleService.BundleInfo instance otherwise

Throws:

ModuleManagementException

getAllLocalInfos

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

Get local info about all installed bundles.

Returns:

A map of local bundle info by bundle key; each map value is either a BundleService.ModuleInfo instance in case the bundle is a DX module, or a BundleService.BundleInfo instance otherwise

Throws:

ModuleManagementException

storeAllLocalPersistentStates

Collection<BundlePersistentInfo> storeAllLocalPersistentStates()
                                                        throws ModuleManagementException

Store persistent state of all bundles in the internal storage for the purpose of restore in the future.

Returns:

A collection of info objects describing the bundles whose persistent state have been stored

Throws:

ModuleManagementException

applyBundlesPersistentStates

OperationResult applyBundlesPersistentStates(String target)
                                      throws ModuleManagementException

Restores persistent state of all bundles from the internal storage.

Parameters:

target - The group of cluster nodes targeted by this operation (see BundleService class JavaDoc)

Returns:

The result of this operation which provides a list of bundles whose state has been updated

Throws:

ModuleManagementException