Class DefaultApiVersionStrategy

java.lang.Object

org.springframework.web.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)	Create an instance.

Method Summary

Modifier and Type	Method	Description
void	addSupportedVersion(String... versions)	Add to the list of known, supported versions to check against in ApiVersionStrategy.validateVersion(java.lang.Comparable<?>, jakarta.servlet.http.HttpServletRequest).
@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(HttpServletRequest request)	Resolve the version value from a request, e.g.
String	toString()
void	validateVersion(@Nullable Comparable<?> requestVersion, HttpServletRequest request)	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)

Create an instance.

Parameters:

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

versionParser - parser for 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

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 known, supported versions to check against in ApiVersionStrategy.validateVersion(java.lang.Comparable<?>, jakarta.servlet.http.HttpServletRequest). Request versions that are not in the supported result in InvalidApiVersionException in ApiVersionStrategy.validateVersion(java.lang.Comparable<?>, jakarta.servlet.http.HttpServletRequest).

Parameters:

versions - the versions to add

resolveVersion

public @Nullable String resolveVersion(HttpServletRequest request)

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:

request - the current request

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,
 HttpServletRequest request)
                     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

request - the request

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