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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 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.elasticsearch.common.collect.Lists;
import org.picocontainer.Startable;
import org.slf4j.LoggerFactory;
import org.sonar.api.ServerComponent;
import org.sonar.api.i18n.I18n;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.server.ws.internal.ValidatingRequest;
import org.sonar.api.utils.text.JsonWriter;
import org.sonar.server.exceptions.BadRequestException;
import org.sonar.server.exceptions.BadRequestException.Message;
import org.sonar.server.exceptions.ServerException;
import org.sonar.server.plugins.MimeTypes;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import javax.servlet.http.HttpServletResponse;
import java.io.OutputStreamWriter;
import java.util.Collection;
import java.util.List;
import java.util.Locale;
/**
* @since 4.2
*/
public class WebServiceEngine implements ServerComponent, Startable {
private final WebService.Context context;
private final I18n i18n;
public WebServiceEngine(WebService[] webServices, I18n i18n) {
context = new WebService.Context();
for (WebService webService : webServices) {
webService.define(context);
}
this.i18n = i18n;
}
@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(ValidatingRequest request, ServletResponse response,
String controllerPath, String actionKey) {
try {
WebService.Action action = getAction(controllerPath, actionKey);
request.setAction(action);
verifyRequest(action, request);
action.handler().handle(request, response);
} catch (IllegalArgumentException e) {
// TODO replace by BadRequestException in Request#mandatoryParam()
sendError(400, e.getMessage(), response);
} catch (BadRequestException e) {
sendError(e, response);
} catch (ServerException e) {
sendError(e.httpCode(), message(e.getMessage(), e.l10nKey(), e.l10nParams()), response);
} catch (Exception e) {
// TODO implement Request.toString()
LoggerFactory.getLogger(getClass()).error("Fail to process request " + request, e);
sendError(500, e.getMessage(), response);
}
}
private WebService.Action getAction(String controllerPath, String actionKey) {
WebService.Controller controller = context.controller(controllerPath);
if (controller == null) {
throw new BadRequestException(String.format("Unknown web service: %s", controllerPath));
}
WebService.Action action = controller.action(actionKey);
if (action == null) {
throw new BadRequestException(String.format("Unknown action: %s/%s", controllerPath, actionKey));
}
return action;
}
private void verifyRequest(WebService.Action action, Request request) {
// verify the HTTP verb
if (action.isPost() && !"POST".equals(request.method())) {
throw new ServerException(HttpServletResponse.SC_METHOD_NOT_ALLOWED, "HTTP method POST is required");
}
}
private void sendError(BadRequestException e, ServletResponse response) {
Collection<String> messages = Lists.newArrayList();
String exceptionMessage = message(e.getMessage(), e.l10nKey(), e.l10nParams());
if (exceptionMessage != null) {
messages.add(exceptionMessage);
}
for (Message message : e.errors()) {
messages.add(message(message.text(), message.l10nKey(), message.l10nParams()));
}
sendErrors(response, e.httpCode(), messages.toArray(new String[messages.size()]));
}
@CheckForNull
private String message(@Nullable String message, @Nullable String l10nKey, Object... l10nParams) {
if (l10nKey != null) {
return i18n.message(Locale.getDefault(), l10nKey, message, l10nParams);
} else {
return message;
}
}
private void sendError(int status, @Nullable String message, ServletResponse response) {
sendErrors(response, status, message);
}
private void sendErrors(ServletResponse response, int status, String... errors) {
ServletResponse.ServletStream stream = response.stream();
stream.reset();
stream.setStatus(status);
stream.setMediaType(MimeTypes.JSON);
JsonWriter json = JsonWriter.of(new OutputStreamWriter(stream.output()));
try {
json.beginObject();
json.name("errors").beginArray();
for (String message : errors) {
json.beginObject().prop("msg", message).endObject();
}
json.endArray();
json.endObject();
} finally {
// TODO if close() fails, the runtime exception should not hide the
// potential exception raised in the try block.
json.close();
}
}
}
|
