ServletUriComponentsBuilder

java.lang.Object
- org.springframework.web.util.UriComponentsBuilder
- - org.springframework.web.servlet.support.ServletUriComponentsBuilder

All Implemented Interfaces:

java.lang.Cloneable
```
public class ServletUriComponentsBuilder
extends UriComponentsBuilder
```
A UriComponentsBuilder that extracts information from the HttpServletRequest.

Since:

3.1

Author:

Rossen Stoyanchev

Field Summary

Fields
Modifier and Type Field and Description

private java.lang.String originalPath

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`originalPath`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ServletUriComponentsBuilder()` Default constructor.
`protected`	`ServletUriComponentsBuilder(ServletUriComponentsBuilder other)` Create a deep copy of the given ServletUriComponentsBuilder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`static ServletUriComponentsBuilder`	`fromContextPath(HttpServletRequest request)` Prepare a builder from the host, port, scheme, and context path of the given HttpServletRequest.
`static ServletUriComponentsBuilder`	`fromCurrentContextPath()` Same as `fromContextPath(HttpServletRequest)` except the request is obtained through `RequestContextHolder`.
`static ServletUriComponentsBuilder`	`fromCurrentRequest()` Same as `fromRequest(HttpServletRequest)` except the request is obtained through `RequestContextHolder`.
`static ServletUriComponentsBuilder`	`fromCurrentRequestUri()` Same as `fromRequestUri(HttpServletRequest)` except the request is obtained through `RequestContextHolder`.
`static ServletUriComponentsBuilder`	`fromCurrentServletMapping()` Same as `fromServletMapping(HttpServletRequest)` except the request is obtained through `RequestContextHolder`.
`static ServletUriComponentsBuilder`	`fromRequest(HttpServletRequest request)` Prepare a builder by copying the scheme, host, port, path, and query string of an HttpServletRequest.
`static ServletUriComponentsBuilder`	`fromRequestUri(HttpServletRequest request)` Prepare a builder from the host, port, scheme, and path (but not the query) of the HttpServletRequest.
`static ServletUriComponentsBuilder`	`fromServletMapping(HttpServletRequest request)` Prepare a builder from the host, port, scheme, context path, and servlet mapping of the given HttpServletRequest.
`protected static HttpServletRequest`	`getCurrentRequest()` Obtain current request through `RequestContextHolder`.
`private static ServletUriComponentsBuilder`	`initFromRequest(HttpServletRequest request)` Initialize a builder with a scheme, host,and port (but not path and query).
`private void`	`initPath(java.lang.String path)`
`private static java.lang.String`	`prependForwardedPrefix(HttpServletRequest request, java.lang.String path)`
`java.lang.String`	`removePathExtension()` Remove any path extension from the `requestURI`.

Methods inherited from class org.springframework.web.util.UriComponentsBuilder
build, build, buildAndExpand, buildAndExpand, fragment, fromHttpRequest, fromHttpUrl, fromOriginHeader, fromPath, fromUri, fromUriString, host, newInstance, path, pathSegment, port, port, query, queryParam, queryParams, replacePath, replaceQuery, replaceQueryParam, replaceQueryParams, scheme, schemeSpecificPart, toUriString, uri, uriComponents, userInfo

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - originalPath
```
private java.lang.String originalPath
```
- Constructor Detail
  - ServletUriComponentsBuilder
```
protected ServletUriComponentsBuilder()
```
    Default constructor. Protected to prevent direct instantiation.
    
    See Also:
    
    fromContextPath(HttpServletRequest), fromServletMapping(HttpServletRequest), fromRequest(HttpServletRequest), fromCurrentContextPath(), fromCurrentServletMapping(), fromCurrentRequest()
  - ServletUriComponentsBuilder
```
protected ServletUriComponentsBuilder(ServletUriComponentsBuilder other)
```
    Create a deep copy of the given ServletUriComponentsBuilder.
    
    Parameters:
    
    other - the other builder to copy from
- Method Detail
  - fromContextPath
```
public static ServletUriComponentsBuilder fromContextPath(HttpServletRequest request)
```
    Prepare a builder from the host, port, scheme, and context path of the given HttpServletRequest.
  - fromServletMapping
```
public static ServletUriComponentsBuilder fromServletMapping(HttpServletRequest request)
```
    Prepare a builder from the host, port, scheme, context path, and servlet mapping of the given HttpServletRequest.
    If the servlet is mapped by name, e.g. "/main/*", the path will end with "/main". If the servlet is mapped otherwise, e.g. "/" or "*.do", the result will be the same as if calling fromContextPath(HttpServletRequest).
  - fromRequestUri
```
public static ServletUriComponentsBuilder fromRequestUri(HttpServletRequest request)
```
    Prepare a builder from the host, port, scheme, and path (but not the query) of the HttpServletRequest.
  - fromRequest
```
public static ServletUriComponentsBuilder fromRequest(HttpServletRequest request)
```
    Prepare a builder by copying the scheme, host, port, path, and query string of an HttpServletRequest.
  - initFromRequest
```
private static ServletUriComponentsBuilder initFromRequest(HttpServletRequest request)
```
    Initialize a builder with a scheme, host,and port (but not path and query).
  - prependForwardedPrefix
```
private static java.lang.String prependForwardedPrefix(HttpServletRequest request,
                                                       java.lang.String path)
```
  - fromCurrentContextPath
```
public static ServletUriComponentsBuilder fromCurrentContextPath()
```
    Same as fromContextPath(HttpServletRequest) except the request is obtained through RequestContextHolder.
  - fromCurrentServletMapping
```
public static ServletUriComponentsBuilder fromCurrentServletMapping()
```
    Same as fromServletMapping(HttpServletRequest) except the request is obtained through RequestContextHolder.
  - fromCurrentRequestUri
```
public static ServletUriComponentsBuilder fromCurrentRequestUri()
```
    Same as fromRequestUri(HttpServletRequest) except the request is obtained through RequestContextHolder.
  - fromCurrentRequest
```
public static ServletUriComponentsBuilder fromCurrentRequest()
```
    Same as fromRequest(HttpServletRequest) except the request is obtained through RequestContextHolder.
  - getCurrentRequest
```
protected static HttpServletRequest getCurrentRequest()
```
    Obtain current request through RequestContextHolder.
  - initPath
```
private void initPath(java.lang.String path)
```
  - removePathExtension
```
public java.lang.String removePathExtension()
```
    Remove any path extension from the requestURI. This method must be invoked before any calls to UriComponentsBuilder.path(String) or UriComponentsBuilder.pathSegment(String...).
```
 GET http://foo.com/rest/books/6.json

 ServletUriComponentsBuilder builder = ServletUriComponentsBuilder.fromRequestUri(this.request);
 String ext = builder.removePathExtension();
 String uri = builder.path("/pages/1.{ext}").buildAndExpand(ext).toUriString();
 assertEquals("http://foo.com/rest/books/6/pages/1.json", result);
 
```
    Returns:
    
    the removed path extension for possible re-use, or null
    
    Since:
    
    4.0
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class UriComponentsBuilder

Class ServletUriComponentsBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.springframework.web.util.UriComponentsBuilder

Methods inherited from class java.lang.Object

Field Detail

originalPath

Constructor Detail

ServletUriComponentsBuilder

ServletUriComponentsBuilder

Method Detail

fromContextPath

fromServletMapping

fromRequestUri

fromRequest

initFromRequest

prependForwardedPrefix

fromCurrentContextPath

fromCurrentServletMapping

fromCurrentRequestUri

fromCurrentRequest

getCurrentRequest

initPath

removePathExtension

clone