Package lumis.portal.deployment

Interface IDeploymentManager

  • All Known Subinterfaces:
    IDeploymentManagerSPI
    All Known Implementing Classes:
    DeploymentManager
    @StableMinor(version="16.0",
             sinceVersion="7.1")
public interface IDeploymentManager
    Handles the deployment of portal resources.

    All methods in this manager execute in their own transaction.

    Since:
    4.0.7
    Version:
    $Revision: 25808 $ $Date: 2023-07-04 15:20:55 -0300 (Tue, 04 Jul 2023) $

    • 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
java.lang.Class<?> getClass​(java.lang.String className)
                     throws java.lang.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:
        java.lang.ClassNotFoundException - if the class cannot be located.
        Since:
        5.0.0

      • getClassLoader

        java.lang.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.

        The returned instance must not be held for long as it may change between deploys. Instead obtain it again using this method.

        Returns:
        the class loader.
        Since:
        6.0.0

      • getModules

        java.util.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

      • getComponent

        IComponent getComponent​(java.lang.String componentId)
                 throws PortalException
        Returns the component with the specified identifier.
        Parameters:
        componentId - the component identifier.
        Returns:
        the component.
        Throws:
        PortalObjectNotFoundException - if no component with the given identifier was found.
        PortalException
        Since:
        7.1.0