info.magnolia.module
Interface InstallContext

All Known Implementing Classes:
InstallContextImpl

public interface InstallContext

The InstallContext provides Tasks and install/update UI with methods to log, get content and status.

Version:
$Revision: $ ($Author: $)
Author:
gjoseph

Nested Class Summary
static class InstallContext.Message
          Log messages kept in the InstallContext.
static class InstallContext.MessagePriority
          Priority for InstallContext.Messages.
 
Method Summary
 void error(String message, Throwable th)
           
 HierarchyManager getConfigHierarchyManager()
           
 javax.jcr.Session getConfigJCRSession()
           
 ModuleDefinition getCurrentModuleDefinition()
          Allows generic tasks to know what's being installed/updated.
 int getExecutedTaskCount()
           
 HierarchyManager getHierarchyManager(String workspace)
           
 javax.jcr.Session getJCRSession(String workspaceName)
           
 Map<String,List<InstallContext.Message>> getMessages()
          A Map of messages where the key is the module name.
 Content getModulesNode()
           
 Content getOrCreateCurrentModuleConfigNode()
           
 Content getOrCreateCurrentModuleNode()
           
 InstallStatus getStatus()
           
 int getTotalTaskCount()
           
 boolean hasModulesNode()
           
 void info(String message)
           
 boolean isModuleRegistered(String moduleName)
           
 void restartNeeded(String message)
           
 void warn(String message)
           
 

Method Detail

info

void info(String message)

warn

void warn(String message)

error

void error(String message,
           Throwable th)

restartNeeded

void restartNeeded(String message)

getExecutedTaskCount

int getExecutedTaskCount()

getTotalTaskCount

int getTotalTaskCount()

getStatus

InstallStatus getStatus()

getMessages

Map<String,List<InstallContext.Message>> getMessages()
A Map of messages where the key is the module name.


getHierarchyManager

HierarchyManager getHierarchyManager(String workspace)

getConfigHierarchyManager

HierarchyManager getConfigHierarchyManager()

hasModulesNode

boolean hasModulesNode()

getModulesNode

Content getModulesNode()
                       throws javax.jcr.RepositoryException
Returns:
the root node for all modules in the config workspace.
Throws:
javax.jcr.RepositoryException

getOrCreateCurrentModuleNode

Content getOrCreateCurrentModuleNode()
                                     throws javax.jcr.RepositoryException
Throws:
javax.jcr.RepositoryException

getOrCreateCurrentModuleConfigNode

Content getOrCreateCurrentModuleConfigNode()
                                           throws javax.jcr.RepositoryException
Throws:
javax.jcr.RepositoryException

getCurrentModuleDefinition

ModuleDefinition getCurrentModuleDefinition()
Allows generic tasks to know what's being installed/updated.


isModuleRegistered

boolean isModuleRegistered(String moduleName)

getJCRSession

javax.jcr.Session getJCRSession(String workspaceName)
                                throws javax.jcr.RepositoryException
Throws:
javax.jcr.RepositoryException

getConfigJCRSession

javax.jcr.Session getConfigJCRSession()
                                      throws javax.jcr.RepositoryException
Throws:
javax.jcr.RepositoryException


Copyright © 2003–2014 Magnolia International Ltd.. All rights reserved.