Interface ApiVersionInserter

public interface ApiVersionInserter

Contract to insert an API version into the URI or headers of a request.

Use shortcut, static factory methods on this interface to create one of the built-in inserter type implementations:

• useHeader(String)
• useQueryParam(String)
• useMediaTypeParam(String)
• usePathSegment(Integer)

Use the builder() for further options such as if you want to also configure an ApiVersionFormatter.

Since:

7.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ApiVersionInserter.Builder	Builder for ApiVersionInserter.

Method Summary

Modifier and Type	Method	Description
static ApiVersionInserter.Builder	builder()	Create a builder for an ApiVersionInserter.
default URI	insertVersion(Object version, URI uri)	Insert the version into the URI.
default void	insertVersion(Object version, HttpHeaders headers)	Insert the version into the request headers.
static ApiVersionInserter	useHeader(@Nullable String header)	Create an inserter that sets a header.
static ApiVersionInserter	useMediaTypeParam(@Nullable String mediaTypeParam)	Create an inserter to set a MediaType parameter on the "Content-Type" header.
static ApiVersionInserter	usePathSegment(@Nullable Integer pathSegmentIndex)	Create an inserter that inserts a path segment.
static ApiVersionInserter	useQueryParam(@Nullable String queryParam)	Create an inserter that sets a query parameter.

Method Details

insertVersion

default URI insertVersion(Object version,
 URI uri)

Insert the version into the URI.

The default implementation returns the supplied URI unmodified.

Parameters:

version - the version to insert

uri - the URI for the request

Returns:

the updated URI, or the original URI unmodified

insertVersion

default void insertVersion(Object version,
 HttpHeaders headers)

Insert the version into the request headers.

The default implementation does not modify the supplied headers.

Parameters:

version - the version to insert

headers - the request headers

useHeader

static ApiVersionInserter useHeader(@Nullable String header)

Create an inserter that sets a header.

Parameters:

header - the name of a header to hold the version

useQueryParam

static ApiVersionInserter useQueryParam(@Nullable String queryParam)

Create an inserter that sets a query parameter.

Parameters:

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

useMediaTypeParam

static ApiVersionInserter useMediaTypeParam(@Nullable String mediaTypeParam)

Create an inserter to set a MediaType parameter on the "Content-Type" header.

Parameters:

mediaTypeParam - the name of the media type parameter to hold the version

usePathSegment

static ApiVersionInserter usePathSegment(@Nullable Integer pathSegmentIndex)

Create an inserter that inserts a path segment.

Parameters:

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

builder

static ApiVersionInserter.Builder builder()

Create a builder for an ApiVersionInserter.