View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.admininterface.setup;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.cms.core.ItemType;
38  import info.magnolia.cms.util.ContentUtil;
39  import info.magnolia.cms.util.NodeDataUtil;
40  import info.magnolia.module.InstallContext;
41  import info.magnolia.module.delta.AbstractTask;
42  import info.magnolia.module.delta.TaskExecutionException;
43  
44  import javax.jcr.RepositoryException;
45  
46  /**
47   *
48   * @author gjoseph
49   * @version $Revision: $ ($Author: $)
50   */
51  public class AddMainMenuItemTask extends AbstractTask {
52      private final String menuName;
53      private final String label;
54      private final String i18nBasename;
55      private final String onClick;
56      private final String icon;
57      private final String orderBefore;
58  
59      /**
60       * @param orderBefore the menu name before which this new menu should be positioned. ignored if null.
61       * @param i18nBasename ignored if null.
62       */
63      public AddMainMenuItemTask(String menuName, String label, String i18nBasename, String onClick, String icon, String orderBefore) {
64          super("Menu", "Adds or updates an item in the admin interface menu for " + menuName);
65          this.menuName = menuName;
66          this.label = label;
67          this.i18nBasename = i18nBasename;
68          this.onClick = onClick;
69          this.icon = icon;
70          this.orderBefore = orderBefore;
71      }
72  
73      public void execute(InstallContext ctx) throws TaskExecutionException {
74          try {
75              final Content parent = getParentNode(ctx);
76              final Content menu = ContentUtil.getOrCreateContent(parent, menuName, ItemType.CONTENTNODE);
77              NodeDataUtil.getOrCreateAndSet(menu, "icon", icon);
78              NodeDataUtil.getOrCreateAndSet(menu, "onclick", onClick);
79              NodeDataUtil.getOrCreateAndSet(menu, "label", label);
80              if (i18nBasename != null) {
81                  NodeDataUtil.getOrCreateAndSet(menu, "i18nBasename", i18nBasename);
82              }
83  
84              if (orderBefore != null){
85                  parent.orderBefore(menuName, orderBefore);
86              }
87          } catch (RepositoryException e) {
88              throw new TaskExecutionException("Could not create or place " + menuName + " menu item.", e);
89          }
90      }
91  
92      protected Content getParentNode(InstallContext ctx) throws RepositoryException {
93          return ctx.getConfigHierarchyManager().getContent("/modules/adminInterface/config/menu");
94      }
95  }