io.micronaut.web.router.version.strategy

Class HeaderVersionExtractingStrategy

java.lang.Object

io.micronaut.web.router.version.strategy.HeaderVersionExtractingStrategy

All Implemented Interfaces:

VersionExtractingStrategy

@Singleton
 @Requires(beans=RoutesVersioningConfiguration.class) @Requires(property="micronaut.router.versioning.header.enabled",value="true")
public class HeaderVersionExtractingStrategy
extends Object
implements VersionExtractingStrategy

A VersionExtractingStrategy responsible for extracting version from HttpHeaders.

Since:

1.1.0

Author:

Bogdan Oros

Constructor Summary

Constructors

Constructor and Description
HeaderVersionExtractingStrategy(RoutesVersioningConfiguration.HeaderBasedVersioningConfiguration configuration) Creates a VersionExtractingStrategy to extract version from request header.

Method Summary

Modifier and Type	Method and Description
Optional<String>	extract(HttpRequest<?> request) Extracts the version from HttpRequest.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderVersionExtractingStrategy

@Inject
public HeaderVersionExtractingStrategy(RoutesVersioningConfiguration.HeaderBasedVersioningConfiguration configuration)

Creates a VersionExtractingStrategy to extract version from request header.

Parameters:

configuration - A configuration to pick correct request header names.

Method Detail

extract

public Optional<String> extract(HttpRequest<?> request)

Description copied from interface: VersionExtractingStrategy

Extracts the version from HttpRequest.

Specified by:

extract in interface VersionExtractingStrategy

Parameters:

request - The HTTP request

Returns:

Optional of the version value or Optional.empty() if version cannot be extracted