lumis.portal.deployment
Interface IDeploymentManager

All Known Implementing Classes:

DeploymentManager

@StableMinor(version="6.2",
             sinceVersion="6.0")
public interface IDeploymentManager

Handles the deployment of portal resources.

All methods in this manager execute in their own transaction.

Since:

4.0.7

Method Summary

ModuleType	detectModuleType(InputStream moduleArchive) Detects the module type of an archive, based on its contents.
IModule	distribute(String moduleId, InputStream moduleArchive) Distributes a module archive to the portal servers.
Class<?>	getClass(String className) Deprecated. Since 6.0.0 deployed resources or classes should be accessed using the class loader provided by getClassLoader(). Uses of IDeploymentManager.getClass(className) method may be replaced by IDeploymentManager.getClassLoader().loadClass(className).
ClassLoader	getClassLoader() Returns a class loader that provides access to classes and resources in all deployed JAR modules and the portal.
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. Since 5.0.0 the use of IPortalDeployer has been deprecated.
void	registerDeployer(IPortalDeployer deployer) Deprecated. Since 5.0.0 the use of IPortalDeployer has been deprecated.
void	start(IModule module) Starts the execution of a module.
void	stop(IModule module) Stops the execution of a module.
void	undeploy(IModule module) Undeploys a module from the portal servers.
boolean	unregisterDeployer(IPortalDeployer deployer) Deprecated. Since 5.0.0 the use of IPortalDeployer has been deprecated.

Method Detail

registerDeployer

@Deprecated
void registerDeployer(IPortalDeployer deployer)

Deprecated. Since 5.0.0 the use of IPortalDeployer has been deprecated.

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

Parameters:

deployer - the deployer.

Since:

4.0.7

unregisterDeployer

@Deprecated
boolean unregisterDeployer(IPortalDeployer deployer)

Deprecated. Since 5.0.0 the use of IPortalDeployer has been deprecated.

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

Parameters:

deployer - the deployer.

Returns:

Since:

4.0.7

getPortalDeployer

@Deprecated
IPortalDeployer getPortalDeployer(DeployConfig deployConfig)
                                  throws PortalException

Deprecated. Since 5.0.0 the use of IPortalDeployer has been deprecated.

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

Parameters:

deployConfig - the deployment specification.

Returns:

the deployer.

Throws:

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

Since:

4.0.7

getClass

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

Deprecated. Since 6.0.0 deployed resources or classes should be accessed using the class loader provided by getClassLoader(). Uses of IDeploymentManager.getClass(className) method may be replaced by IDeploymentManager.getClassLoader().loadClass(className).

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.

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.

Since:

5.0.0

See Also:

Class#forName(String)}

getClassLoader

ClassLoader getClassLoader()

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.

Returns:

the class loader.

Since:

6.0.0

detectModuleType

ModuleType detectModuleType(InputStream moduleArchive)
                            throws IOException,
                                   IllegalModuleArchiveException,
                                   PortalException

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

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.

PortalException

Since:

5.0.0

distribute

IModule distribute(String moduleId,
                   InputStream moduleArchive)
                   throws IOException,
                          IllegalModuleArchiveException,
                          PortalException

Distributes a module archive to the portal servers. This operation validates the archive, generates all container specific classes and interfaces, and moves the resulting archive to all portal server nodes.

Parameters:

moduleId - the identifier for the module being deployed.

moduleArchive - the module archive input stream.

Returns:

the deployed module object.

Throws:

IOException - if an I/O error occurs.

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

PortalException

Since:

5.0.0

start

void start(IModule module)
           throws PortalException

Starts the execution of a module. If the module is already running it is not affected.

Parameters:

module - the module.

Throws:

PortalException

Since:

5.0.0

stop

void stop(IModule module)
          throws PortalException

Stops the execution of a module. If the module is not running it is not affected.

Parameters:

module - the module.

Throws:

PortalException

Since:

5.0.0

undeploy

void undeploy(IModule module)
              throws PortalException

Undeploys a module from the portal servers.

Parameters:

module - the module to be undeployed.

Throws:

PortalException

Since:

5.0.0

getModules

Collection<IModule> getModules(ModuleType moduleType)
                               throws PortalException

Returns the currently installed modules of the specified type.

Parameters:

moduleType - the module type.

Returns:

the modules.

Throws:

PortalException

Since:

5.0.0

getModule

IModule getModule(String moduleId)
                  throws PortalException

Returns the module with the specified identifier.

Parameters:

moduleId - the module identifier.

Returns:

the module.

Throws:

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

PortalException

Since:

5.0.0