1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2013 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* SonarQube is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.server.ws;
import org.picocontainer.Startable;
import org.sonar.api.ServerComponent;
import org.sonar.api.utils.text.JsonWriter;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import javax.servlet.http.HttpServletResponse;
import java.util.List;
/**
* @since 4.2
*/
public class WebServiceEngine implements ServerComponent, Startable {
static class RequestException extends Exception {
private final int httpStatus;
RequestException(int httpStatus, String message) {
super(message);
this.httpStatus = httpStatus;
}
}
private final WebService.Context context;
public WebServiceEngine(WebService[] webServices) {
context = new WebService.Context();
for (WebService webService : webServices) {
webService.define(context);
}
}
public WebServiceEngine() {
this(new WebService[0]);
}
@Override
public void start() {
// Force execution of constructor to be sure that web services
// are validated and initialized at server startup.
}
@Override
public void stop() {
// nothing
}
/**
* Used by Ruby on Rails to add ws routes. See WEB_INF/lib/java_ws_routing.rb
*/
public List<WebService.Controller> controllers() {
return context.controllers();
}
public void execute(Request request, Response response,
String controllerPath, String actionKey) {
try {
WebService.Action action = getAction(controllerPath, actionKey);
verifyRequest(action, request);
action.handler().handle(request, response);
} catch (RequestException e) {
sendError(e.httpStatus, e.getMessage(), response);
} catch (Exception e) {
// TODO support authentication exceptions and others...
sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage(), response);
}
}
private WebService.Action getAction(String controllerPath, String actionKey) throws RequestException {
WebService.Controller controller = context.controller(controllerPath);
if (controller == null) {
throw new RequestException(HttpServletResponse.SC_BAD_REQUEST, String.format("Unknown web service: %s", controllerPath));
}
WebService.Action action = controller.action(actionKey);
if (action == null) {
throw new RequestException(HttpServletResponse.SC_BAD_REQUEST, String.format("Unknown action: %s/%s", controllerPath, actionKey));
}
return action;
}
private void verifyRequest(WebService.Action action, Request request) throws RequestException {
if (request.isPost() != action.isPost()) {
throw new RequestException(HttpServletResponse.SC_METHOD_NOT_ALLOWED, "Method POST is required");
}
// TODO verify required parameters
}
private void sendError(int status, String message, Response response) {
response.setStatus(status);
JsonWriter json = response.newJsonWriter();
json.beginObject();
json.name("errors").beginArray();
json.beginObject().prop("msg", message).endObject();
json.endArray();
json.endObject();
json.close();
}
}
|
