lumis.portal.deployment

Interface IDeploymentManagerSPI

All Superinterfaces:

IDeploymentManager

All Known Implementing Classes:

DeploymentManager

public interface IDeploymentManagerSPI
extends IDeploymentManager

Interface of Deployment Manager for internal use.

Since:

7.1.0

Version:

$Revision: 16236 $ $Date: 2014-03-27 16:15:46 -0300 (Thu, 27 Mar 2014) $

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	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.
List<IComponent>	getComponents() Returns the list of all installed components.
String	getLastDeployInstallationId() Returns the Last Deploy Installation identifier.
boolean	isInstallInProgress() Returns whether a deploy installation is in progress.
void	updateChannelId(String componentId, String channelId) Updates the channelId of the given component.

Methods inherited from interface lumis.portal.deployment.IDeploymentManager

createModuleDeploymentProcess, createModuleUndeploymentProcess, createPackageDeploymentProcess, detectModuleType, getClass, getClassLoader, getComponent, getModule, getModules, getPortalDeployer, registerDeployer, submit, unregisterDeployer

Method Detail

getLastDeployInstallationId

String getLastDeployInstallationId()
                                   throws PortalException

Returns the Last Deploy Installation identifier.

Returns:

the Last Deploy Installation identifier.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

isInstallInProgress

boolean isInstallInProgress()
                            throws PortalException

Returns whether a deploy installation is in progress.

Returns:

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

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

changeModuleSignal

void changeModuleSignal(String moduleId,
                      ITransaction transaction)
                        throws PortalException

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.

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.

Since:

7.1.0

changeComponentSignal

void changeComponentSignal(String componentId,
                         ITransaction transaction)
                           throws PortalException

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.

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.

Since:

7.1.0

changeModuleResolved

void changeModuleResolved(String moduleId,
                        ITransaction transaction)
                          throws PortalException

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.

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.

Since:

7.1.0

changeComponentResolved

void changeComponentResolved(String componentId,
                           ITransaction transaction)
                             throws PortalException

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.

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.

Since:

7.1.0

getComponents

List<IComponent> getComponents()
                               throws PortalException

Returns the list of all installed components.

Returns:

the list of all installed components.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

createPackageDeploymentExecutionPlan

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

Creates, validates and returns a deployment execution plan.

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.

Since:

7.1.1

createPackageDeploymentExecutionPlan

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

Creates, validates and returns a package deployment execution plan.

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.

isScriptPackageOnly - indicates that the current package is a package that contains only the lumis-package.xml file.

syncStructure - indicates whether the components structures will be synchronized.

Returns:

a validated deployment execution plan.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.1

updateChannelId

void updateChannelId(String componentId,
                   String channelId)
                     throws PortalException

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

Parameters:

componentId - the component identifier to be updated.

channelId - the channelId to be assigned.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

createModuleDeploymentExecutionPlan

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

Creates, validates and returns a module deployment execution plan.

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.

Since:

7.1.1