PLUGINAPI-42 Create new custom types for http request and response

Author: ericg138

plugin-api/build.gradle

@@ -12,7 +12,8 @@ dependencies {
   implementation project(':check-api')
 
   compileOnly libs.jsr305
-  compileOnly libs.servlet.api
+  compileOnly libs.javax.servlet.api
+  compileOnly libs.jakarta.servlet.api
 
   testImplementation libs.junit4
   testImplementation libs.junit5

plugin-api/src/main/java/org/sonar/api/server/http/HttpRequest.java

@@ -0,0 +1,101 @@
+/*
+ * Sonar Plugin API
+ * Copyright (C) 2009-2023 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program 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.
+ *
+ * This program 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.api.server.http;
+
+import java.util.Enumeration;
+
+/**
+ * Framework-agnostic definition of an HTTP request.
+ *
+ * @since 9.16
+ */
+public interface HttpRequest {
+
+
+  /**
+   * Returns the port number to which the request was sent.
+   */
+  int getServerPort();
+
+  /**
+   * Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
+   */
+  boolean isSecure();
+
+  /**
+   * Returns the name of the scheme used to make this request, for example, http, https, or ftp.
+   */
+  String getScheme();
+
+  /**
+   * Returns the host name of the server to which the request was sent.
+   */
+  String getServerName();
+
+  /**
+   * Returns the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path,
+   * but it does not include query string parameters.
+   */
+  String getRequestURL();
+
+  /**
+   * Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
+   */
+  String getRequestURI();
+
+  /**
+   * Returns the query string that is contained in the request URL after the path. This method returns null if the URL does not have a
+   * query string.
+   */
+  String getQueryString();
+
+  /**
+   * Returns the value of a request parameter as a String, or null if the parameter does not exist.
+   * You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value,
+   * use {@link #getParameterValues}.
+   */
+  String getParameter(String name);
+
+  /**
+   * Returns an array containing all of the values the given request parameter has, or null if the parameter does not exist.
+   */
+  String[] getParameterValues(String name);
+
+  /**
+   * Returns the value of the specified request header as a String. If the request did not include a header of the specified name, this
+   * method returns null. If there are multiple headers with the same name, this method returns the first head in the request.
+   */
+  String getHeader(String name);
+
+  /**
+   * Returns all the values of the specified request header as an Enumeration of String objects.
+   */
+  Enumeration<String> getHeaders(String name);
+
+  /**
+   * Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
+   */
+  String getMethod();
+
+  /**
+   * Returns the raw request object from the Servlet API that matches this request.
+   */
+  Object getRawRequest();
+}

plugin-api/src/main/java/org/sonar/api/server/http/HttpResponse.java

@@ -0,0 +1,68 @@
+/*
+ * Sonar Plugin API
+ * Copyright (C) 2009-2023 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program 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.
+ *
+ * This program 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.api.server.http;
+
+import java.io.IOException;
+import java.util.Collection;
+
+/**
+ * Framework-agnostic definition of an HTTP response.
+ *
+ * @since 9.16
+ */
+public interface HttpResponse {
+
+  /**
+   * Adds a response header with the given name and value. This method allows response headers to have multiple values.
+   */
+  void addHeader(String name, String value);
+
+  /**
+   * Gets the value of the response header with the given name.
+   * If a response header with the given name exists and contains multiple values, the value that was added first will be returned.
+   */
+  String getHeader(String name);
+
+  /**
+   * Gets the values of the response header with the given name.
+   */
+  Collection<String> getHeaders(String name);
+
+  /**
+   * Sets the status code for this response.
+   */
+  void setStatus(int sc);
+
+  /**
+   * Gets the current status code of this response.
+   */
+  int getStatus();
+
+  /**
+   * Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer.
+   * The buffer will be replaced with the data set by this method.
+   */
+  void sendRedirect(String location) throws IOException;
+
+  /**
+   * Returns the raw response object from the Servlet API that matches this response.
+   */
+  Object getRawResponse();
+}

plugin-api/src/main/java/org/sonar/api/server/http/JakartaHttpRequest.java

@@ -0,0 +1,100 @@
+/*
+ * Sonar Plugin API
+ * Copyright (C) 2009-2023 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program 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.
+ *
+ * This program 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.api.server.http;
+
+import jakarta.servlet.http.HttpServletRequest;
+import java.util.Enumeration;
+
+/**
+ * Implementation of {@link HttpRequest} based on a delegate of {@link HttpServletRequest} from the Jakarta Servlet API.
+ */
+public class JakartaHttpRequest implements HttpRequest {
+
+  private final HttpServletRequest delegate;
+
+  public JakartaHttpRequest(HttpServletRequest delegate) {
+    this.delegate = delegate;
+  }
+
+  @Override
+  public int getServerPort() {
+    return delegate.getServerPort();
+  }
+
+  @Override
+  public boolean isSecure() {
+    return delegate.isSecure();
+  }
+
+  @Override
+  public String getScheme() {
+    return delegate.getScheme();
+  }
+
+  @Override
+  public String getServerName() {
+    return delegate.getServerName();
+  }
+
+  @Override
+  public String getRequestURL() {
+    return delegate.getRequestURL().toString();
+  }
+
+  @Override
+  public String getRequestURI() {
+    return delegate.getRequestURI();
+  }
+
+  @Override
+  public String getQueryString() {
+    return delegate.getQueryString();
+  }
+
+  @Override
+  public String getParameter(String name) {
+    return delegate.getParameter(name);
+  }
+
+  @Override
+  public String[] getParameterValues(String name) {
+    return delegate.getParameterValues(name);
+  }
+
+  @Override
+  public String getHeader(String name) {
+    return delegate.getHeader(name);
+  }
+
+  @Override
+  public Enumeration<String> getHeaders(String name) {
+    return delegate.getHeaders(name);
+  }
+
+  @Override
+  public String getMethod() {
+    return delegate.getMethod();
+  }
+
+  @Override
+  public HttpServletRequest getRawRequest() {
+    return delegate;
+  }
+}

plugin-api/src/main/java/org/sonar/api/server/http/JakartaHttpResponse.java

@@ -0,0 +1,71 @@
+/*
+ * Sonar Plugin API
+ * Copyright (C) 2009-2023 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program 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.
+ *
+ * This program 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.api.server.http;
+
+import jakarta.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import java.util.Collection;
+
+/**
+ * Implementation of {@link HttpResponse} based on a delegate of {@link HttpServletResponse} from the Jakarta Servlet API.
+ */
+public class JakartaHttpResponse implements HttpResponse {
+
+  private final HttpServletResponse delegate;
+
+  public JakartaHttpResponse(HttpServletResponse delegate) {
+    this.delegate = delegate;
+  }
+
+  @Override
+  public void addHeader(String name, String value) {
+    delegate.addHeader(name, value);
+  }
+
+  @Override
+  public String getHeader(String name) {
+    return delegate.getHeader(name);
+  }
+
+  @Override
+  public Collection<String> getHeaders(String name) {
+    return delegate.getHeaders(name);
+  }
+
+  @Override
+  public void setStatus(int sc) {
+    delegate.setStatus(sc);
+  }
+
+  @Override
+  public int getStatus() {
+    return delegate.getStatus();
+  }
+
+  @Override
+  public void sendRedirect(String location) throws IOException {
+    delegate.sendRedirect(location);
+  }
+
+  @Override
+  public HttpServletResponse getRawResponse() {
+    return delegate;
+  }
+}