Spring 3 RequestMapping Get path value

Question

Is there a way to get the complete path value after the requestMapping  PathVariable values have been parsed   That is    id   restOfTheUrl  should be able to parse  1 dir1 dir2 file html into id 1 and restOfTheUrl  dir1 dir2 file html  Any ideas would be appreciated

User · Answer

I have a similar problem and I resolved in this way:

@RequestMapping(value = "{siteCode}/**/{fileName}.{fileExtension}")
public HttpEntity<byte[]> getResource(@PathVariable String siteCode,
        @PathVariable String fileName, @PathVariable String fileExtension,
        HttpServletRequest req, HttpServletResponse response ) throws IOException {
    String fullPath = req.getPathInfo();
    // Calling http://localhost:8080/SiteXX/images/argentine/flag.jpg
    // fullPath conentent: /SiteXX/images/argentine/flag.jpg
}

Note that req.getPathInfo() will return the complete path (with {siteCode} and {fileName}.{fileExtension}) so you will have to process conveniently.

User · Answer

Yes the restOfTheUrl is not returning only required value but we can get the value by using UriTemplate matching   I have solved the problem  so here the working solution for the problem    RequestMapping    id       public void foo  PathVariable  id   int id  HttpServletRequest request    String restOfTheUrl    String  request getAttribute      HandlerMapping PATH WITHIN HANDLER MAPPING ATTRIBUTE         We can use UriTemplate to map the restOfTheUrl       UriTemplate template   new UriTemplate    id   value                 boolean isTemplateMatched   template matches restOfTheUrl       if isTemplateMatched            Map lt String  String gt  matchTemplate   new HashMap lt String  String gt             matchTemplate   template match restOfTheUrl           String value   matchTemplate get  value             variable  value  will contain the required detail

User · Answer

You need to use built-in pathMatcher    RequestMapping    id       public void test HttpServletRequest request   PathVariable long id  throws Exception       ResourceUrlProvider urlProvider    ResourceUrlProvider  request              getAttribute ResourceUrlProvider class getCanonicalName         String restOfUrl   urlProvider getPathMatcher   extractPathWithinPattern              String valueOf request getAttribute HandlerMapping BEST MATCHING PATTERN ATTRIBUTE                String valueOf request getAttribute HandlerMapping PATH WITHIN HANDLER MAPPING ATTRIBUTE

User · Answer

Building upon Fabien Kruba s already excellent answer  I thought it would be nice if the    portion of the URL could be given as a parameter to the controller method via an annotation  in a way which was similar to  RequestParam and  PathVariable  rather than always using a utility method which explicitly required the HttpServletRequest  So here s an example of how that might be implemented  Hopefully someone finds it useful   Create the annotation  along with the argument resolver    Target ElementType PARAMETER   Retention RetentionPolicy RUNTIME   Documented public  interface WildcardParam        class Resolver implements HandlerMethodArgumentResolver             Override         public boolean supportsParameter MethodParameter methodParameter                return methodParameter getParameterAnnotation WildcardParam class     null                      Override         public Object resolveArgument MethodParameter methodParameter  ModelAndViewContainer modelAndViewContainer  NativeWebRequest nativeWebRequest  WebDataBinderFactory webDataBinderFactory  throws Exception               HttpServletRequest request   nativeWebRequest getNativeRequest HttpServletRequest class               return request    null   null   new AntPathMatcher   extractPathWithinPattern                       String  request getAttribute HandlerMapping BEST MATCHING PATTERN ATTRIBUTE                        String  request getAttribute HandlerMapping PATH WITHIN HANDLER MAPPING ATTRIBUTE                          Register the method argument resolver    Configuration public class WebMvcConfig implements WebMvcConfigurer         Override     public void addArgumentResolvers List lt HandlerMethodArgumentResolver gt  resolvers            resolvers add new WildcardParam Resolver                Use the annotation in your controller handler methods to have easy access to the    portion of the URL    RestController public class SomeController         GetMapping            public void someHandlerMethod  WildcardParam String wildcardParam               use wildcardParam here

User · Answer

Just found that issue corresponding to my problem  Using HandlerMapping constants I was able to wrote a small utility for that purpose          Extract path from a controller mapping   controllerUrl      gt  return matched        param request incoming request      return extracted path     public static String extractPathFromPattern final HttpServletRequest request         String path    String  request getAttribute              HandlerMapping PATH WITHIN HANDLER MAPPING ATTRIBUTE       String bestMatchPattern    String   request getAttribute HandlerMapping BEST MATCHING PATTERN ATTRIBUTE        AntPathMatcher apm   new AntPathMatcher        String finalPath   apm extractPathWithinPattern bestMatchPattern  path        return finalPath

User · Answer

Non-matched part of the URL is exposed as a request attribute named HandlerMapping PATH WITHIN HANDLER MAPPING ATTRIBUTE    RequestMapping    id       public void foo  PathVariable  id   int id  HttpServletRequest request        String restOfTheUrl    String  request getAttribute          HandlerMapping PATH WITHIN HANDLER MAPPING ATTRIBUTE

User · Answer

This has been here quite a while but posting this  Might be useful for someone    RequestMapping     id        public void foo   PathVariable String id  HttpServletRequest request         String urlTail   new AntPathMatcher                extractPathWithinPattern     id       request getRequestURI

User · Answer

I have used the Tuckey URLRewriteFilter to handle path elements that contain     characters  as I don t think Spring 3 MVC supports them yet    http   www tuckey org   You put this filter in to your app  and provide an XML config file  In that file you provide rewrite rules  which you can use to translate path elements containing     characters into request parameters that Spring MVC can deal with properly using  RequestParam   WEB-INF web xml    lt filter gt     lt filter-name gt UrlRewriteFilter lt  filter-name gt     lt filter-class gt org tuckey web filters urlrewrite UrlRewriteFilter lt  filter-class gt   lt  filter gt   lt  -- map to    -- gt    WEB-INF urlrewrite xml    lt  xml version  1 0  encoding  utf-8   gt   lt  DOCTYPE urlrewrite     PUBLIC  -  tuckey org  DTD UrlRewrite 3 0  EN       http   tuckey org res dtds urlrewrite3 0 dtd  gt   lt urlrewrite gt     lt rule gt       lt from gt              lt  from gt       lt to last  true  gt   1 restOfTheUrl  2 lt  to gt   lt  urlrewrite gt    Controller method    RequestMapping    id    public void handler  PathVariable  id   int id   RequestParam  restOfTheUrl   String pathToFile

User · Answer

Here is how I did it  You can see how I convert the requestedURI to a filesystem path  what this SO question is about   Bonus  and also how to respond with the file     RequestMapping value     file  userId       method   RequestMethod GET  public void serveFile  PathVariable  userId   long userId  HttpServletRequest request  HttpServletResponse response        assert request    null      assert response    null          requestURL   http   192 168 1 3 8080 file 54 documents tutorial pdf        requestURI    file 54 documents tutorial pdf        servletPath   file 54 documents tutorial pdf        logger debug  requestURL      request getRequestURL            logger debug  requestURI      request getRequestURI            logger debug  servletPath      request getServletPath          String requestURI   request getRequestURI        String relativePath   requestURI replaceFirst    file              Path path   Paths get   user files   resolve relativePath       try           InputStream is   new FileInputStream path toFile               org apache commons io IOUtils copy is  response getOutputStream             response flushBuffer          catch  IOException ex            logger error  Error writing file to output stream  Path       path       requestURI       requestURI                 throw new RuntimeException  IOError writing file to output stream

User · Answer

private final static String MAPPING     foo       RequestMapping value   MAPPING  method   RequestMethod GET  public  ResponseBody void foo HttpServletRequest request  HttpServletResponse response        final String mapping   getMapping  foo   replace                final String path    String  request getAttribute HandlerMapping PATH WITHIN HANDLER MAPPING ATTRIBUTE       final String restOfPath   url replace mapping           System out println restOfPath      private String getMapping String methodName        Method methods     this getClass   getMethods        for  int i   0  i  lt  methods length  i              if  methods i  getName      methodName                String mapping     methods i  getAnnotation RequestMapping class  value                if  mapping length  gt  0                    return mapping mapping length - 1                                     return null

[spring] Spring 3 RequestMapping: Get path value

Examples related to spring

Examples related to spring-mvc

Examples related to request-mapping