Uses of Class
org.springframework.web.util.UriComponentsBuilder

Packages that use UriComponentsBuilder

Package	Description
org.springframework.web.method.annotation	Support classes for annotation-based handler method processing.
org.springframework.web.method.support	Generic support classes for handler method processing.
org.springframework.web.servlet.mvc.method.annotation	MVC infrastructure for annotation-based handler method processing, building on the org.springframework.web.method.annotation package.
org.springframework.web.servlet.support	Support classes for Spring's web MVC framework.
org.springframework.web.util	Miscellaneous web utility classes, such as HTML escaping, Log4j initialization, and cookie handling.

Uses of UriComponentsBuilder in org.springframework.web.method.annotation

Methods in org.springframework.web.method.annotation with parameters of type UriComponentsBuilder

Modifier and Type	Method and Description
void	RequestParamMethodArgumentResolver.contributeMethodArgument(MethodParameter parameter, java.lang.Object value, UriComponentsBuilder builder, java.util.Map<java.lang.String,java.lang.Object> uriVariables, ConversionService conversionService)

Uses of UriComponentsBuilder in org.springframework.web.method.support

Methods in org.springframework.web.method.support with parameters of type UriComponentsBuilder

Modifier and Type	Method and Description
void	CompositeUriComponentsContributor.contributeMethodArgument(MethodParameter parameter, java.lang.Object value, UriComponentsBuilder builder, java.util.Map<java.lang.String,java.lang.Object> uriVariables) An overloaded method that uses the ConversionService created at construction.
void	CompositeUriComponentsContributor.contributeMethodArgument(MethodParameter parameter, java.lang.Object value, UriComponentsBuilder builder, java.util.Map<java.lang.String,java.lang.Object> uriVariables, ConversionService conversionService)
void	UriComponentsContributor.contributeMethodArgument(MethodParameter parameter, java.lang.Object value, UriComponentsBuilder builder, java.util.Map<java.lang.String,java.lang.Object> uriVariables, ConversionService conversionService) Process the given method argument and either update the UriComponentsBuilder or add to the map with URI variables to use to expand the URI after all arguments are processed.

Uses of UriComponentsBuilder in org.springframework.web.servlet.mvc.method.annotation

Methods in org.springframework.web.servlet.mvc.method.annotation that return UriComponentsBuilder

Modifier and Type	Method and Description
static UriComponentsBuilder	MvcUriComponentsBuilder.fromController(java.lang.Class<?> controllerType) Create a UriComponentsBuilder from the mapping of a controller class and current request information including Servlet mapping.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromController(UriComponentsBuilder builder, java.lang.Class<?> controllerType) An alternative to MvcUriComponentsBuilder.fromController(Class) that accepts a UriComponentsBuilder representing the base URL.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromMethod(java.lang.Class<?> controllerType, java.lang.reflect.Method method, java.lang.Object... args) Create a UriComponentsBuilder from the mapping of a controller method and an array of method argument values.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromMethod(UriComponentsBuilder baseUrl, java.lang.Class<?> controllerType, java.lang.reflect.Method method, java.lang.Object... args) An alternative to MvcUriComponentsBuilder.fromMethod(Class, Method, Object...) that accepts a UriComponentsBuilder representing the base URL.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromMethodCall(java.lang.Object info) Create a UriComponentsBuilder by invoking a "mock" controller method.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromMethodCall(UriComponentsBuilder builder, java.lang.Object info) An alternative to MvcUriComponentsBuilder.fromMethodCall(Object) that accepts a UriComponentsBuilder representing the base URL.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromMethodName(java.lang.Class<?> controllerType, java.lang.String methodName, java.lang.Object... args) Create a UriComponentsBuilder from the mapping of a controller method and an array of method argument values.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromMethodName(UriComponentsBuilder builder, java.lang.Class<?> controllerType, java.lang.String methodName, java.lang.Object... args) An alternative to MvcUriComponentsBuilder.fromMethodName(Class, String, Object...) that accepts a UriComponentsBuilder representing the base URL.
UriComponentsBuilder	MvcUriComponentsBuilder.withController(java.lang.Class<?> controllerType) An alternative to MvcUriComponentsBuilder.fromController(Class) for use with an instance of this class created via a call to MvcUriComponentsBuilder.relativeTo(org.springframework.web.util.UriComponentsBuilder).
UriComponentsBuilder	MvcUriComponentsBuilder.withMethod(java.lang.Class<?> controllerType, java.lang.reflect.Method method, java.lang.Object... args) An alternative to MvcUriComponentsBuilder.fromMethod(Class, Method, Object...) for use with an instance of this class created via MvcUriComponentsBuilder.relativeTo(org.springframework.web.util.UriComponentsBuilder).
UriComponentsBuilder	MvcUriComponentsBuilder.withMethodCall(java.lang.Object invocationInfo) An alternative to MvcUriComponentsBuilder.fromMethodCall(Object) for use with an instance of this class created via MvcUriComponentsBuilder.relativeTo(org.springframework.web.util.UriComponentsBuilder).
UriComponentsBuilder	MvcUriComponentsBuilder.withMethodName(java.lang.Class<?> controllerType, java.lang.String methodName, java.lang.Object... args) An alternative to MvcUriComponentsBuilder.fromMethodName(Class, String, Object...)} for use with an instance of this class created via MvcUriComponentsBuilder.relativeTo(org.springframework.web.util.UriComponentsBuilder).

Methods in org.springframework.web.servlet.mvc.method.annotation with parameters of type UriComponentsBuilder

Modifier and Type	Method and Description
void	PathVariableMethodArgumentResolver.contributeMethodArgument(MethodParameter parameter, java.lang.Object value, UriComponentsBuilder builder, java.util.Map<java.lang.String,java.lang.Object> uriVariables, ConversionService conversionService)
static UriComponentsBuilder	MvcUriComponentsBuilder.fromController(UriComponentsBuilder builder, java.lang.Class<?> controllerType) An alternative to MvcUriComponentsBuilder.fromController(Class) that accepts a UriComponentsBuilder representing the base URL.
static MvcUriComponentsBuilder.MethodArgumentBuilder	MvcUriComponentsBuilder.fromMappingName(UriComponentsBuilder builder, java.lang.String name) An alternative to MvcUriComponentsBuilder.fromMappingName(String) that accepts a UriComponentsBuilder representing the base URL.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromMethod(UriComponentsBuilder baseUrl, java.lang.Class<?> controllerType, java.lang.reflect.Method method, java.lang.Object... args) An alternative to MvcUriComponentsBuilder.fromMethod(Class, Method, Object...) that accepts a UriComponentsBuilder representing the base URL.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromMethodCall(UriComponentsBuilder builder, java.lang.Object info) An alternative to MvcUriComponentsBuilder.fromMethodCall(Object) that accepts a UriComponentsBuilder representing the base URL.
static UriComponentsBuilder	MvcUriComponentsBuilder.fromMethodName(UriComponentsBuilder builder, java.lang.Class<?> controllerType, java.lang.String methodName, java.lang.Object... args) An alternative to MvcUriComponentsBuilder.fromMethodName(Class, String, Object...) that accepts a UriComponentsBuilder representing the base URL.
static MvcUriComponentsBuilder	MvcUriComponentsBuilder.relativeTo(UriComponentsBuilder baseUrl) Create an instance of this class with a base URL.

Constructors in org.springframework.web.servlet.mvc.method.annotation with parameters of type UriComponentsBuilder

Constructor and Description
MethodArgumentBuilder(UriComponentsBuilder baseUrl, java.lang.Class<?> controllerType, java.lang.reflect.Method method)
MvcUriComponentsBuilder(UriComponentsBuilder baseUrl) Default constructor.

Uses of UriComponentsBuilder in org.springframework.web.servlet.support

Subclasses of UriComponentsBuilder in org.springframework.web.servlet.support

Modifier and Type	Class and Description
class	ServletUriComponentsBuilder UriComponentsBuilder with additional static factory methods to create links based on the current HttpServletRequest.

Uses of UriComponentsBuilder in org.springframework.web.util

Methods in org.springframework.web.util that return UriComponentsBuilder

Modifier and Type	Method and Description
UriComponentsBuilder	UriComponentsBuilder.cloneBuilder() Clone this UriComponentsBuilder.
UriComponentsBuilder	UriComponentsBuilder.encode() Request to have the URI template pre-encoded at build time, and URI variables encoded separately when expanded.
UriComponentsBuilder	UriComponentsBuilder.encode(java.nio.charset.Charset charset) A variant of encode() with a charset other than "UTF-8".
UriComponentsBuilder	UriComponentsBuilder.fragment(java.lang.String fragment) Set the URI fragment.
static UriComponentsBuilder	UriComponentsBuilder.fromHttpRequest(HttpRequest request) Create a new UriComponents object from the URI associated with the given HttpRequest while also overlaying with values from the headers "Forwarded" (RFC 7239), or "X-Forwarded-Host", "X-Forwarded-Port", and "X-Forwarded-Proto" if "Forwarded" is not found.
static UriComponentsBuilder	UriComponentsBuilder.fromHttpUrl(java.lang.String httpUrl) Create a URI components builder from the given HTTP URL String.
static UriComponentsBuilder	UriComponentsBuilder.fromOriginHeader(java.lang.String origin) Create an instance by parsing the "Origin" header of an HTTP request.
static UriComponentsBuilder	UriComponentsBuilder.fromPath(java.lang.String path) Create a builder that is initialized with the given path.
static UriComponentsBuilder	UriComponentsBuilder.fromUri(java.net.URI uri) Create a builder that is initialized with the given URI.
static UriComponentsBuilder	UriComponentsBuilder.fromUriString(java.lang.String uri) Create a builder that is initialized with the given URI string.
UriComponentsBuilder	UriComponentsBuilder.host(java.lang.String host) Set the URI host.
protected UriComponentsBuilder	DefaultUriTemplateHandler.initUriComponentsBuilder(java.lang.String uriTemplate) Deprecated. Create a UriComponentsBuilder from the URI template string.
static UriComponentsBuilder	UriComponentsBuilder.newInstance() Create a new, empty builder.
UriComponentsBuilder	UriComponentsBuilder.path(java.lang.String path) Append the given path to the existing path of this builder.
UriComponentsBuilder	UriComponentsBuilder.pathSegment(java.lang.String... pathSegments) Append path segments to the existing path.
UriComponentsBuilder	UriComponentsBuilder.port(int port) Set the URI port.
UriComponentsBuilder	UriComponentsBuilder.port(java.lang.String port) Set the URI port.
UriComponentsBuilder	UriComponentsBuilder.query(java.lang.String query) Append the given query to the existing query of this builder.
UriComponentsBuilder	UriComponentsBuilder.queryParam(java.lang.String name, java.lang.Object... values) Append the given query parameter to the existing query parameters.
UriComponentsBuilder	UriComponentsBuilder.queryParams(MultiValueMap<java.lang.String,java.lang.String> params) Add the given query parameters.
UriComponentsBuilder	UriComponentsBuilder.replacePath(java.lang.String path) Set the path of this builder overriding all existing path and path segment values.
UriComponentsBuilder	UriComponentsBuilder.replaceQuery(java.lang.String query) Set the query of this builder overriding all existing query parameters.
UriComponentsBuilder	UriComponentsBuilder.replaceQueryParam(java.lang.String name, java.lang.Object... values) Set the query parameter values overriding all existing query values for the same parameter.
UriComponentsBuilder	UriComponentsBuilder.replaceQueryParams(MultiValueMap<java.lang.String,java.lang.String> params) Set the query parameter values overriding all existing query values.
UriComponentsBuilder	UriComponentsBuilder.scheme(java.lang.String scheme) Set the URI scheme.
UriComponentsBuilder	UriComponentsBuilder.schemeSpecificPart(java.lang.String ssp) Set the URI scheme-specific-part.
UriComponentsBuilder	UriComponentsBuilder.uri(java.net.URI uri) Initialize components of this builder from components of the given URI.
UriComponentsBuilder	UriComponentsBuilder.uriComponents(UriComponents uriComponents) Set or append individual URI components of this builder from the values of the given UriComponents instance.
UriComponentsBuilder	UriComponentsBuilder.uriVariables(java.util.Map<java.lang.String,java.lang.Object> uriVariables) Configure URI variables to be expanded at build time.
UriComponentsBuilder	UriComponentsBuilder.userInfo(java.lang.String userInfo) Set the URI user info.

Methods in org.springframework.web.util with parameters of type UriComponentsBuilder

Modifier and Type	Method and Description
protected abstract void	UriComponents.copyToUriComponentsBuilder(UriComponentsBuilder builder) Set all components of the given UriComponentsBuilder.
protected UriComponents	DefaultUriTemplateHandler.expandAndEncode(UriComponentsBuilder builder, java.util.Map<java.lang.String,?> uriVariables) Deprecated.
protected UriComponents	DefaultUriTemplateHandler.expandAndEncode(UriComponentsBuilder builder, java.lang.Object[] uriVariables) Deprecated.

Constructors in org.springframework.web.util with parameters of type UriComponentsBuilder

Constructor and Description
DefaultUriBuilderFactory(UriComponentsBuilder baseUri) Variant of DefaultUriBuilderFactory.DefaultUriBuilderFactory(String) with a UriComponentsBuilder.
UriComponentsBuilder(UriComponentsBuilder other) Create a deep copy of the given UriComponentsBuilder.