1 /**
2 * This file Copyright (c) 2019 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.contentapp.action;
35
36 import info.magnolia.context.Context;
37
38 import java.util.HashMap;
39 import java.util.Map;
40
41 import javax.jcr.Item;
42 import javax.jcr.Node;
43
44 import com.machinezoo.noexception.Exceptions;
45
46 /**
47 * Resolves JCR command params.
48 */
49 public interface JcrCommandParamsResolver {
50
51 /**
52 * Builds a map of parameters which will be passed to the current command
53 * for execution. Default implementation returns
54 * a map containing the parameters defined at
55 * {@link info.magnolia.ui.api.action.CommandActionDefinition#getParams()}. It also adds the following
56 * parameters with values retrieved from the passed item.
57 * <ul>
58 * <li>Context.ATTRIBUTE_REPOSITORY = current item's workspace name
59 * <li>Context.ATTRIBUTE_UUID = current item's identifier
60 * <li>Context.ATTRIBUTE_PATH = current item's path
61 * </ul>
62 */
63 default Map<String, Object> resolveJcrParams(Item item) {
64 return Exceptions.wrap().get(() -> {
65 final String path = item.getPath();
66 final String workspace = item.getSession().getWorkspace().getName();
67 final String identifier = (item.isNode() ? ((Node) item) : item.getParent()).getIdentifier();
68
69 Map<String, Object> params = new HashMap<>();
70 params.put(Context.ATTRIBUTE_REPOSITORY, workspace);
71 // really only the identifier should be used to identify a piece of content and nothing else
72 params.put(Context.ATTRIBUTE_UUID, identifier);
73 params.put(Context.ATTRIBUTE_PATH, path);
74 return params;
75 });
76 }
77
78 }