Package | Description |
---|---|
info.magnolia.freemarker.setup | |
info.magnolia.i18nsystem.setup | |
info.magnolia.jcr.nodebuilder.task | |
info.magnolia.module | |
info.magnolia.module.delta | |
info.magnolia.module.webapp |
This package contains the necessary classes to determine if the web-app needs to be bootstrapped, and to do so.
|
info.magnolia.rendering.module.setup | |
info.magnolia.setup |
This package contains the classes necessary to install and update Magnolia's core module.
|
info.magnolia.setup.for4_5 | |
info.magnolia.setup.for5_0 | |
info.magnolia.setup.for5_2 | |
info.magnolia.setup.initial | |
info.magnolia.templating.module.setup |
Modifier and Type | Method and Description |
---|---|
protected List<Task> |
FreemarkerSupportModuleVersionHandler.getBasicInstallTasks(InstallContext installContext) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractRemoveHardcodedI18nPropertiesTask
Removes some well-known deprecated i18n properties whose keys are now generated via the
I18nizer mechanism. |
class |
RemoveHardcodedI18nPropertiesFromDialogsTask
Removes deprecated i18n properties from all dialogs under this app.
|
class |
RemoveHardcodedI18nPropertiesFromSubappsTask
Removes deprecated i18n properties from all subapps under this app.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractNodeBuilderTask
Base class for
Task s using the info.magnolia.jcr.nodebuilder API. |
class |
ModuleConfigNodeBuilderTask
A task using the
info.magnolia.jcr.nodebuilder API, applying operations on a the config node of the current module. |
class |
ModuleNodeBuilderTask
A task using the
info.magnolia.jcr.nodebuilder API, applying operations on a the root node of the current module. |
class |
NodeBuilderTask
A task using the
info.magnolia.jcr.nodebuilder API, applying operations on a given path. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractModuleVersionHandler.ModuleVersionToLatestTask
The task which modifies the "version" property to the version being installed.
|
class |
AbstractModuleVersionHandler.ModuleVersionUpdateTask
The task which modifies the "version" property to the version we're updating to.
|
Modifier and Type | Method and Description |
---|---|
protected List<Task> |
DefaultModuleVersionHandler.getBasicInstallTasks(InstallContext installContext)
This method should generally not be overridden.
|
protected abstract List<Task> |
AbstractModuleVersionHandler.getBasicInstallTasks(InstallContext installContext) |
protected List<Task> |
AbstractModuleVersionHandler.getDefaultUpdateTasks(Version forVersion) |
protected List<Task> |
AbstractModuleVersionHandler.getExtraInstallTasks(InstallContext installContext)
Override this method to add specific install tasks to your module.
|
protected List<Task> |
AbstractModuleVersionHandler.getStartupTasks(InstallContext installContext)
Override this method to add specific startup tasks to your module.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractConditionalRepositoryTask
An abstract implementation of a RepositoryTask that only needs to be executed when a specific node is not found in the
repository.
|
class |
AbstractRepositoryTask
An abstract implementation of AbstractTask which simply
wraps the execute call in a try/catch block, avoiding
many verbose and irrelevant code lines in actual tasks,
leaving room for smarter and more interesting exception
handling, when they can actually be handled.
|
class |
AbstractTask
Abstract implementation of the Task interface which handles the mandatory properties name and description.
|
class |
AddGroupToGroupTask
A task to nest a group inside another, using
GroupManager . |
class |
AddMimeMappingTask
Task that adds a mime mapping to
server/MIMEMapping . |
class |
AddPermissionTask
A task to add a permission to a role, using
RoleManager . |
class |
AddRoleToGroupTask
A task to add a role to a group, using
GroupManager . |
class |
AddRoleToUserTask
A task to add a role to a user, using
UserManager . |
class |
AddURIPermissionTask
Adds a URI permission to a role.
|
class |
AddUserToGroupTask
A task to add a user to a group, using
UserManager . |
class |
AllChildrenNodesOperation
This task executes the abstract method on every child node.
|
class |
AllModulesNodeOperation
An abstract that will perform an operation on all modules node found in the configuration repository.
|
class |
ArrayDelegateTask
A task that simply delegates to an array of other tasks.
|
class |
BackupTask
Backs up a node in the same workspace under a specific backup path.
|
class |
BootstrapConditionally
A Task which bootstraps if the node targeted by the bootstrap file does not exist.
|
class |
BootstrapResourcesTask
Base class for tasks which bootstrap resources.
|
class |
BootstrapSingleModuleResource
Bootstraps a classpath resources relative to the module's bootstrap folder: /mgnl-bootstrap/<module-name>>.
|
class |
BootstrapSingleResource
A Task which bootstraps a single file.
|
class |
BootstrapSingleResourceAndOrderAfter
Bootstrap a single file, and places the bootstrapped node after the specified node.
|
class |
BootstrapSingleResourceAndOrderBefore
Bootstrap a single file, and places the bootstrapped node before the specified node..
|
class |
ChangeAllPropertiesWithCertainValueTask
Changes all properties in an entire workspace that are of type
PropertyType.STRING and has a certain value. |
class |
ChangeNodeTypeTask
Changes a node type.
|
class |
ChangeTemplateTask
Task to change the template of page or component.
|
class |
ChangeVirtualUriMappingTask
Task for changing Virtual URI mappings - replaces old toURI and oldURI values with new ones.
|
class |
CheckAndModifyPartOfPropertyValueTask
If the property (Property) contains the expected string, then it will be replaced by the new string.
|
class |
CheckAndModifyPropertyValueTask
If the specified property (NodeData) has the expected value, then it will be replaced by the new value.
|
class |
CheckNodeDelegateTask
A task that delegates to another if a checkNode is true, or to an optional other if it is false.
|
class |
CheckOrCreatePropertyTask
Sets the specified property with a new value or creates the property with the new value.
|
class |
ChildrenExistsDelegateTask
A task that delegates to another depending on existence of children.
|
class |
ConditionalDelegateTask
A task that delegates to another if a condition is true, or to an optional other if it is false.
|
class |
CopyNodeTask
Copies a node by performing a in session copy operation.
|
class |
CopyOrReplaceNodePropertiesTask
Copies a node's properties to another node.
|
class |
CopyPropertyTask
Copies a property.
|
class |
CreateNodePathTask
A Task to create a full path, i.e the parent doesn't need to exist.
|
class |
CreateNodeTask
Creates a node in the given parent with the given name and type.
|
class |
ExecuteCommandTask
Task that executes command.
|
class |
FilterOrderingTask
Orders a filter after a given set of other filters.
|
class |
FindAndChangeTemplateIdTask
Task which find all content with specific template id and change template id to new one.
|
class |
FixUserRolePermissionsPropertyTask
Task to fix permissions property of a user role.
|
class |
HasPropertyDelegateTask
A task that delegates to another depending on whether a specified property exists or not.
|
class |
IsAuthorInstanceDelegateTask
A task that depends on the value of the /server/admin config value.
|
class |
IsInstallSamplesTask
A Task which delegates depending on the magnolia.bootstrap.samples property.
|
class |
IsModuleInstalledOrRegistered
A Task which delegates depending on the existence of a module.
|
class |
ModuleBootstrapTask
A task to bootstrap a module.
|
class |
ModuleDependencyBootstrapTask
A Task which will bootstrap files if an optional module is installed or registered:
any resource under "/info/magnolia/module/moduleName/setup/dependencyName".
|
class |
ModuleFilesExtraction
A task which extracts all files for a module.
|
class |
MoveAndRenamePropertyTask
A task to move and rename properties, taking default values into account.
|
class |
MoveNodeTask
This task moves a specified Node to a new destination.
|
class |
MovePropertyTask
Moves a property.
|
class |
NewPropertyTask
Creates a new property.
|
class |
NodeCheckDelegateTask
A task that delegates to another if a checkNode is true, or to an optional other if it is false.
|
class |
NodeExistsDelegateTask
A task that delegates to another depending on whether a specified node exists or not.
|
class |
NodeVisitorTask
The
NodeVisitorTask helps traversing a repository, match nodes and execute changes on them. |
class |
OrderFilterBeforeTask
Orders a filter before a given set of other filters.
|
class |
OrderNodeAfterTask
Orders a node after the specified sibling node.
|
class |
OrderNodeBeforeTask
Orders a node before the specified sibling node.
|
class |
OrderNodeTo1stPosTask
Deprecated.
since 5.2.2 - use
OrderNodeToFirstPositionTask instead |
class |
OrderNodeToFirstPositionTask
Sets the Node of a given path in a given repository to the first position of all children.
|
class |
PartialBootstrapTask
This task is used to bootstrap a part of a file.
|
class |
PathExistenceDelegateTask
Checks if multiple paths exist/do not exist before executing passed task.
|
class |
PropertiesImportTask
A Task which will import nodes and properties using a .properties file.
|
class |
PropertyExistsDelegateTask
A task that delegates to another depending on whether a specified property exists or not.
|
class |
PropertyValueDelegateTask
A task which delegates to another if a property has a given value.
|
class |
PropertyValuesTask
A tasks that offers helper methods to check on certain properties.
|
class |
QueryTask
An abstract task to perform operations on nodes returned by a given query.
|
class |
RegisterModuleServletsTask
Reads the servlets to register from the module descriptor.
|
class |
RegisterNodeTypeTask
Registers (or re-registers) node type.
|
class |
RegisterServletTask
Registers a servlet definition from a module descriptor into the /server/filters/servlets node.
|
class |
RemoveDuplicatePermissionTask
A task to find and remove duplicate permission from a role and a workspace.
|
class |
RemoveInstallFilesTask
Removes install file(s) from ${magnolia.home}/${filesPath} and its md5 node from "config:server/install/mgnl-files/${filesPath}".
|
class |
RemoveNodesTask
Removes a list of nodes referenced by their absolute paths.
In case a Node does not exist, logs an info message if the flag RemoveNodesTask.displayInfoMessageForMissingNodes is set to true.Otherwise just continues with the next absolute path from the list. |
class |
RemoveNodeTask
Removes the specified node.
|
class |
RemoveNodeWoChildren
A task that removes node if that has no children.
|
class |
RemovePermissionTask
A task to remove a permission from a role, using
RoleManager . |
class |
RemovePropertiesTask
Removes a list of properties referenced by their absolute paths.
In case property does not exist, logs an info message if the flag RemovePropertiesTask.displayInfoMessageForMissingNodes is set to true.Otherwise just continues with the next absolute path from the list. |
class |
RemovePropertyTask
Removes a property and optionally logs its absence.
|
class |
RenameNodesTask
Renames all nodes having a certain name and nodeType to the provided new name.
|
class |
RenameNodeTask
This task renames a specified node.
|
class |
RenamePropertiesTask
Renames all properties having a certain name to the provided new name.
|
class |
RenamePropertyAllModulesNodeTask
Renames a property found in a given subnode of all modules; typically, renames "path" to "templatePath"
for all nodes under "paragraphs" for each module.
|
class |
RenamePropertyTask
Renames a property.
|
class |
ReplaceIfExistsTask
A task which replaces a node by bootstrapping a file, only if it exists.
|
class |
SamplesBootstrapTask
A task which bootstraps the module's content under /mgnl-bootstrap-samples/ if
the magnolia.bootstrap.samples property is set the true.
|
class |
SetPropertyTask
Sets a new value for a property.
|
class |
SetupModuleRepositoriesTask
Bootstrap empty repositories for the current module.
|
class |
ValueOfPropertyDelegateTask
A task which delegates to another if a property has a given value.
|
class |
WarnTask
A task which does nothing else than logging a warning message.
|
Modifier and Type | Method and Description |
---|---|
List<Task> |
DeltaBuilder.getTasks() |
List<Task> |
Delta.getTasks()
Should not return a read-only List, as the version handler might add tasks as appropriate.
|
Modifier and Type | Method and Description |
---|---|
DeltaBuilder |
DeltaBuilder.addTask(Task t) |
void |
ArrayDelegateTask.addTask(Task task)
Tasks are meant to be immutable.
|
static DeltaBuilder |
DeltaBuilder.update(Version toVersion,
String description,
Task task)
Convenience factory method for an Update Delta with a single task.
|
Modifier and Type | Method and Description |
---|---|
DeltaBuilder |
DeltaBuilder.addTasks(List<Task> tasks) |
static DeltaBuilder |
DeltaBuilder.startup(ModuleDefinition moduleDef,
List<Task> tasks) |
Constructor and Description |
---|
ArrayDelegateTask(String name,
String description,
Task... tasks) |
ArrayDelegateTask(String name,
Task... tasks) |
BootstrapConditionally(String taskName,
String taskDescription,
String repositoryName,
String pathToCheck,
String resourceToBootstrap,
Task ifNodeExists)
Executes the given task if the specified node exists in the specific repository, bootstraps the given resource otherwise.
|
BootstrapConditionally(String taskName,
String taskDescription,
String resourceToBootstrap,
Task ifNodeExists)
Bootstraps the given resource if the corresponding node does not exist yet, executes the given task otherwise.
|
CheckNodeDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String nodePath,
String propertyName,
Task ifTrue,
Task ifFalse) |
ChildrenExistsDelegateTask(String name,
String description,
String workspaceName,
String pathToCheck,
String contentType,
Task ifTrue) |
ChildrenExistsDelegateTask(String name,
String description,
String workspaceName,
String pathToCheck,
String contentType,
Task ifTrue,
Task ifFalse) |
ConditionalDelegateTask(String taskName,
String taskDescription,
Task ifTrue) |
ConditionalDelegateTask(String taskName,
String taskDescription,
Task ifTrue,
Task ifFalse) |
HasPropertyDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String parentPath,
String propertyName,
Task ifTrue) |
HasPropertyDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String parentPath,
String propertyName,
Task ifTrue,
Task ifFalse) |
HasPropertyDelegateTask(String taskName,
String parentPath,
String propertyName,
Task ifTrue) |
HasPropertyDelegateTask(String taskName,
String parentPath,
String propertyName,
Task ifTrue,
Task ifFalse) |
IsAuthorInstanceDelegateTask(String taskName,
String taskDescription,
Task isAuthor) |
IsAuthorInstanceDelegateTask(String taskName,
String taskDescription,
Task isAuthor,
Task isPublic) |
IsAuthorInstanceDelegateTask(String taskName,
Task isAuthor) |
IsAuthorInstanceDelegateTask(String taskName,
Task isAuthor,
Task isPublic) |
IsInstallSamplesTask(String taskName,
String taskDescription,
Task ifTrue) |
IsInstallSamplesTask(String taskName,
String taskDescription,
Task ifTrue,
Task ifFalse) |
IsModuleInstalledOrRegistered(String taskName,
String taskDescription,
String moduleName,
Task ifTrue) |
IsModuleInstalledOrRegistered(String taskName,
String taskDescription,
String moduleName,
Task ifTrue,
Task ifFalse) |
IsModuleInstalledOrRegistered(String taskName,
String moduleName,
Task ifTrue) |
IsModuleInstalledOrRegistered(String taskName,
String moduleName,
Task ifTrue,
Task ifFalse) |
NodeCheckDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String nodePath,
String propertyName,
Task ifTrue,
Task ifFalse) |
NodeExistsDelegateTask(String name,
String description,
String workspaceName,
String pathToCheck,
Task ifTrue) |
NodeExistsDelegateTask(String name,
String description,
String workspaceName,
String pathToCheck,
Task ifTrue,
Task ifFalse) |
NodeExistsDelegateTask(String name,
String pathToCheck,
Task ifTrue) |
NodeExistsDelegateTask(String name,
String pathToCheck,
Task ifTrue,
Task ifFalse) |
PathExistenceDelegateTask(String taskName,
String taskDescription,
String[] pathsToCheckForNonExistence,
String[] pathsToCheckForExistence,
Task ifTrue) |
PathExistenceDelegateTask(String taskName,
String taskDescription,
String repository,
String[] pathsToCheckForNonExistence,
String[] pathsToCheckForExistence,
Task ifTrue) |
PropertyExistsDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String parentPath,
String propertyName,
Task ifTrue) |
PropertyExistsDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String parentPath,
String propertyName,
Task ifTrue,
Task ifFalse) |
PropertyExistsDelegateTask(String taskName,
String parentPath,
String propertyName,
Task ifTrue) |
PropertyExistsDelegateTask(String taskName,
String parentPath,
String propertyName,
Task ifTrue,
Task ifFalse) |
PropertyValueDelegateTask(String taskName,
String parentPath,
String propertyName,
String expectedValue,
boolean propertyMustExist,
Task ifTrue) |
PropertyValueDelegateTask(String taskName,
String parentPath,
String propertyName,
String expectedValue,
boolean propertyMustExist,
Task ifTrue,
Task ifFalse) |
PropertyValueDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String nodePath,
String propertyName,
String expectedValue,
boolean propertyMustExist,
Task ifTrue) |
PropertyValueDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String nodePath,
String propertyName,
String expectedValue,
boolean propertyMustExist,
Task ifTrue,
Task ifFalse) |
ValueOfPropertyDelegateTask(String taskName,
String parentPath,
String propertyName,
String expectedValue,
boolean propertyMustExist,
Task ifTrue) |
ValueOfPropertyDelegateTask(String taskName,
String parentPath,
String propertyName,
String expectedValue,
boolean propertyMustExist,
Task ifTrue,
Task ifFalse) |
ValueOfPropertyDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String nodePath,
String propertyName,
String expectedValue,
boolean propertyMustExist,
Task ifTrue) |
ValueOfPropertyDelegateTask(String taskName,
String taskDescription,
String workspaceName,
String nodePath,
String propertyName,
String expectedValue,
boolean propertyMustExist,
Task ifTrue,
Task ifFalse) |
Modifier and Type | Class and Description |
---|---|
class |
WebappBootstrap
A Task used by the webapp module's version handler to bootstrap files under WEB-INF/bootstrap
(i.e directories defined by the magnolia.bootstrap.dir property)
TODO : exception handling...
|
Modifier and Type | Method and Description |
---|---|
List<Task> |
WebappDelta.getTasks() |
Modifier and Type | Class and Description |
---|---|
class |
InstallRendererContextAttributeTask
Task for installing context attributes to renderers.
|
class |
MigrateRenderingListenersTask
Migrates configuration under modules/rendering/renderers/listeners/ to server/rendering/engine/listeners/.
|
Modifier and Type | Class and Description |
---|---|
class |
ChangeNodeTypeOfSubAppsTask
Task will find all subApps which are primary node type mgnl:content and will change it to mgnl:contentNode.
|
class |
HashUsersPasswords
Task to encrypt base64 encoded passwords.
|
Modifier and Type | Method and Description |
---|---|
protected Task |
CoreModuleVersionHandler.updateSecurityBaseRolePermissions() |
Modifier and Type | Method and Description |
---|---|
protected List<Task> |
CoreModuleVersionHandler.getBasicInstallTasks(InstallContext ctx) |
Modifier and Type | Class and Description |
---|---|
class |
RenameACLNodesTask
Renames ACL nodes for all roles from the old format of acl_repositoryName_workspaceName to acl_workspaceName.
|
class |
UpdateSecurityFilterClientCallbacksConfiguration
Updates the given security filter's client callback configuration to reflect the changes introduced in 4.5.
|
class |
UpdateUserManagers
Updates user managers with properties used in account lockout feature.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractNodeTypeRegistrationTask
Task allowing to register or un-register nodeTypes.
|
class |
CheckOrCreateLastActivatedPropertyTask
This task checks whether the node specified by
workspace and path constructor parameters has the mgnl:lastActivated property set,
and if not, sets it to the current date &time (by calling NodeTypes.Activatable#update(Node, String, boolean) . |
class |
ConvertMetaDataUpdateTask
Update task for migration content with MetaData sub nodes to instead use mixins on the content node itself.
|
class |
Register50NodeTypeTask
Register the new M5.0 nodeType definition.
|
class |
RemoveMetaDataInNodeTypeDefinitionTask
Remove metaData nodeType's defined as 'childNodeDefinition' for all registered nodeType that still define this dependency.
Create a list of registered nodeTypes that have metaData nodeType as 'childNodeDefinition'. This list is then return by AbstractNodeTypeRegistrationTask.getNodeTypesToRegister(NodeTypeManager) and handled as an update of nodeType. |
Modifier and Type | Class and Description |
---|---|
class |
AddActivatableMixinForContentNodeTask
Add the mixIn
NodeTypes.Activatable.NAME to the NodeTypes.ContentNode node type definition. |
class |
GrantReadPermissionToRolesTask
Add a read permission to role itself if not already defined.
|
class |
IdentifySameNameSiblingNodesTask
Identify all sibling nodes for a defined workspace, sub path and nodeTypes.
If the nodesTypes is empty or null, search all 'nt:base' nodes. |
class |
RemoveOpenWFEPermissionsTask
Task that will find all openWFE permissions from the userroles workspace and remove them.
|
class |
RenameSameNameSiblingNodesTask
Identify all sibling nodes for a defined workspace, sub path and nodeTypes.
If the nodesTypes is empty or null, search all 'nt:base' nodes. |
Modifier and Type | Class and Description |
---|---|
class |
AddFilterBypassTask
Adds bypass to an existing filter.
|
class |
AddURIPermissionsToAllRoles
Adds URI permissions to all roles.
|
class |
LoginAuthTypePropertyMovedToFilter
Updates authentication type configuration.
|
class |
LoginFormPropertyMovedToFilter
Updates login form location.
|
class |
UpdateURI2RepositoryMappings
Updates format of URI2Repository mappings to format used since 3.5.
|
class |
UpdateURIMappings
Updates virtualURIMappings to the format suitable for c2b.
|
class |
WarnIgnoredModuleFilters
Checks if installed modules contain filter definitions and if so warns on installation with an appropriate message.
|
Modifier and Type | Method and Description |
---|---|
static List<Task> |
GenericTasks.genericTasksForNewInstallation() |
Modifier and Type | Method and Description |
---|---|
protected List<Task> |
TemplatingModuleVersionHandler.getExtraInstallTasks(InstallContext installContext) |
Copyright © 2003–2015 Magnolia International Ltd.. All rights reserved.