Package lumis.portal.deployment

Provides the API for LumisXP module deployment.

A LumisXP module archive may have a deployment descriptor file META-INF/lumis-module.xml. This file content is defined by the def/lumis/portal/deployment/lumis-module.xsd file.

A ModuleType.JAR_LIBRARY module type is used to be able to perform hot deploy of classes to be used in the portal customization. In most portal configuration and definition files, a class name reference, when is resolved, is searched along the JAR library modules installed in the portal. Such classes have visibility to other classes in the same JAR file and to the classes in the portal application.

Note that classes in the packages java, javax and lumis cannot be overridden by deploying a similar class in a JAR library.

Classes in the portal application have no direct visibility of the classes deployed in a JAR library module. The deployed classes may be accessed through reflection using the class loader provided by IDeploymentManager.getClassLoader(). Resources in the JAR library module may also be obtained using the provided class loader. Note that references to the deployed classes or their instances should not be stored, as it may keep the module in memory when it is undeployed, possibly causing a memory leak.

The folder lumisdata/deploy is the auto-deploy folder. All module files copied to this folder are automatically deployed and automatically undeployed when removed. The result of the operation may be verified in the portal log files.

Since:

5.0.0

Version:

$Revision: 22420 $ $Date: 2019-02-19 16:21:02 -0300 (Tue, 19 Feb 2019) $

Interface Summary

Interface	Description
IComponent	LumisXP component.
IDeploymentExecutionPlan	The execution plan for a given deployment.
IDeploymentManager	Handles the deployment of portal resources.
IDeploymentManagerSPI	Interface of Deployment Manager for internal use.
IModule	A module that is deployed in the LumisXP.
IPortalDeployer	Deprecated. Since 5.0.0 the use of this classes was replaced by operations in IDeploymentManager.
IVersion	LumisXP artifact version.

Class Summary

Class	Description
BusinessContextRegisterHelper	Helper that handles business context registration in a module.
Component	Component implementation.
DeployConfig	Deprecated. Since 5.0.0 the use of IPortalDeployer has been deprecated.
DeploymentActivityPrioritizer	Deployment activity prioritizer.
DeploymentManager	Handles the deployment of portal resources.
DeploymentMessageWriter	Helper class for writing deployment messages.
DeploymentProcessCallbackHandler	Implementation of IProcessCallbackHandler for the deployment process.
DeploymentStringResource	Deployment backend string resource.
DeploymentUtil	Utility class for the deployment package.
DeploymentUtil.ComponentDeploymentMessageSummary	Creates a summary about the deployment process for the component
DeploymentUtil.DeploymentMessageSummary<T extends lumis.portal.deployment.DeploymentMessage,O>	Abstract class for deployment message summary.
DeploymentUtil.ModuleDeploymentMessageSummary	Creates a summary about the deployment process for the module
GenericWarDeployer	Deprecated. Since 5.0.0 the use of IPortalDeployer has been deprecated.
Module	A deployment module entity class.
ServiceRegisterHelper	Helper that handles service register in a module.
ThemeRegisterHelper	Helper that handles theme registration in a module.
Version	Version implementation for deployment Component.
WorkflowRegisterHelper	Helper that handles workflow register in a module.

Enum Summary

Enum	Description
ComponentFolder	Enumeration of component folders.
ComponentStatus	Component status.
DeploymentMessageLevel	Deployment message level.
ModuleScope	Scope of a module.
ModuleStatus	Defines enumeration values for module status.
ModuleType	Defines enumeration values for module types.
PackageOutcome	Defines enumeration values for package outcome.