1 /**
2 * This file Copyright (c) 2013-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.api.action;
35
36 import info.magnolia.objectfactory.ComponentProvider;
37 import info.magnolia.objectfactory.MgnlInstantiationException;
38
39 import javax.inject.Inject;
40
41 /**
42 * Abstract base implementation of {@link ActionExecutor}. Creates the {@link Action} from the implementation class
43 * using a {@link ComponentProvider} and binds the ActionDefinition to the Action. Subclasses need only implement {@link #getActionDefinition(String)}.
44 *
45 * @see Action
46 * @see ActionDefinition
47 * @see ActionExecutor
48 */
49 public abstract class AbstractActionExecutor implements ActionExecutor {
50
51 private ComponentProvider componentProvider;
52
53 @Inject
54 public AbstractActionExecutor(ComponentProvider componentProvider) {
55 this.componentProvider = componentProvider;
56 }
57
58 @Override
59 public final void execute(String actionName, Object... args) throws ActionExecutionException {
60 try {
61 Action action = createAction(actionName, args);
62 action.execute();
63 } catch (RuntimeException e) {
64 throw new ActionExecutionException("Action execution failed for action: " + actionName, e);
65 }
66 }
67
68 /**
69 * Creates an action using the implementation configured for the given action definition. The
70 * parameters are made available for injection when the instance is created. The definition
71 * object is also available for injection.
72 */
73 protected Action createAction(String actionName, Object... args) throws ActionExecutionException {
74
75 final ActionDefinition actionDefinition = getActionDefinition(actionName);
76 if (actionDefinition == null) {
77 throw new ActionExecutionException("No definition exists for action: " + actionName);
78 }
79
80 Class<? extends Action> implementationClass = actionDefinition.getImplementationClass();
81 if (implementationClass == null) {
82 throw new ActionExecutionException("No action class set for action: " + actionName);
83 }
84
85 Object[] combinedParameters = new Object[args.length + 1];
86 combinedParameters[0] = actionDefinition;
87 System.arraycopy(args, 0, combinedParameters, 1, args.length);
88
89 try {
90 return componentProvider.newInstance(implementationClass, combinedParameters);
91 } catch (MgnlInstantiationException e) {
92 throw new ActionExecutionException("Could not instantiate action class for action: " + actionName, e);
93 }
94 }
95 }