org.springframework.web.client.RestOperationsExtensions.kt Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2002-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.web.client
import org.springframework.core.ParameterizedTypeReference
import org.springframework.http.HttpEntity
import org.springframework.http.HttpMethod
import org.springframework.http.RequestEntity
import org.springframework.http.ResponseEntity
import java.net.URI
/**
* Extension for [RestOperations.getForObject] providing a `getForObject(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.getForObject(url: String, vararg uriVariables: Any): T =
getForObject(url, T::class.java, *uriVariables) as T
/**
* Extension for [RestOperations.getForObject] providing a `getForObject(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.getForObject(url: String, uriVariables: Map): T =
getForObject(url, T::class.java, uriVariables) as T
/**
* Extension for [RestOperations.getForObject] providing a `getForObject(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.getForObject(url: URI): T =
getForObject(url, T::class.java) as T
/**
* Extension for [RestOperations.getForEntity] providing a `getForEntity(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Sebastien Deleuze
* @since 5.0.2
*/
@Throws(RestClientException::class)
inline fun RestOperations.getForEntity(url: URI): ResponseEntity =
getForEntity(url, T::class.java)
/**
* Extension for [RestOperations.getForEntity] providing a `getForEntity(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.getForEntity(url: String, vararg uriVariables: Any): ResponseEntity =
getForEntity(url, T::class.java, *uriVariables)
/**
* Extension for [RestOperations.getForEntity] providing a `getForEntity(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Sebastien Deleuze
* @since 5.0.2
*/
@Throws(RestClientException::class)
inline fun RestOperations.getForEntity(url: String, uriVariables: Map): ResponseEntity =
getForEntity(url, T::class.java, uriVariables)
/**
* Extension for [RestOperations.patchForObject] providing a `patchForObject(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Sebastien Deleuze
* @since 5.0.2
*/
@Throws(RestClientException::class)
inline fun RestOperations.patchForObject(url: String, request: Any? = null,
vararg uriVariables: Any): T =
patchForObject(url, request, T::class.java, *uriVariables) as T
/**
* Extension for [RestOperations.patchForObject] providing a `patchForObject(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Sebastien Deleuze
* @since 5.0.2
*/
@Throws(RestClientException::class)
inline fun RestOperations.patchForObject(url: String, request: Any? = null,
uriVariables: Map): T =
patchForObject(url, request, T::class.java, uriVariables) as T
/**
* Extension for [RestOperations.patchForObject] providing a `patchForObject(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Sebastien Deleuze
* @since 5.0.2
*/
@Throws(RestClientException::class)
inline fun RestOperations.patchForObject(url: URI, request: Any? = null): T =
patchForObject(url, request, T::class.java) as T
/**
* Extension for [RestOperations.postForObject] providing a `postForObject(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.postForObject(url: String, request: Any? = null,
vararg uriVariables: Any): T =
postForObject(url, request, T::class.java, *uriVariables) as T
/**
* Extension for [RestOperations.postForObject] providing a `postForObject(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.postForObject(url: String, request: Any? = null,
uriVariables: Map): T =
postForObject(url, request, T::class.java, uriVariables) as T
/**
* Extension for [RestOperations.postForObject] providing a `postForObject(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.postForObject(url: URI, request: Any? = null): T =
postForObject(url, request, T::class.java) as T
/**
* Extension for [RestOperations.postForEntity] providing a `postForEntity(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.postForEntity(url: String, request: Any? = null,
vararg uriVariables: Any): ResponseEntity =
postForEntity(url, request, T::class.java, *uriVariables)
/**
* Extension for [RestOperations.postForEntity] providing a `postForEntity(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.postForEntity(url: String, request: Any? = null,
uriVariables: Map): ResponseEntity =
postForEntity(url, request, T::class.java, uriVariables)
/**
* Extension for [RestOperations.postForEntity] providing a `postForEntity(...)`
* variant leveraging Kotlin reified type parameters. Like the original Java method, this
* extension is subject to type erasure. Use [exchange] if you need to retain actual
* generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.postForEntity(url: URI, request: Any? = null): ResponseEntity =
postForEntity(url, request, T::class.java)
/**
* Extension for [RestOperations.exchange] providing an `exchange(...)`
* variant leveraging Kotlin reified type parameters. This extension is not subject to
* type erasure and retains actual generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.exchange(url: String, method: HttpMethod,
requestEntity: HttpEntity<*>? = null, vararg uriVariables: Any): ResponseEntity =
exchange(url, method, requestEntity, object : ParameterizedTypeReference() {}, *uriVariables)
/**
* Extension for [RestOperations.exchange] providing an `exchange(...)`
* variant leveraging Kotlin reified type parameters. This extension is not subject to
* type erasure and retains actual generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.exchange(url: String, method: HttpMethod,
requestEntity: HttpEntity<*>? = null, uriVariables: Map): ResponseEntity =
exchange(url, method, requestEntity, object : ParameterizedTypeReference() {}, uriVariables)
/**
* Extension for [RestOperations.exchange] providing an `exchange(...)`
* variant leveraging Kotlin reified type parameters. This extension is not subject to
* type erasure and retains actual generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.exchange(url: URI, method: HttpMethod,
requestEntity: HttpEntity<*>? = null): ResponseEntity =
exchange(url, method, requestEntity, object : ParameterizedTypeReference() {})
/**
* Extension for [RestOperations.exchange] providing an `exchange(...)`
* variant leveraging Kotlin reified type parameters. This extension is not subject to
* type erasure and retains actual generic type arguments.
*
* @author Jon Schneider
* @author Sebastien Deleuze
* @since 5.0
*/
@Throws(RestClientException::class)
inline fun RestOperations.exchange(requestEntity: RequestEntity<*>): ResponseEntity =
exchange(requestEntity, object : ParameterizedTypeReference() {})