lumis.portal.deployment

Class DeploymentManager

java.lang.Object

lumis.portal.deployment.DeploymentManager

All Implemented Interfaces:

IDeploymentManager, IDeploymentManagerSPI

public class DeploymentManager
extends Object
implements IDeploymentManagerSPI

Handles the deployment of portal resources.

Since:

4.0.7

Version:

$Revision: 16250 $ $Date: 2014-03-29 12:06:05 -0300 (Sat, 29 Mar 2014) $

Constructor Summary

Constructors

Constructor and Description
DeploymentManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	changeComponentResolved(String componentId, ITransaction transaction) Changes the resolved value of the component based on the given component identifier.
void	changeComponentSignal(String componentId, ITransaction transaction) Changes the signal value of the component based on the given component identifier.
void	changeModuleResolved(String moduleId, ITransaction transaction) Changes the resolved value of the module based on the given module identifier.
void	changeModuleSignal(String moduleId, ITransaction transaction) Changes the signal value of the module based on the given module identifier.
IDeploymentExecutionPlan	createModuleDeploymentExecutionPlan(File moduleFolder, boolean forceReprocess, boolean syncStructure) Creates, validates and returns a module deployment execution plan.
IDeploymentExecutionPlan	createModuleDeploymentProcess(InputStream moduleArchive, boolean reprocessAllComponents) Creates a deployment execution plan for deploying the given module.
IDeploymentExecutionPlan	createModuleUndeploymentProcess(List<IModule> modules) Creates a deployment execution plan for undeployment of the given modules.
IDeploymentExecutionPlan	createPackageDeploymentExecutionPlan(File packageFolder, boolean forceReprocess, String packageId) Creates, validates and returns a deployment execution plan.
IDeploymentExecutionPlan	createPackageDeploymentExecutionPlan(File packageFolder, boolean forceReprocess, String packageId, boolean syncStructure) Creates, validates and returns a package deployment execution plan.
IDeploymentExecutionPlan	createPackageDeploymentProcess(File packageArchive, boolean reprocessAllComponents) Creates a deployment execution plan for deploying the given package.
void	deploy(IModule module)
ModuleType	detectModuleType(InputStream moduleArchive) Detects the module type of an archive, based on its contents.
Class<?>	getClass(String className) Deprecated.
ClassLoader	getClassLoader() Returns a class loader that provides access to classes and resources in all deployed JAR modules and the portal.
IComponent	getComponent(String componentId) Returns the component with the specified identifier.
List<IComponent>	getComponents() Returns the list of all installed components.
String	getLastDeployInstallationId() Returns the Last Deploy Installation identifier.
IModule	getModule(String moduleId) Returns the module with the specified identifier.
Collection<IModule>	getModules(ModuleType moduleType) Returns the currently installed modules of the specified type.
IPortalDeployer	getPortalDeployer(DeployConfig deployConfig) Deprecated.
void	init() Initializes the deployment manager.
boolean	isInstallInProgress() Returns whether a deploy installation is in progress.
void	registerDeployer(IPortalDeployer deployer) Deprecated.
String	submit(IDeploymentExecutionPlan executionPlan) Submits the execution plan created by this manager and returns the created process identifier.
void	undeploy(IModule module)
boolean	unregisterDeployer(IPortalDeployer deployer) Deprecated.
void	updateChannelId(String componentId, String channelId) Updates the channelId of the given component.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentManager

public DeploymentManager()

Method Detail

registerDeployer

@Deprecated
public void registerDeployer(IPortalDeployer deployer)

Deprecated.

Description copied from interface: IDeploymentManager

Register a deployer that may be used when performing a deployment.

Specified by:

registerDeployer in interface IDeploymentManager

Parameters:

deployer - the deployer.

unregisterDeployer

@Deprecated
public boolean unregisterDeployer(IPortalDeployer deployer)

Deprecated.

Description copied from interface: IDeploymentManager

Unregisters a deployer that may be used when performing a deployment.

Specified by:

unregisterDeployer in interface IDeploymentManager

Parameters:

deployer - the deployer.

Returns:

getPortalDeployer

@Deprecated
public IPortalDeployer getPortalDeployer(DeployConfig deployConfig)
                                  throws PortalException

Deprecated.

Description copied from interface: IDeploymentManager

Returns the deployer to be used to deploy to the portal.

Specified by:

getPortalDeployer in interface IDeploymentManager

Parameters:

deployConfig - the deployment specification.

Returns:

the deployer.

Throws:

PortalException - if there is no deployer that can handle the specified deployment.

init

public void init()

Initializes the deployment manager. This method initializes the deployed modules and starts the monitoring of deployments.

Since:

5.0.0

getClass

@Deprecated
public Class<?> getClass(String className)
                  throws ClassNotFoundException

Deprecated.

Description copied from interface: IDeploymentManager

Returns the Class object associated with the class or interface with the given string name, within the deployed JAR library modules or the shared level class loader.

Specified by:

getClass in interface IDeploymentManager

Parameters:

className - the fully qualified name of the desired class.

Returns:

the Class object for the class with the specified name.

Throws:

ClassNotFoundException - if the class cannot be located.

See Also:

Class#forName(String)}

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: IDeploymentManager

Returns a class loader that provides access to classes and resources in all deployed JAR modules and the portal.

When the returned class loader is used to obtain a class, the search is first done in the currently running modules and then in the portal main class loader.

When the returned class loader is used to obtain a resource, the search is first done in the lumisdata/def folder (for backwards compatibility), then in currently running modules and then in the portal main class loader.

Main uses are:

• ClassLoader.loadClass(String): for obtaining a Class.
• ClassLoader.getResourceAsStream(String), ClassLoader.getResource(String) or ClassLoader.getResources(String): for accessing resources.

Specified by:

getClassLoader in interface IDeploymentManager

Returns:

the class loader.

detectModuleType

public ModuleType detectModuleType(InputStream moduleArchive)
                            throws IOException,
                                   IllegalModuleArchiveException

Description copied from interface: IDeploymentManager

Detects the module type of an archive, based on its contents.

Specified by:

detectModuleType in interface IDeploymentManager

Parameters:

moduleArchive - the archive content input stream.

Returns:

the module type.

Throws:

IOException - if an I/O error occurs.

IllegalModuleArchiveException - if the archive module type could not be recognized.

undeploy

public void undeploy(IModule module)
              throws PortalException

Throws:

PortalException

deploy

public void deploy(IModule module)
            throws PortalException

Throws:

PortalException

getModules

public Collection<IModule> getModules(ModuleType moduleType)
                               throws PortalException

Description copied from interface: IDeploymentManager

Returns the currently installed modules of the specified type.

Specified by:

getModules in interface IDeploymentManager

Parameters:

moduleType - the module type.

Returns:

the modules.

Throws:

PortalException

getModule

public IModule getModule(String moduleId)
                  throws PortalException

Description copied from interface: IDeploymentManager

Returns the module with the specified identifier.

Specified by:

getModule in interface IDeploymentManager

Parameters:

moduleId - the module identifier.

Returns:

the module.

Throws:

PortalObjectNotFoundException - if no module with the given identifier was found.

PortalException

createModuleDeploymentProcess

public IDeploymentExecutionPlan createModuleDeploymentProcess(InputStream moduleArchive,
                                                     boolean reprocessAllComponents)
                                                       throws IllegalModuleArchiveException,
                                                              PortalException

Description copied from interface: IDeploymentManager

Creates a deployment execution plan for deploying the given module. The returned Process is not yet ready to be executed.

Specified by:

createModuleDeploymentProcess in interface IDeploymentManager

Parameters:

moduleArchive - the module archive input stream.

reprocessAllComponents - indicates if all components present in the module must be reprocessed.

Returns:

the deployment plan.

Throws:

IllegalModuleArchiveException - if the given archive is not a valid module archive.

PortalException

See Also:

IDeploymentManager.submit(IDeploymentExecutionPlan)

createPackageDeploymentProcess

public IDeploymentExecutionPlan createPackageDeploymentProcess(File packageArchive,
                                                      boolean reprocessAllComponents)
                                                        throws IllegalPackageArchiveException,
                                                               PortalException

Description copied from interface: IDeploymentManager

Creates a deployment execution plan for deploying the given package.

Specified by:

createPackageDeploymentProcess in interface IDeploymentManager

Parameters:

packageArchive - the package file.

reprocessAllComponents - indicates if all components present in the package must be reprocessed.

Returns:

the deployment plan.

Throws:

IllegalPackageArchiveException - if the given archive is not a valid package archive.

PortalException

See Also:

IDeploymentManager.submit(IDeploymentExecutionPlan)

createModuleUndeploymentProcess

public IDeploymentExecutionPlan createModuleUndeploymentProcess(List<IModule> modules)
                                                         throws PortalException

Description copied from interface: IDeploymentManager

Creates a deployment execution plan for undeployment of the given modules.

Specified by:

createModuleUndeploymentProcess in interface IDeploymentManager

Parameters:

modules - the modules to be undeployed.

Returns:

the deployment plan.

Throws:

PortalException

See Also:

IDeploymentManager.submit(IDeploymentExecutionPlan)

submit

public String submit(IDeploymentExecutionPlan executionPlan)
              throws PortalException

Description copied from interface: IDeploymentManager

Submits the execution plan created by this manager and returns the created process identifier.

Specified by:

submit in interface IDeploymentManager

Parameters:

executionPlan - the execution plan.

Returns:

the process identifier.

Throws:

PortalException

getLastDeployInstallationId

public String getLastDeployInstallationId()
                                   throws PortalException

Description copied from interface: IDeploymentManagerSPI

Returns the Last Deploy Installation identifier.

Specified by:

getLastDeployInstallationId in interface IDeploymentManagerSPI

Returns:

the Last Deploy Installation identifier.

Throws:

PortalException - if any error occurs during the process.

isInstallInProgress

public boolean isInstallInProgress()
                            throws PortalException

Description copied from interface: IDeploymentManagerSPI

Returns whether a deploy installation is in progress.

Specified by:

isInstallInProgress in interface IDeploymentManagerSPI

Returns:

true if a deploy installation is in progress and false otherwise.

Throws:

PortalException - if any error occurs during the process.

getComponents

public List<IComponent> getComponents()
                               throws PortalException

Description copied from interface: IDeploymentManagerSPI

Returns the list of all installed components.

Specified by:

getComponents in interface IDeploymentManagerSPI

Returns:

the list of all installed components.

Throws:

PortalException - if any error occurs during the process.

createPackageDeploymentExecutionPlan

public IDeploymentExecutionPlan createPackageDeploymentExecutionPlan(File packageFolder,
                                                            boolean forceReprocess,
                                                            String packageId)
                                                              throws PortalException

Description copied from interface: IDeploymentManagerSPI

Creates, validates and returns a deployment execution plan.

Specified by:

createPackageDeploymentExecutionPlan in interface IDeploymentManagerSPI

Parameters:

packageFolder - the folder that contains the jar modules and package definition.

forceReprocess - indicates if must reprocess all modules and components involved in the package.

packageId - package identifier. This parameter is optional and it value is the package file name.

Returns:

a validated deployment execution plan.

Throws:

PortalException - if any error occurs during the process.

getComponent

public IComponent getComponent(String componentId)
                        throws PortalException

Description copied from interface: IDeploymentManager

Returns the component with the specified identifier.

Specified by:

getComponent in interface IDeploymentManager

Parameters:

componentId - the component identifier.

Returns:

the component.

Throws:

PortalObjectNotFoundException - if no component with the given identifier was found.

PortalException

changeComponentSignal

public void changeComponentSignal(String componentId,
                         ITransaction transaction)
                           throws PortalException

Description copied from interface: IDeploymentManagerSPI

Changes the signal value of the component based on the given component identifier. If the current value is true, calling this method the current value will be changed to false. And if the current value is false, calling this method the current value will be changed to true.

Specified by:

changeComponentSignal in interface IDeploymentManagerSPI

Parameters:

componentId - the component identifier to be changes the signal value.

transaction - the transaction to be used to change the component signal value.

Throws:

PortalException - if any error occurs during the process.

PortalObjectNotFoundException - if the component cannot be located.

changeModuleSignal

public void changeModuleSignal(String moduleId,
                      ITransaction transaction)
                        throws PortalException

Description copied from interface: IDeploymentManagerSPI

Changes the signal value of the module based on the given module identifier. If the current value is true, calling this method the current value will be changed to false. And if the current value is false, calling this method the current value will be changed to true.

Specified by:

changeModuleSignal in interface IDeploymentManagerSPI

Parameters:

moduleId - the module identifier to be changes the signal value.

transaction - the transaction to be used to change the module signal value.

Throws:

PortalException - if any error occurs during the process.

PortalObjectNotFoundException - if the module cannot be located.

changeComponentResolved

public void changeComponentResolved(String componentId,
                           ITransaction transaction)
                             throws PortalException

Description copied from interface: IDeploymentManagerSPI

Changes the resolved value of the component based on the given component identifier. If the current value is true, calling this method the current value will be changed to false. And if the current value is false, calling this method the current value will be changed to true.

Specified by:

changeComponentResolved in interface IDeploymentManagerSPI

Parameters:

componentId - the component identifier to be changes the signal value.

transaction - the transaction to be used to change the component signal value.

Throws:

PortalException - if any error occurs during the process.

PortalObjectNotFoundException - if the component cannot be located.

changeModuleResolved

public void changeModuleResolved(String moduleId,
                        ITransaction transaction)
                          throws PortalException

Description copied from interface: IDeploymentManagerSPI

Changes the resolved value of the module based on the given module identifier. If the current value is true, calling this method the current value will be changed to false. And if the current value is false, calling this method the current value will be changed to true.

Specified by:

changeModuleResolved in interface IDeploymentManagerSPI

Parameters:

moduleId - the module identifier to be changes the signal value.

transaction - the transaction to be used to change the module signal value.

Throws:

PortalException - if any error occurs during the process.

PortalObjectNotFoundException - if the module cannot be located.

updateChannelId

public void updateChannelId(String componentId,
                   String channelId)
                     throws PortalException

Description copied from interface: IDeploymentManagerSPI

Updates the channelId of the given component. If the channelId parameter is assigned to another component, a PortalException will be raised.

Specified by:

updateChannelId in interface IDeploymentManagerSPI

Parameters:

componentId - the component identifier to be updated.

channelId - the channelId to be assigned.

Throws:

PortalException - if any error occurs during the process.

createModuleDeploymentExecutionPlan

public IDeploymentExecutionPlan createModuleDeploymentExecutionPlan(File moduleFolder,
                                                           boolean forceReprocess,
                                                           boolean syncStructure)
                                                             throws PortalException

Description copied from interface: IDeploymentManagerSPI

Creates, validates and returns a module deployment execution plan.

Specified by:

createModuleDeploymentExecutionPlan in interface IDeploymentManagerSPI

Parameters:

moduleFolder - the folder that corresponds to the module root.

forceReprocess - indicates if must reprocess the module and its components.

syncStructure - indicates whether the components structures will be synchronized.

Returns:

a validated deployment execution plan.

Throws:

PortalException - if any error occurs during the process.

createPackageDeploymentExecutionPlan

public IDeploymentExecutionPlan createPackageDeploymentExecutionPlan(File packageFolder,
                                                            boolean forceReprocess,
                                                            String packageId,
                                                            boolean syncStructure)
                                                              throws PortalException

Description copied from interface: IDeploymentManagerSPI

Creates, validates and returns a package deployment execution plan.

Specified by:

createPackageDeploymentExecutionPlan in interface IDeploymentManagerSPI

Parameters:

packageFolder - the folder that contains the jar modules and package definition.

forceReprocess - indicates if must reprocess all modules and components involved in the package.

packageId - package identifier. This parameter is optional and it value is the package file name.

syncStructure - indicates whether the components structures will be synchronized.

Returns:

a validated deployment execution plan.

Throws:

PortalException - if any error occurs during the process.