Class DefaultApiVersionInserter

java.lang.Object

org.springframework.web.client.DefaultApiVersionInserter

All Implemented Interfaces:

ApiVersionInserter

public final class DefaultApiVersionInserter
extends Object
implements ApiVersionInserter

Default implementation of ApiVersionInserter to insert the version into a request header, query parameter, or the URL path.

Use builder() to create an instance.

Since:

7.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultApiVersionInserter.Builder	A builder for DefaultApiVersionInserter.

Method Summary

Modifier and Type	Method	Description
static DefaultApiVersionInserter.Builder	builder()	Create a builder.
static DefaultApiVersionInserter.Builder	fromHeader(@Nullable String header)	Create a builder for an inserter that sets a header.
static DefaultApiVersionInserter.Builder	fromPathSegment(@Nullable Integer pathSegmentIndex)	Create a builder for an inserter that inserts a path segment.
static DefaultApiVersionInserter.Builder	fromQueryParam(@Nullable String queryParam)	Create a builder for an inserter that sets a query parameter.
URI	insertVersion(Object version, URI uri)	Insert the version into the URI.
void	insertVersion(Object version, HttpHeaders headers)	Insert the version into the request headers.

Methods inherited from class java.lang.Object

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

Method Details

insertVersion

public URI insertVersion(Object version,
 URI uri)

Description copied from interface: ApiVersionInserter

Insert the version into the URI.

The default implementation returns the supplied URI unmodified.

Specified by:

insertVersion in interface ApiVersionInserter

Parameters:

version - the version to insert

uri - the URI for the request

Returns:

the updated URI, or the original URI unmodified

insertVersion

public void insertVersion(Object version,
 HttpHeaders headers)

Description copied from interface: ApiVersionInserter

Insert the version into the request headers.

The default implementation does not modify the supplied headers.

Specified by:

insertVersion in interface ApiVersionInserter

Parameters:

version - the version to insert

headers - the request headers

fromHeader

public static DefaultApiVersionInserter.Builder fromHeader(@Nullable String header)

Create a builder for an inserter that sets a header.

Parameters:

header - the name of a header to hold the version

fromQueryParam

public static DefaultApiVersionInserter.Builder fromQueryParam(@Nullable String queryParam)

Create a builder for an inserter that sets a query parameter.

Parameters:

queryParam - the name of a query parameter to hold the version

fromPathSegment

public static DefaultApiVersionInserter.Builder fromPathSegment(@Nullable Integer pathSegmentIndex)

Create a builder for an inserter that inserts a path segment.

Parameters:

pathSegmentIndex - the index of the path segment to hold the version

builder

public static DefaultApiVersionInserter.Builder builder()

Create a builder.