View Javadoc
1   /**
2    * This file Copyright (c) 2015-2018 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.ui.framework.action;
35  
36  import info.magnolia.commands.CommandsManager;
37  import info.magnolia.commands.ExportJcrNodeToYamlCommand;
38  import info.magnolia.i18nsystem.SimpleTranslator;
39  import info.magnolia.ui.api.action.ActionExecutionException;
40  import info.magnolia.ui.api.context.UiContext;
41  import info.magnolia.ui.framework.util.TempFileStreamResource;
42  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
43  
44  import java.io.IOException;
45  import java.util.Map;
46  
47  import javax.inject.Inject;
48  import javax.jcr.Item;
49  
50  import com.vaadin.server.Page;
51  
52  /**
53   * Action for exporting a node to YAML format. Uses the {@link ExportJcrNodeToYamlCommand} to perform the export operation.
54   * Then sends the result to the client browser.
55   *
56   * @see ExportYamlActionDefinition
57   */
58  public class ExportYamlAction extends AbstractCommandAction<ExportYamlActionDefinition> {
59  
60      private static final String YAML_EXTENSION = ".yaml";
61  
62      private TempFileStreamResource tempFileStreamResource;
63  
64      @Inject
65      public ExportYamlAction(ExportYamlActionDefinition definition, JcrItemAdapter item, CommandsManager commandsManager, UiContext uiContext, SimpleTranslator i18n) throws ActionExecutionException {
66          super(definition, item, commandsManager, uiContext, i18n);
67      }
68  
69      @Override
70      protected void onPreExecute() throws Exception {
71          tempFileStreamResource = new TempFileStreamResource();
72          tempFileStreamResource.setTempFileExtension(YAML_EXTENSION);
73          tempFileStreamResource.setTempFileName(getCurrentItem().getItemId().getUuid());
74  
75          super.onPreExecute();
76      }
77  
78      @Override
79      protected void onPostExecute() throws Exception {
80          final ExportJcrNodeToYamlCommand exportYamlCommand = (ExportJcrNodeToYamlCommand) getCommand();
81          tempFileStreamResource.setFilename(exportYamlCommand.getFileName());
82          tempFileStreamResource.setMIMEType("application/yaml");
83          // Opens the resource for download
84          Page.getCurrent().open(tempFileStreamResource, "", true);
85      }
86  
87      @Override
88      protected Map<String, Object> buildParams(Item jcrItem) {
89          Map<String, Object> params = super.buildParams(jcrItem);
90          try {
91              params.put(ExportJcrNodeToYamlCommand.EXPORT_OUTPUT_STREAM, tempFileStreamResource.getTempFileOutputStream());
92          } catch (IOException e) {
93              throw new IllegalStateException("Failed to bind command to temp file output stream: ", e);
94          }
95          return params;
96      }
97  }