Skip to content

Commit 2cd1368

Browse files
sureshanapartisureshanaparti
committed
Remove duplicate configkey json.content.type
1 parent c267ad3 commit 2cd1368

2 files changed

Lines changed: 13 additions & 21 deletions

File tree

‎server/src/main/java/com/cloud/api/ApiServer.java‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -273,11 +273,11 @@ public class ApiServer extends ManagerBase implements HttpRequestHandler, ApiSer
273273
, "Do URL encoding for the api response, false by default"
274274
, false
275275
, ConfigKey.Scope.Global);
276-
static final ConfigKey<String> JSONcontentType = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED
276+
static final ConfigKey<String> JSONContentType = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED
277277
, String.class
278278
, "json.content.type"
279279
, "application/json; charset=UTF-8"
280-
, "Http response content type for .js files (default is text/javascript)"
280+
, "Http response content type for JSON"
281281
, false
282282
, ConfigKey.Scope.Global);
283283
static final ConfigKey<Boolean> EnableSecureSessionCookie = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED
@@ -287,13 +287,6 @@ public class ApiServer extends ManagerBase implements HttpRequestHandler, ApiSer
287287
, "Session cookie is marked as secure if this is enabled. Secure cookies only work when HTTPS is used."
288288
, false
289289
, ConfigKey.Scope.Global);
290-
private static final ConfigKey<String> JSONDefaultContentType = new ConfigKey<> (ConfigKey.CATEGORY_ADVANCED
291-
, String.class
292-
, "json.content.type"
293-
, "application/json; charset=UTF-8"
294-
, "Http response content type for JSON"
295-
, false
296-
, ConfigKey.Scope.Global);
297290

298291
private static final ConfigKey<Boolean> UseEventAccountInfo = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED
299292
, Boolean.class
@@ -1436,7 +1429,7 @@ private void writeResponse(final HttpResponse resp, final String responseText, f
14361429
final BasicHttpEntity body = new BasicHttpEntity();
14371430
if (HttpUtils.RESPONSE_TYPE_JSON.equalsIgnoreCase(responseType)) {
14381431
// JSON response
1439-
body.setContentType(JSONcontentType.value());
1432+
body.setContentType(JSONContentType.value());
14401433
if (responseText == null) {
14411434
body.setContent(new ByteArrayInputStream("{ \"error\" : { \"description\" : \"Internal Server Error\" } }".getBytes(HttpUtils.UTF_8)));
14421435
}
@@ -1673,7 +1666,6 @@ public ConfigKey<?>[] getConfigKeys() {
16731666
ConcurrentSnapshotsThresholdPerHost,
16741667
EncodeApiResponse,
16751668
EnableSecureSessionCookie,
1676-
JSONDefaultContentType,
16771669
proxyForwardList,
16781670
useForwardHeader,
16791671
listOfForwardHeaders,

‎server/src/main/java/com/cloud/api/ApiServlet.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ void processRequestInContext(final HttpServletRequest req, final HttpServletResp
177177
"UnknownHostException when trying to lookup remote IP-Address", null,
178178
HttpUtils.RESPONSE_TYPE_XML);
179179
HttpUtils.writeHttpResponse(resp, response, HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
180-
HttpUtils.RESPONSE_TYPE_XML, ApiServer.JSONcontentType.value());
180+
HttpUtils.RESPONSE_TYPE_XML, ApiServer.JSONContentType.value());
181181
return;
182182
}
183183

@@ -292,7 +292,7 @@ void processRequestInContext(final HttpServletRequest req, final HttpServletResp
292292
}
293293
}
294294
}
295-
HttpUtils.writeHttpResponse(resp, responseString, httpResponseCode, responseType, ApiServer.JSONcontentType.value());
295+
HttpUtils.writeHttpResponse(resp, responseString, httpResponseCode, responseType, ApiServer.JSONContentType.value());
296296
return;
297297
}
298298
} else {
@@ -350,7 +350,7 @@ void processRequestInContext(final HttpServletRequest req, final HttpServletResp
350350
setProjectContext(params);
351351
setClientAddressForConsoleEndpointAccess(command, params, req);
352352
final String response = apiServer.handleRequest(params, responseType, auditTrailSb);
353-
HttpUtils.writeHttpResponse(resp, response != null ? response : "", HttpServletResponse.SC_OK, responseType, ApiServer.JSONcontentType.value());
353+
HttpUtils.writeHttpResponse(resp, response != null ? response : "", HttpServletResponse.SC_OK, responseType, ApiServer.JSONContentType.value());
354354
} else {
355355
if (session != null) {
356356
invalidateHttpSession(session, String.format("request verification failed for %s from %s", userId, remoteAddress.getHostAddress()));
@@ -360,12 +360,12 @@ void processRequestInContext(final HttpServletRequest req, final HttpServletResp
360360
final String serializedResponse =
361361
apiServer.getSerializedApiError(HttpServletResponse.SC_UNAUTHORIZED, "unable to verify user credentials and/or request signature", params,
362362
responseType);
363-
HttpUtils.writeHttpResponse(resp, serializedResponse, HttpServletResponse.SC_UNAUTHORIZED, responseType, ApiServer.JSONcontentType.value());
363+
HttpUtils.writeHttpResponse(resp, serializedResponse, HttpServletResponse.SC_UNAUTHORIZED, responseType, ApiServer.JSONContentType.value());
364364
}
365365
} catch (final ServerApiException se) {
366366
final String serializedResponseText = apiServer.getSerializedApiError(se, params, responseType);
367367
resp.setHeader("X-Description", se.getDescription());
368-
HttpUtils.writeHttpResponse(resp, serializedResponseText, se.getErrorCode().getHttpCode(), responseType, ApiServer.JSONcontentType.value());
368+
HttpUtils.writeHttpResponse(resp, serializedResponseText, se.getErrorCode().getHttpCode(), responseType, ApiServer.JSONContentType.value());
369369
auditTrailSb.append(" " + se.getErrorCode() + " " + se.getDescription());
370370
} catch (final Exception ex) {
371371
LOGGER.error("unknown exception writing api response", ex);
@@ -452,7 +452,7 @@ protected boolean verify2FA(HttpSession session, String command, StringBuilder a
452452
if (apiAuthenticator != null) {
453453
String responseString = apiAuthenticator.authenticate(command, params, session, remoteAddress, responseType, auditTrailSb, req, resp);
454454
session.setAttribute(ApiConstants.IS_2FA_VERIFIED, true);
455-
HttpUtils.writeHttpResponse(resp, responseString, HttpServletResponse.SC_OK, responseType, ApiServer.JSONcontentType.value());
455+
HttpUtils.writeHttpResponse(resp, responseString, HttpServletResponse.SC_OK, responseType, ApiServer.JSONContentType.value());
456456
verify2FA = true;
457457
} else {
458458
LOGGER.error("Cannot find API authenticator while verifying 2FA");
@@ -484,7 +484,7 @@ protected boolean verify2FA(HttpSession session, String command, StringBuilder a
484484
invalidateHttpSession(session, String.format("Unable to process the API request for %s from %s due to %s", userId, remoteAddress.getHostAddress(), errorMsg));
485485
auditTrailSb.append(" " + ApiErrorCode.UNAUTHORIZED2FA + " " + errorMsg);
486486
final String serializedResponse = apiServer.getSerializedApiError(ApiErrorCode.UNAUTHORIZED2FA.getHttpCode(), "Unable to process the API request due to :" + errorMsg, params, responseType);
487-
HttpUtils.writeHttpResponse(resp, serializedResponse, ApiErrorCode.UNAUTHORIZED2FA.getHttpCode(), responseType, ApiServer.JSONcontentType.value());
487+
HttpUtils.writeHttpResponse(resp, serializedResponse, ApiErrorCode.UNAUTHORIZED2FA.getHttpCode(), responseType, ApiServer.JSONContentType.value());
488488
verify2FA = false;
489489
}
490490

@@ -513,7 +513,7 @@ private boolean requestChecksoutAsSane(HttpServletResponse resp, StringBuilder a
513513
LOGGER.info("missing command, ignoring request...");
514514
auditTrailSb.append(" " + HttpServletResponse.SC_BAD_REQUEST + " " + "no command specified");
515515
final String serializedResponse = apiServer.getSerializedApiError(HttpServletResponse.SC_BAD_REQUEST, "no command specified", params, responseType);
516-
HttpUtils.writeHttpResponse(resp, serializedResponse, HttpServletResponse.SC_BAD_REQUEST, responseType, ApiServer.JSONcontentType.value());
516+
HttpUtils.writeHttpResponse(resp, serializedResponse, HttpServletResponse.SC_BAD_REQUEST, responseType, ApiServer.JSONContentType.value());
517517
return true;
518518
}
519519
final User user = entityMgr.findById(User.class, userId);
@@ -524,7 +524,7 @@ private boolean requestChecksoutAsSane(HttpServletResponse resp, StringBuilder a
524524
auditTrailSb.append(" " + HttpServletResponse.SC_UNAUTHORIZED + " " + "unable to verify user credentials");
525525
final String serializedResponse =
526526
apiServer.getSerializedApiError(HttpServletResponse.SC_UNAUTHORIZED, "unable to verify user credentials", params, responseType);
527-
HttpUtils.writeHttpResponse(resp, serializedResponse, HttpServletResponse.SC_UNAUTHORIZED, responseType, ApiServer.JSONcontentType.value());
527+
HttpUtils.writeHttpResponse(resp, serializedResponse, HttpServletResponse.SC_UNAUTHORIZED, responseType, ApiServer.JSONContentType.value());
528528
return false;
529529
}
530530
return true;
@@ -539,7 +539,7 @@ private boolean invalidateHttpSessionIfNeeded(HttpServletRequest req, HttpServle
539539
auditTrailSb.append(" " + HttpServletResponse.SC_UNAUTHORIZED + " " + "unable to verify user credentials");
540540
final String serializedResponse =
541541
apiServer.getSerializedApiError(HttpServletResponse.SC_UNAUTHORIZED, "unable to verify user credentials", params, responseType);
542-
HttpUtils.writeHttpResponse(resp, serializedResponse, HttpServletResponse.SC_UNAUTHORIZED, responseType, ApiServer.JSONcontentType.value());
542+
HttpUtils.writeHttpResponse(resp, serializedResponse, HttpServletResponse.SC_UNAUTHORIZED, responseType, ApiServer.JSONContentType.value());
543543
return true;
544544
}
545545
return false;

0 commit comments

Comments
 (0)