org.springframework.boot.web.client

Class RootUriTemplateHandler

java.lang.Object

org.springframework.boot.web.client.RootUriTemplateHandler

All Implemented Interfaces:

UriTemplateHandler

Direct Known Subclasses:

LocalHostUriTemplateHandler

public class RootUriTemplateHandler
extends Object
implements UriTemplateHandler

UriTemplateHandler to set the root for URI that starts with '/'.

Since:

1.4.0

Author:

Phillip Webb

Constructor Summary

Constructors

Modifier	Constructor and Description
	RootUriTemplateHandler(String rootUri) Create a new RootUriTemplateHandler instance.
	RootUriTemplateHandler(String rootUri, UriTemplateHandler handler) Create a new RootUriTemplateHandler instance.
protected	RootUriTemplateHandler(UriTemplateHandler handler)

Method Summary

Modifier and Type	Method and Description
static RootUriTemplateHandler	addTo(RestTemplate restTemplate, String rootUri) Add a RootUriTemplateHandler instance to the given RestTemplate.
URI	expand(String uriTemplate, Map<String,?> uriVariables)
URI	expand(String uriTemplate, Object... uriVariables)
String	getRootUri()
RootUriTemplateHandler	withHandlerWrapper(Function<UriTemplateHandler,UriTemplateHandler> wrapper) Derives a new RootUriTemplateHandler from this one, wrapping its delegate UriTemplateHandler by applying the given wrapper.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RootUriTemplateHandler

protected RootUriTemplateHandler(UriTemplateHandler handler)

RootUriTemplateHandler

public RootUriTemplateHandler(String rootUri)

Create a new RootUriTemplateHandler instance.

Parameters:

rootUri - the root URI to be used to prefix relative URLs

RootUriTemplateHandler

public RootUriTemplateHandler(String rootUri,
                              UriTemplateHandler handler)

Create a new RootUriTemplateHandler instance.

Parameters:

rootUri - the root URI to be used to prefix relative URLs

handler - the delegate handler

Method Detail

expand

public URI expand(String uriTemplate,
                  Map<String,?> uriVariables)

Specified by:

expand in interface UriTemplateHandler

expand

public URI expand(String uriTemplate,
                  Object... uriVariables)

Specified by:

expand in interface UriTemplateHandler

getRootUri

public String getRootUri()

withHandlerWrapper

public RootUriTemplateHandler withHandlerWrapper(Function<UriTemplateHandler,UriTemplateHandler> wrapper)

Derives a new RootUriTemplateHandler from this one, wrapping its delegate UriTemplateHandler by applying the given wrapper.

Parameters:

wrapper - the wrapper to apply to the delegate URI template handler

Returns:

the new handler

Since:

2.3.10

addTo

public static RootUriTemplateHandler addTo(RestTemplate restTemplate,
                                           String rootUri)

Add a RootUriTemplateHandler instance to the given RestTemplate.

Parameters:

restTemplate - the RestTemplate to add the handler to

rootUri - the root URI

Returns:

the added RootUriTemplateHandler.