In a servlet, calling {@link #doPost(HttpServletRequest, HttpServletResponse)} inside {@link - * javax.servlet.http.HttpServlet#doPost(HttpServletRequest, HttpServletResponse)} makes the servlet - * backed by the gRPC server associated with the adapter. The servlet must support Asynchronous - * Processing and must be deployed to a container that supports servlet 4.0 and enables HTTP/2. + *
In a servlet, calling {@link #doPost(String, HttpServletRequest, HttpServletResponse)} inside + * {@link javax.servlet.http.HttpServlet#doPost(HttpServletRequest, HttpServletResponse)} makes + * the servlet backed by the gRPC server associated with the adapter. The servlet must support + * Asynchronous Processing and must be deployed to a container that supports servlet 4.0 + * and enables HTTP/2. * *
The API is experimental. The authors would like to know more about the real usecases. Users * are welcome to provide feedback by commenting on @@ -103,6 +104,10 @@ public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOExc resp.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED, "GET method not supported"); } + public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException { + doPost(req.getRequestURI().substring(1), req, resp); + } + /** * Call this method inside {@link javax.servlet.http.HttpServlet#doPost(HttpServletRequest, * HttpServletResponse)} to serve gRPC POST request. @@ -110,7 +115,8 @@ public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOExc *
Do not modify {@code req} and {@code resp} before or after calling this method. However, * calling {@code resp.setBufferSize()} before invocation is allowed. */ - public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException { + public void doPost(String method, HttpServletRequest req, HttpServletResponse resp) + throws IOException { checkArgument(req.isAsyncSupported(), "servlet does not support asynchronous operation"); checkArgument(ServletAdapter.isGrpc(req), "the request is not a gRPC request"); @@ -119,7 +125,6 @@ public void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOEx AsyncContext asyncCtx = req.startAsync(req, resp); - String method = req.getRequestURI().substring(1); // remove the leading "/" Metadata headers = getHeaders(req); if (logger.isLoggable(FINEST)) { diff --git a/servlet/src/test/java/io/grpc/servlet/GrpcServletTest.java b/servlet/src/test/java/io/grpc/servlet/GrpcServletTest.java new file mode 100644 index 00000000000..d471f92a266 --- /dev/null +++ b/servlet/src/test/java/io/grpc/servlet/GrpcServletTest.java @@ -0,0 +1,67 @@ +/* + * Copyright 2025 The gRPC Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.grpc.servlet; + +import static io.grpc.servlet.GrpcServlet.REMOVE_CONTEXT_PATH; +import static org.junit.Assert.assertEquals; +import static org.mockito.Mockito.doCallRealMethod; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; + +@RunWith(JUnit4.class) +public class GrpcServletTest { + private static final String EXPECTED_METHOD = "hello/world"; + private static final String CONTEXT_PATH = "/grpc"; + private static final String REQUEST_URI = "/hello/world"; + + @Test + public void defaultMethodTest() throws ServletException { + HttpServletRequest request = mock(HttpServletRequest.class); + GrpcServlet grpcServlet = mock(GrpcServlet.class); + + doCallRealMethod().when(grpcServlet).init(); + grpcServlet.init(); + + doReturn(REQUEST_URI).when(request).getRequestURI(); + when(grpcServlet.getMethod(request)).thenCallRealMethod(); + + assertEquals(EXPECTED_METHOD, grpcServlet.getMethod(request)); + } + + @Test + public void removeContextPathMethodTest() throws ServletException { + HttpServletRequest request = mock(HttpServletRequest.class); + GrpcServlet grpcServlet = mock(GrpcServlet.class); + + doReturn("true").when(grpcServlet).getInitParameter(REMOVE_CONTEXT_PATH); + doCallRealMethod().when(grpcServlet).init(); + grpcServlet.init(); + + doReturn(CONTEXT_PATH + REQUEST_URI).when(request).getRequestURI(); + doReturn(CONTEXT_PATH).when(request).getContextPath(); + when(grpcServlet.getMethod(request)).thenCallRealMethod(); + + assertEquals(EXPECTED_METHOD, grpcServlet.getMethod(request)); + } +}