All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.web.util.UriTemplateHandler Maven / Gradle / Ivy

There is a newer version: 6.1.13
Show newest version
/*
 * Copyright 2002-2016 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
 *
 *      http://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.web.util;

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

/**
 * Strategy for expanding a URI template with full control over the URI template
 * syntax and the encoding of variables. Also a convenient central point for
 * pre-processing all URI templates for example to insert a common base path.
 *
 * 

Supported as a property on the {@code RestTemplate} as well as the * {@code AsyncRestTemplate}. The {@link DefaultUriTemplateHandler} is built * on Spring's URI template support via {@link UriComponentsBuilder}. An * alternative implementation may be used to plug external URI template libraries. * * @author Rossen Stoyanchev * @since 4.2 * @see org.springframework.web.client.RestTemplate#setUriTemplateHandler */ public interface UriTemplateHandler { /** * Expand the given URI template from a map of URI variables. * @param uriTemplate the URI template string * @param uriVariables the URI variables * @return the resulting URI */ URI expand(String uriTemplate, Map uriVariables); /** * Expand the given URI template from an array of URI variables. * @param uriTemplate the URI template string * @param uriVariables the URI variable values * @return the resulting URI */ URI expand(String uriTemplate, Object... uriVariables); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy