Package io.micronaut.web.router.version

Class RoutesVersioningConfiguration

java.lang.Object

io.micronaut.web.router.version.RoutesVersioningConfiguration

All Implemented Interfaces:

Toggleable

@ConfigurationProperties("micronaut.router.versioning")
@Requires(property="micronaut.router.versioning.enabled",
          value="true")
public class RoutesVersioningConfiguration
extends Object
implements Toggleable

Routes versioning configuration.

Since:

1.1.0

Author:

Bogdan Oros

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	The configuration property.

Constructor Summary

Constructors

Constructor	Description
RoutesVersioningConfiguration()

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDefaultVersion()
boolean	isEnabled()
void	setDefaultVersion(@Nullable String defaultVersion)	Sets the version to use if the version cannot be resolved.
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

The configuration property.

See Also:

• Constant Field Values

Constructor Details

RoutesVersioningConfiguration

public RoutesVersioningConfiguration()

Method Details

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - Enables the version based route matches filtering.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

true if version based matches filtering is enabled.

getDefaultVersion

public Optional<String> getDefaultVersion()

Returns:

The version to use if none can be resolved

setDefaultVersion

public void setDefaultVersion(@Nullable
 @Nullable String defaultVersion)

Sets the version to use if the version cannot be resolved. Default value (null).

Parameters:

defaultVersion - The default version