/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.web.client;

import java.net.URI;
import java.util.Map;

import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.DefaultUriBuilderFactory;
import org.springframework.web.util.UriTemplateHandler;

UriTemplateHandler to set the root for URI that starts with '/'.
Author:Phillip Webb
Since:1.4.0
/** * {@link UriTemplateHandler} to set the root for URI that starts with {@code '/'}. * * @author Phillip Webb * @since 1.4.0 */
public class RootUriTemplateHandler implements UriTemplateHandler { private final String rootUri; private final UriTemplateHandler handler; protected RootUriTemplateHandler(UriTemplateHandler handler) { Assert.notNull(handler, "Handler must not be null"); this.rootUri = null; this.handler = handler; }
Create a new RootUriTemplateHandler instance.
Params:
  • rootUri – the root URI to be used to prefix relative URLs
/** * Create a new {@link RootUriTemplateHandler} instance. * @param rootUri the root URI to be used to prefix relative URLs */
public RootUriTemplateHandler(String rootUri) { this(rootUri, new DefaultUriBuilderFactory()); }
Create a new RootUriTemplateHandler instance.
Params:
  • rootUri – the root URI to be used to prefix relative URLs
  • handler – the delegate handler
/** * Create a new {@link RootUriTemplateHandler} instance. * @param rootUri the root URI to be used to prefix relative URLs * @param handler the delegate handler */
public RootUriTemplateHandler(String rootUri, UriTemplateHandler handler) { Assert.notNull(rootUri, "RootUri must not be null"); Assert.notNull(handler, "Handler must not be null"); this.rootUri = rootUri; this.handler = handler; } @Override public URI expand(String uriTemplate, Map<String, ?> uriVariables) { return this.handler.expand(apply(uriTemplate), uriVariables); } @Override public URI expand(String uriTemplate, Object... uriVariables) { return this.handler.expand(apply(uriTemplate), uriVariables); } private String apply(String uriTemplate) { if (StringUtils.startsWithIgnoreCase(uriTemplate, "/")) { return getRootUri() + uriTemplate; } return uriTemplate; } public String getRootUri() { return this.rootUri; }
Add a RootUriTemplateHandler instance to the given RestTemplate.
Params:
  • restTemplate – the RestTemplate to add the handler to
  • rootUri – the root URI
Returns:the added RootUriTemplateHandler.
/** * Add a {@link RootUriTemplateHandler} instance to the given {@link RestTemplate}. * @param restTemplate the {@link RestTemplate} to add the handler to * @param rootUri the root URI * @return the added {@link RootUriTemplateHandler}. */
public static RootUriTemplateHandler addTo(RestTemplate restTemplate, String rootUri) { Assert.notNull(restTemplate, "RestTemplate must not be null"); RootUriTemplateHandler handler = new RootUriTemplateHandler(rootUri, restTemplate.getUriTemplateHandler()); restTemplate.setUriTemplateHandler(handler); return handler; } }