org.jahia.services.modulemanager.impl

Class ModuleManagerImpl

java.lang.Object

org.jahia.services.modulemanager.impl.ModuleManagerImpl

All Implemented Interfaces:

ModuleManager, ReadOnlyModeCapable

public class ModuleManagerImpl
extends Object
implements ModuleManager, ReadOnlyModeCapable

The main entry point service 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.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
ModuleManagerImpl()

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.
int	getReadOnlyModePriority() Get the priority of the service.
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.
void	setBundleService(BundleService bundleService) Injects an instance of the bundle service.
void	setPersister(BundlePersister persister) Injects an instance of the bundle persister.
void	setTemplateManagerService(JahiaTemplateManagerService templateManagerService)
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.
void	switchReadOnlyMode(boolean enable) Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleManagerImpl

public ModuleManagerImpl()

Method Detail

install

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

Description copied from interface: ModuleManager

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

Specified by:

install in interface ModuleManager

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

install

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

Description copied from interface: ModuleManager

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

Specified by:

install in interface ModuleManager

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

install

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

Description copied from interface: ModuleManager

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

Specified by:

install in interface ModuleManager

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

setBundleService

public void setBundleService(BundleService bundleService)

Injects an instance of the bundle service.

Parameters:

bundleService - an instance of the bundle service

setPersister

public void setPersister(BundlePersister persister)

Injects an instance of the bundle persister.

Parameters:

persister - an instance of the bundle persister

start

public OperationResult start(String bundleKey,
                             String target)

Description copied from interface: ModuleManager

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

Specified by:

start in interface ModuleManager

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

stop

public OperationResult stop(String bundleKey,
                            String target)

Description copied from interface: ModuleManager

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

Specified by:

stop in interface ModuleManager

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

uninstall

public OperationResult uninstall(String bundleKey,
                                 String target)

Description copied from interface: ModuleManager

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

Specified by:

uninstall in interface ModuleManager

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

refresh

public OperationResult refresh(String bundleKey,
                               String target)

Description copied from interface: ModuleManager

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

Specified by:

refresh in interface ModuleManager

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

update

public OperationResult update(String bundleKey,
                              String target)

Description copied from interface: ModuleManager

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

Specified by:

update in interface ModuleManager

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

getInfo

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

Description copied from interface: ModuleManager

Get info about a bundle.

Specified by:

getInfo in interface ModuleManager

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

getInfos

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

Description copied from interface: ModuleManager

Get info about multiple bundles.

Specified by:

getInfos in interface ModuleManager

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

getBucketInfos

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

Description copied from interface: ModuleManager

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

Specified by:

getBucketInfos in interface ModuleManager

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

getAllInfos

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

Description copied from interface: ModuleManager

Get info about all installed bundles.

Specified by:

getAllInfos in interface ModuleManager

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

getLocalState

public BundleState getLocalState(String bundleKey)

Description copied from interface: ModuleManager

Get current local state of a bundle.

Specified by:

getLocalState in interface ModuleManager

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

getLocalInfo

public BundleService.BundleInformation getLocalInfo(String bundleKey)

Description copied from interface: ModuleManager

Get local info about a bundle.

Specified by:

getLocalInfo in interface ModuleManager

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

getBucketLocalInfos

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

Description copied from interface: ModuleManager

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

Specified by:

getBucketLocalInfos in interface ModuleManager

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

getAllLocalInfos

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

Description copied from interface: ModuleManager

Get local info about all installed bundles.

Specified by:

getAllLocalInfos in interface ModuleManager

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

setTemplateManagerService

public void setTemplateManagerService(JahiaTemplateManagerService templateManagerService)

switchReadOnlyMode

public void switchReadOnlyMode(boolean enable)

Description copied from interface: ReadOnlyModeCapable

Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.

Specified by:

switchReadOnlyMode in interface ReadOnlyModeCapable

Parameters:

enable - true in case the read-only mode should be enabled; false otherwise

getReadOnlyModePriority

public int getReadOnlyModePriority()

Description copied from interface: ReadOnlyModeCapable

Get the priority of the service.

Specified by:

getReadOnlyModePriority in interface ReadOnlyModeCapable

Returns:

the priority of the service; higher priority means earlier invocation of switchReadOnlyMode when switching read only mode on, and later invocation when switching it off

storeAllLocalPersistentStates

public Collection<BundlePersistentInfo> storeAllLocalPersistentStates()

Description copied from interface: ModuleManager

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

Specified by:

storeAllLocalPersistentStates in interface ModuleManager

Returns:

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

applyBundlesPersistentStates

public OperationResult applyBundlesPersistentStates(String target)

Description copied from interface: ModuleManager

Restores persistent state of all bundles from the internal storage.

Specified by:

applyBundlesPersistentStates in interface ModuleManager

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