Any way to get the path parameters in httpservlet request

Question

I have rest service implemented.

I am trying to get the path parameters of the the request in filter.

My request is

/api/test/{id1}/{status}

 public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
        throws IOException, ServletException
    {
         //Way to get the path parameters id1 and status


     }

score 27 · Answer 1 · answered Jul 27 '18 at 06:15

27

You can autowire HttpServletRequest in your filter and use it to get information.

@Autowire
HttpServletRequest httpRequest


httpRequest.getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE)  

will give you map of path params.

Example:

If your request is like url/{requestId} then above map will return

0 = {LinkedHashMap$Entry@12596} "requestId" -> "a5185067-612a-422e-bac6-1f3d3fd20809"
 key = "requestId"
 value = "a5185067-612a-422e-bac6-1f3d3fd20809"

answered Jul 27 '18 at 06:15

Vivek Garg

2,115
1
20
17

2

but care this need some filters to run before it can be used! – Markus Schreiber Jul 12 '19 at 13:10
2

Any example of that? – Alpit Anand Jun 15 '21 at 11:02
is this only with Spring MVC? – Qianlong Mar 22 '22 at 08:56

score 6 · Accepted Answer · answered Mar 07 '14 at 16:16

There's no other way to do it in a ServletFilter other than trying to parse the URI yourself, but you can access the path parameters if you decide to use a JAX-RS request filter:

@Provider
public class PathParamterFilter implements ContainerRequestFilter {

    @Override
     public void filter(ContainerRequestContext request) throws IOException {
        MultivaluedMap<String, String> pathParameters = request.getUriInfo().getPathParameters();
        pathParameters.get("status");
        ....
    }
}

score 2 · Answer 3 · answered Aug 25 '20 at 20:09

String pathInfo = request.getPathInfo();
    if (pathInfo != null) {
        String[] parts = pathInfo.split("/");
        int indexOfName = Arrays.asList(parts).indexOf("test");
        if (indexOfName != -1) {
            Optional<String> testId1 = Optional.of(parts[indexOfName + 1]);
            Optional<String> status= Optional.of(parts[indexOfName + 2]);
        }

    }

Your Servlet Mapping should be till /api/* eg. @WebServlet(urlPatterns = {"/api/*"})

this is the most native way ! – Qianlong Mar 22 '22 at 08:57 — Qianlong, Mar 22 '22 at 08:57

Any way to get the path parameters in httpservlet request

3 Answers3

Linked