1 /**
2 * This file Copyright (c) 2007-2013 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.workflow.setup;
35
36 import info.magnolia.cms.core.Content;
37 import info.magnolia.cms.core.ItemType;
38 import info.magnolia.cms.util.ClasspathResourcesUtil;
39 import info.magnolia.cms.util.ContentUtil;
40 import info.magnolia.module.InstallContext;
41 import info.magnolia.module.delta.AbstractTask;
42 import info.magnolia.module.delta.TaskExecutionException;
43 import info.magnolia.module.workflow.WorkflowConstants;
44 import org.apache.commons.io.IOUtils;
45
46 import javax.jcr.RepositoryException;
47 import java.io.IOException;
48 import java.io.InputStream;
49
50 /**
51 * Sets up a workflow definition. Does not use the FlowDefinitionManager because tasks are not
52 * supposed to save their changes to the repositories.
53 *
54 * @author gjoseph
55 * @version $Revision: $ ($Author: $)
56 */
57 public class InstallWorkflowDefinitionTask extends AbstractTask {
58 private final String flowName;
59 private final String resourcePath;
60
61 public InstallWorkflowDefinitionTask(String taskName, String taskDescription, String flowName, String resourcePath) {
62 super(taskName, taskDescription);
63 this.flowName = flowName;
64 this.resourcePath = resourcePath;
65 }
66
67 @Override
68 public void execute(InstallContext ctx) throws TaskExecutionException {
69 InputStream stream = null;
70 try {
71 stream = ClasspathResourcesUtil.getStream(resourcePath);
72 final String wfDef = IOUtils.toString(stream);
73
74 // need to explicitely use the wf module node, or wf would need to be observer/register for all modules.
75 final Content wfModuleNode = ctx.getModulesNode().getChildByName("workflow");
76 final Content cfg = ContentUtil.getOrCreateContent(wfModuleNode, "config", ItemType.CONTENT);
77
78 final Content flows = ContentUtil.getOrCreateContent(cfg, "flows", ItemType.CONTENT);
79 final Content flowNode = ContentUtil.getOrCreateContent(flows, flowName, ItemType.CONTENTNODE);
80 flowNode.createNodeData(WorkflowConstants.FLOW_VALUE, wfDef);
81 } catch (IOException e) {
82 ctx.error("Could not read default activation workflow definition", e);
83 } catch (RepositoryException e) {
84 ctx.error("Could not store default activation workflow definition", e);
85 } finally {
86 if (stream != null) {
87 try {
88 stream.close();
89 } catch (IOException e) {
90 }
91 }
92 }
93 }
94 }