io.micronaut.web.router.version.resolution

Class HeaderVersionResolver

java.lang.Object

io.micronaut.web.router.version.resolution.HeaderVersionResolver

All Implemented Interfaces:

RequestVersionResolver, VersionResolver<HttpRequest<?>,java.lang.String>

@Singleton
 @Requires(beans={RoutesVersioningConfiguration.class,HeaderVersionResolverConfiguration.class})
public class HeaderVersionResolver
extends java.lang.Object
implements RequestVersionResolver

A RequestVersionResolver responsible for extracting version from HttpHeaders.

Since:

1.1.0

Author:

Bogdan Oros

Constructor Summary

Constructors

Constructor and Description
HeaderVersionResolver(HeaderVersionResolverConfiguration configuration) Creates a RequestVersionResolver to extract version from request header.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	resolve(HttpRequest<?> request) Resolves a version from a given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderVersionResolver

@Inject
public HeaderVersionResolver(HeaderVersionResolverConfiguration configuration)

Creates a RequestVersionResolver to extract version from request header.

Parameters:

configuration - A configuration to pick correct request header names.

Method Detail

resolve

public java.util.Optional<java.lang.String> resolve(HttpRequest<?> request)

Description copied from interface: VersionResolver

Resolves a version from a given object.

Specified by:

resolve in interface VersionResolver<HttpRequest<?>,java.lang.String>

Parameters:

request - The type of object to resolve from

Returns:

An optional object representing the version