Clover icon

Magnolia REST Services 1.1

  1. Project Clover database Thu Aug 13 2015 19:10:59 CEST
  2. Package info.magnolia.rest.service.command.v1

File CommandEndpoint.java

 

Coverage histogram

../../../../../../img/srcFileCovDistChart8.png
80% of files have more coverage

Code metrics

4
14
3
1
130
74
6
0.43
4.67
3
2

Classes

Class Line # Actions
CommandEndpoint 70 14 0% 6 4
0.809523881%
 

Contributing tests

This file is covered by 8 tests. .

Source view

1    /**
2    * This file Copyright (c) 2013-2015 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.rest.service.command.v1;
35   
36    import info.magnolia.commands.CommandsManager;
37    import info.magnolia.commands.chain.Command;
38    import info.magnolia.rest.service.command.AbstractCommandEndpoint;
39    import info.magnolia.rest.service.command.definition.CommandEndpointDefinition;
40   
41    import java.util.Map;
42   
43    import javax.inject.Inject;
44    import javax.jcr.RepositoryException;
45    import javax.ws.rs.Consumes;
46    import javax.ws.rs.POST;
47    import javax.ws.rs.Path;
48    import javax.ws.rs.PathParam;
49    import javax.ws.rs.core.MediaType;
50    import javax.ws.rs.core.Response;
51   
52    import org.slf4j.Logger;
53    import org.slf4j.LoggerFactory;
54   
55    import com.wordnik.swagger.annotations.Api;
56    import com.wordnik.swagger.annotations.ApiOperation;
57    import com.wordnik.swagger.annotations.ApiResponse;
58    import com.wordnik.swagger.annotations.ApiResponses;
59   
60    /**
61    * REST service for executing commands.
62    *
63    * Executable commands have to be white listed by adding them to the configuration.
64    *
65    * @deprecated since 1.1 use {@link info.magnolia.rest.service.command.v2.CommandEndpoint} instead.
66    */
67    @Api(value = "/commands/v1", description = "The commands API")
68    @Path("/commands/v1")
69    @Deprecated
 
70    public class CommandEndpoint extends AbstractCommandEndpoint<CommandEndpointDefinition> {
71   
72    private final Logger log = LoggerFactory.getLogger(getClass());
73   
 
74  8 toggle @Inject
75    public CommandEndpoint(final CommandEndpointDefinition commandEndpointDefinition, final CommandsManager commandsManager) {
76  8 super(commandEndpointDefinition, commandsManager);
77    }
78   
 
79  3 toggle @POST
80    @Path("/{catalogName}/{commandName:(.)*}")
81    @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
82    @ApiOperation(value = "Executes a command", notes = "Executes a command from a specific catalog")
83    @ApiResponses(value = {
84    @ApiResponse(code = 200, message = STATUS_MESSAGE_OK),
85    @ApiResponse(code = 403, message = STATUS_MESSAGE_FORBIDDEN),
86    @ApiResponse(code = 404, message = STATUS_MESSAGE_COMMAND_NOT_FOUND),
87    @ApiResponse(code = 500, message = STATUS_MESSAGE_ERROR_OCCURRED)
88    })
89    public Response executeCommand(
90    @PathParam("catalogName") String catalogName,
91    @PathParam("commandName") String commandName,
92    Map<String, Object> commandMap) throws RepositoryException {
93   
94  3 boolean commandResult;
95   
96  3 if (!isCommandExecutableByCurrentUser(catalogName, commandName)) {
97  1 log.error("Unauthorized access while executing command '{}' from catalog '{}' with commandMap '{}'", commandName, catalogName, commandMap);
98  1 return Response.status(Response.Status.FORBIDDEN).build();
99    }
100   
101  2 Command command = commandsManager.getCommand(catalogName, commandName);
102   
103  2 if (command == null) {
104  0 return Response.status(Response.Status.NOT_FOUND).build();
105    }
106   
107  2 try {
108  2 commandResult = commandsManager.executeCommand(command, commandMap);
109    } catch (Exception e) {
110  1 log.error("Error executing command '{}' from catalog '{}' with commandMap '{}'", commandName, catalogName, commandMap, e);
111  1 return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(e.getMessage()).type(MediaType.TEXT_PLAIN_TYPE).build();
112    }
113   
114  1 return Response.status(Response.Status.OK).entity(!commandResult).type(MediaType.TEXT_PLAIN_TYPE).build();
115    }
116   
 
117  0 toggle @POST
118    @Path("/{commandName:(.)*}")
119    @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
120    @ApiOperation(value = "Executes a command", notes = "Executes a command from the default catalog")
121    @ApiResponses(value = {
122    @ApiResponse(code = 200, message = STATUS_MESSAGE_OK),
123    @ApiResponse(code = 403, message = STATUS_MESSAGE_FORBIDDEN),
124    @ApiResponse(code = 404, message = STATUS_MESSAGE_COMMAND_NOT_FOUND),
125    @ApiResponse(code = 500, message = STATUS_MESSAGE_ERROR_OCCURRED)
126    })
127    public Response executeCommand(@PathParam("commandName") String commandName, Map<String, Object> commandMap) throws RepositoryException {
128  0 return executeCommand(null, commandName, commandMap);
129    }
130    }
  • Report generated by Atlassian Clover v 4.0.4 on Thu Aug 13 2015 19:11:34 CEST using coverage data from Thu Aug 13 2015 19:11:14 CEST.
  • Clover: Open Source License registered to Magnolia CMS.