Class DefaultApiVersionStrategy

java.lang.Object

org.springframework.web.reactive.accept.DefaultApiVersionStrategy

All Implemented Interfaces:

ApiVersionStrategy

public class DefaultApiVersionStrategy
extends Object
implements ApiVersionStrategy

Default implementation of ApiVersionStrategy that delegates to the configured version resolvers and version parser.

Since:

7.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
DefaultApiVersionStrategy(List<ApiVersionResolver> versionResolvers, ApiVersionParser<?> versionParser, boolean versionRequired, @Nullable String defaultVersion, boolean detectSupportedVersions)	Create an instance.

Method Summary

Modifier and Type	Method	Description
void	addMappedVersion(String... versions)	Internal method to add to the list of actual version values that appear in request mappings, which allows supported versions to be discovered rather than configured.
void	addSupportedVersion(String... versions)	Add to the list of supported versions to check against in ApiVersionStrategy.validateVersion(java.lang.Comparable<?>, org.springframework.web.server.ServerWebExchange) before raising InvalidApiVersionException for unknown versions.
@Nullable Comparable<?>	getDefaultVersion()	Return a default version to use for requests that don't specify one.
Comparable<?>	parseVersion(String version)	Parse the version of a request into an Object.
@Nullable String	resolveVersion(ServerWebExchange exchange)	Resolve the version value from a request, e.g.
String	toString()
void	validateVersion(@Nullable Comparable<?> requestVersion, ServerWebExchange exchange)	Validate a request version, including required and supported version checks.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultApiVersionStrategy

public DefaultApiVersionStrategy(List<ApiVersionResolver> versionResolvers,
 ApiVersionParser<?> versionParser,
 boolean versionRequired,
 @Nullable String defaultVersion,
 boolean detectSupportedVersions)

Create an instance.

Parameters:

versionResolvers - one or more resolvers to try; the first non-null value returned by any resolver becomes the resolved used

versionParser - parser for to raw version values

versionRequired - whether a version is required; if a request does not have a version, and a defaultVersion is not specified, validation fails with MissingApiVersionException

defaultVersion - a default version to assign to requests that don't specify one

detectSupportedVersions - whether to use API versions that appear in mappings for supported version validation (true), or use only explicitly configured versions (false).

Method Details

getDefaultVersion

public @Nullable Comparable<?> getDefaultVersion()

Description copied from interface: ApiVersionStrategy

Return a default version to use for requests that don't specify one.

Specified by:

getDefaultVersion in interface ApiVersionStrategy

addSupportedVersion

public void addSupportedVersion(String... versions)

Add to the list of supported versions to check against in ApiVersionStrategy.validateVersion(java.lang.Comparable<?>, org.springframework.web.server.ServerWebExchange) before raising InvalidApiVersionException for unknown versions.

By default, actual version values that appear in request mappings are considered supported, and use of this method is optional. However, if you prefer to use only explicitly configured, supported versions, then set detectSupportedVersions flag to false.

Parameters:

versions - the supported versions to add

See Also:

• addMappedVersion(String...)

addMappedVersion

public void addMappedVersion(String... versions)

Internal method to add to the list of actual version values that appear in request mappings, which allows supported versions to be discovered rather than configured.

If you prefer to use explicitly configured, supported versions only, set the detectSupportedVersions flag to false.

Parameters:

versions - the versions to add

See Also:

• addSupportedVersion(String...)

resolveVersion

public @Nullable String resolveVersion(ServerWebExchange exchange)

Description copied from interface: ApiVersionStrategy

Resolve the version value from a request, e.g. from a request header.

Specified by:

resolveVersion in interface ApiVersionStrategy

Parameters:

exchange - the current exchange

Returns:

the version, if present or null

parseVersion

public Comparable<?> parseVersion(String version)

Description copied from interface: ApiVersionStrategy

Parse the version of a request into an Object.

Specified by:

parseVersion in interface ApiVersionStrategy

Parameters:

version - the value to parse

Returns:

an Object that represents the version

validateVersion

public void validateVersion(@Nullable Comparable<?> requestVersion,
 ServerWebExchange exchange)
                     throws MissingApiVersionException,
InvalidApiVersionException

Description copied from interface: ApiVersionStrategy

Validate a request version, including required and supported version checks.

Specified by:

validateVersion in interface ApiVersionStrategy

Parameters:

requestVersion - the version to validate

exchange - the exchange

Throws:

MissingApiVersionException - if the version is required, but not specified

InvalidApiVersionException - if the version is not supported

toString

public String toString()

Overrides:

toString in class Object