rspec/rules/S6398/java/rule.adoc

include::../description.adoc[]


== Noncompliant Code Example

[source,java]
----
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  String json = "{\"key\":\""+req.getParameter("value")+"\"}";
  FileOutputStream fos = new FileOutputStream("output.json");
  fos.write(json.getBytes(Charset.forName("UTF-8")));  // Noncompliant
}
----

https://github.com/google/gson[google/gson]
[source,java]
----
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  Gson gson = new Gson();
  String json = "{\"key\":\""+req.getParameter("value")+"\"}";
  Object object = gson.fromJson(json, Object.class); // Noncompliant
}
----

https://github.com/FasterXML/jackson[FasterXML/jackson]
[source,java]
----
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  ObjectMapper mapper = new ObjectMapper();
  JsonFactory jsonFactory = mapper.getFactory();
  JsonGenerator generator = jsonFactory.createGenerator(System.out);

  String json = "{\"key\":\""+req.getParameter("value")+"\"}";
  generator.writeRaw(json); // Noncompliant
  generator.close();
}
----

https://github.com/stleary/JSON-java[stleary/JSON-java] (org.json)
[source,java]
----
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  String json = "{\"key\":\""+req.getParameter("value")+"\"}";
  JSONObject jo = new JSONObject(json); // Noncompliant
}
----

== Compliant Solution

[source,java]
----
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  String value = req.getParameter("value");
  if(value.matches("^[A-Za-z0-9_]+$")) {
    String json = "{\"key\":\""+value+"\"}";
    FileOutputStream fos = new FileOutputStream("output.json");
    fos.write(json.getBytes(Charset.forName("UTF-8")));
  }
}
----

https://github.com/google/gson[google/gson]
[source,java]
----
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  Gson gson = new Gson();
  JsonObject json = new JsonObject();
  json.addProperty("key", req.getParameter("value"));
  Object object = gson.fromJson(json, Object.class);
}
----

https://github.com/FasterXML/jackson[FasterXML/jackson]
[source,java]
----
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  ObjectMapper mapper = new ObjectMapper();
  JsonFactory jsonFactory = mapper.getFactory();
  JsonGenerator generator = jsonFactory.createGenerator(System.out);

  generator.writeStartObject();
  enerator.writeFieldName("key");
  generator.writeString(req.getParameter("value"));
  generator.close();
}
----

https://github.com/stleary/JSON-java[stleary/JSON-java] (org.json)
[source,java]
----
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  JSONObject jo = new JSONObject();
  jo.append("key", req.getParameter("value"));
}
----

include::../see.adoc[]

ifdef::env-github,rspecator-view[]
== Implementation Specification
(visible only on this page)

include::../message.adoc[]

endif::env-github,rspecator-view[]