lumis.portal.deployment

Class DeploymentUtil

java.lang.Object

lumis.portal.deployment.DeploymentUtil

public class DeploymentUtil
extends Object

Utility class for the deployment package.

Since:

6.0.0

Version:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	INSTALLED_MODULES_FOLDER Folder that the modules files are stored.
static String	META_INF_LUMIS_PACKAGE_NAME
static String	META_INF_LUMIS_PACKAGE_XML
static Pattern	PATTERN_INVALID_CHARACTERS_FILE_NAME Pattern that determines whether the characters in the module id are invalid.
static String	TEMP_JAR_MODULE_SUFIX
static String	TO_BE_DELETE_JAR_MODULE_SUFIX

Constructor Summary

Constructors

Constructor and Description
DeploymentUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static String	calculateComponentChecksumInExplodedDir(File componentDirectory, File moduleDirectory) Calculates a checksum for the specified component.
static String	calculateComponentChecksumInJar(File moduleJarFile, String componentId) Calculates a checksum for the specified component.
static String	calculateModuleChecksum(File moduleFile) Calculates a checksum for a module.
static void	copyJarsInPackageToDeploymentFolder(String tempFolderPath, PortalFile rootFile, String finalLocationFolderPath) Copy recursively the files stored on the temp folder to the deployment final folder.
static void	copyModuleToDeploymentFolder(String tempFolderPath, File moduleFile, String finalLocationFolderPath) Copy recursively the files stored on the temp folder to the deployment final folder.
static void	copyPublicFiles(String componentPublicFilesPath, JarFile moduleFile) Copies all public files from the given component public file path to each website.
static void	copyPublicFiles(String componentPublicFilesPath, PortalFile portalFile) Copies all public files from the given component public file path to each website.
static void	deletePublicFiles(Set<String> componentPublicFilesPaths) Deletes the given files from public folder.
static void	deletePublicFiles(String componentPublicFilesPath, JarFile moduleFile) Deletes all public files from the given component public file path for each website.
static void	deletePublicFiles(String componentPublicFilesPath, PortalFile portalFile) Deletes all public files from the given component public file path for each website.
static Set<String>	getAllAvailableResources() Returns all available resources of all deployed modules.
static Document	getComponentDefinitionFromJarModule(File moduleFile, String componentId) Returns the component definition from a given componentId.
static File	getComponentFile(IComponent component) Utility method to obtain an archive file relative to a component.
static File	getComponentFile(IComponent component, ComponentFolder folder) Returns the relative folder path within a component.
static String	getComponentPathById(String id) Returns the component path by it's id.
static String	getComponentPathById(String id, boolean withStartSlash) Returns the component path by it's id.
static List<File>	getDeployFiles(String fileExtension) Utility method to list all files available to be deployed.
static File	getModuleFile(IModule module) Utility method to obtain an archive file relative to a module.
static File	getModuleFile(String moduleId, ModuleType moduleType) Utility method to obtain an archive file relative to a module.
static File	getOldVersionModuleFile(IModule module) Utility method to obtain the old version of the archive file relative to a module.
static Set<String>	getResourcesOfModule(IModule module) Returns all available resources of a given module.
static boolean	renameFile(File src, File dest) Tries to rename a file to another.
static PortalFile	renameTempPortalFileToFinalModulePortalFile(PortalFile tempPortalFile) Renames the temp module file to the unique module file name.

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN_INVALID_CHARACTERS_FILE_NAME

public static final Pattern PATTERN_INVALID_CHARACTERS_FILE_NAME

Pattern that determines whether the characters in the module id are invalid.

Since:

7.1.0

META_INF_LUMIS_PACKAGE_NAME

public static final String META_INF_LUMIS_PACKAGE_NAME

See Also:

Constant Field Values

META_INF_LUMIS_PACKAGE_XML

public static final String META_INF_LUMIS_PACKAGE_XML

See Also:

Constant Field Values

INSTALLED_MODULES_FOLDER

public static final String INSTALLED_MODULES_FOLDER

Folder that the modules files are stored.

Since:

7.1.0

See Also:

Constant Field Values

TEMP_JAR_MODULE_SUFIX

public static final String TEMP_JAR_MODULE_SUFIX

See Also:

Constant Field Values

TO_BE_DELETE_JAR_MODULE_SUFIX

public static final String TO_BE_DELETE_JAR_MODULE_SUFIX

See Also:

Constant Field Values

Constructor Detail

DeploymentUtil

public DeploymentUtil()

Method Detail

getComponentPathById

public static String getComponentPathById(String id)

Returns the component path by it's id.

Parameters:

id - the component id.

Returns:

the component path.

Since:

7.1.0

getComponentPathById

public static String getComponentPathById(String id,
                          boolean withStartSlash)

Returns the component path by it's id.

Parameters:

id - the component id.

withStartSlash - indicates whether a start slash should be included.

Returns:

the component path.

Since:

7.1.0

getComponentDefinitionFromJarModule

public static Document getComponentDefinitionFromJarModule(File moduleFile,
                                           String componentId)
                                                    throws SAXException,
                                                           IOException,
                                                           PortalException

Returns the component definition from a given componentId.

Parameters:

moduleFile - the module file where the component definition will be read.

componentId - the component identifier.

Returns:

the component definition from a given componentId.

Throws:

SAXException - if any problem will be found in the component definition XML.

IOException - if any error occurs during the file.

PortalException - if any other error occurs during the process.

Since:

7.1.0

renameTempPortalFileToFinalModulePortalFile

public static PortalFile renameTempPortalFileToFinalModulePortalFile(PortalFile tempPortalFile)
                                                              throws PortalException,
                                                                     IOException

Renames the temp module file to the unique module file name. The correct module file name is the module identifier, defined inside the lumis-module.xml, together with the module version. The as the module identifier must be unique, the module file name will be the same of the module identifier.

Parameters:

tempPortalFile - the temp portal file to be renamed;

Returns:

the renamed portal file.

Throws:

PortalException

IOException

Since:

7.1.0

getModuleFile

public static File getModuleFile(IModule module)
                          throws PortalException

Utility method to obtain an archive file relative to a module.

Parameters:

module - the module.

moduleType - the module type.

Returns:

the file.

Throws:

PortalException - if any error occurs during the process.

Since:

6.0.0

getOldVersionModuleFile

public static File getOldVersionModuleFile(IModule module)
                                    throws PortalException

Utility method to obtain the old version of the archive file relative to a module.

Parameters:

module - the module.

moduleType - the module type.

Returns:

the file.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

getModuleFile

public static File getModuleFile(String moduleId,
                 ModuleType moduleType)
                          throws PortalException

Utility method to obtain an archive file relative to a module.

Parameters:

moduleId - the module identifier.

moduleType - the module type.

Returns:

the file.

Throws:

PortalException - if any error occurs during the process.

Since:

6.0.0

getComponentFile

public static File getComponentFile(IComponent component)
                             throws PortalException

Utility method to obtain an archive file relative to a component.

Parameters:

component - the module identifier.

Returns:

the file.

Throws:

PortalException

Since:

7.1.0

getComponentFile

public static File getComponentFile(IComponent component,
                    ComponentFolder folder)
                             throws PortalException

Returns the relative folder path within a component.

Parameters:

component - the component.

folder - the desired folder type.

Returns:

the file.

Throws:

PortalException

Since:

7.1.0

getDeployFiles

public static List<File> getDeployFiles(String fileExtension)

Utility method to list all files available to be deployed.

Parameters:

fileExtension - type of files to be considered. May be .zip or .jar.

Returns:

the files list.

Since:

7.1.0

calculateModuleChecksum

public static String calculateModuleChecksum(File moduleFile)
                                      throws IOException

Calculates a checksum for a module.

Parameters:

moduleFile - the module JAR or exploded directory.

Returns:

the checksum.

Throws:

IOException - if an error occurred while reading the file.

Since:

7.1.1

calculateComponentChecksumInJar

public static String calculateComponentChecksumInJar(File moduleJarFile,
                                     String componentId)
                                              throws IOException

Calculates a checksum for the specified component.

Parameters:

moduleJarFile - the module JAR file.

componentId - component identifier.

Returns:

the checksum.

Throws:

IOException - if an error occurred while reading the file.

Since:

7.1.1

calculateComponentChecksumInExplodedDir

public static String calculateComponentChecksumInExplodedDir(File componentDirectory,
                                             File moduleDirectory)
                                                      throws IOException

Calculates a checksum for the specified component.

Parameters:

componentDirectory - the directory that contains the component's componentdefinition.xml file.

moduleDirectory - the component's module directory.

Returns:

the checksum.

Throws:

IOException - if an error occurred while reading the file.

Since:

7.1.1

deletePublicFiles

public static void deletePublicFiles(String componentPublicFilesPath,
                     PortalFile portalFile)
                              throws PortalException

Deletes all public files from the given component public file path for each website.

Parameters:

componentPublicFilesPath - the base path of the component.

portalFile - the component filePath.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

copyPublicFiles

public static void copyPublicFiles(String componentPublicFilesPath,
                   PortalFile portalFile)
                            throws PortalException,
                                   IOException

Copies all public files from the given component public file path to each website.

Parameters:

componentPublicFilesPath - the base path of the component.

portalFile - the component filePath.

Throws:

PortalException - if any error occurs during the process.

IOException

Since:

7.1.0

deletePublicFiles

public static void deletePublicFiles(String componentPublicFilesPath,
                     JarFile moduleFile)
                              throws PortalException

Deletes all public files from the given component public file path for each website.

Parameters:

componentPublicFilesPath - the base path of the component.

portalFile - the component filePath.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

deletePublicFiles

public static void deletePublicFiles(Set<String> componentPublicFilesPaths)
                              throws PortalException

Deletes the given files from public folder.

Parameters:

componentPublicFilesPaths - the files.

Throws:

PortalException

Since:

7.1.0

copyPublicFiles

public static void copyPublicFiles(String componentPublicFilesPath,
                   JarFile moduleFile)
                            throws PortalException,
                                   IOException

Copies all public files from the given component public file path to each website.

Parameters:

componentPublicFilesPath - the base path of the component.

portalFile - the component filePath.

Throws:

PortalException - if any error occurs during the process.

IOException

Since:

7.1.0

copyJarsInPackageToDeploymentFolder

public static void copyJarsInPackageToDeploymentFolder(String tempFolderPath,
                                       PortalFile rootFile,
                                       String finalLocationFolderPath)
                                                throws IOException

Copy recursively the files stored on the temp folder to the deployment final folder. This method uses the FileSystemManager to copy the files over the cluster environment.

Parameters:

tempFolderPath - the path of the temp folder where the files are stored.

rootFile - the current portal file.

finalLocationFolderPath - the complete path of the deployment final folder where the files will be stored.

Throws:

IOException - if any error occurs during the process.

Since:

7.1.1

copyModuleToDeploymentFolder

public static void copyModuleToDeploymentFolder(String tempFolderPath,
                                File moduleFile,
                                String finalLocationFolderPath)
                                         throws IOException

Copy recursively the files stored on the temp folder to the deployment final folder. This method uses the FileSystemManager to copy the files over the cluster environment.

Parameters:

tempFolderPath - the path of the temp folder where the files are stored.

moduleFile - the current portal file.

finalLocationFolderPath - the complete path of the deployment final folder where the files will be stored.

Throws:

IOException - if any error occurs during the process.

Since:

7.1.1

getAllAvailableResources

public static Set<String> getAllAvailableResources()
                                            throws PortalException

Returns all available resources of all deployed modules.

Returns:

all available resources of all deployed modules.

Throws:

PortalException

Since:

7.1.0

getResourcesOfModule

public static Set<String> getResourcesOfModule(IModule module)
                                        throws PortalException

Returns all available resources of a given module.

Parameters:

module - the module.

Returns:

all available resources of a given module.

Throws:

PortalException

Since:

7.1.0

renameFile

public static boolean renameFile(File src,
                 File dest)

Tries to rename a file to another.

Parameters:

src - the source file.

dest - the destination file.

Returns:

whether the file was renamed.

Since:

7.1.0