io.micronaut.web.router.version.resolution

Class ParameterVersionResolverConfiguration

java.lang.Object

io.micronaut.web.router.version.resolution.ParameterVersionResolverConfiguration

All Implemented Interfaces:

Toggleable

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

Configuration for version resolution via request parameters.

Since:

1.1.0

Author:

James Kleeh, graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PARAMETER_NAME
static String	PREFIX

Constructor Summary

Constructors

Constructor and Description
ParameterVersionResolverConfiguration()

Method Summary

Modifier and Type	Method and Description
List<String>	getNames()
boolean	isEnabled()
void	setEnabled(boolean enabled) Sets whether parameter should be searched for a version.
void	setNames(List<String> names) Sets which parameter should be searched for a version.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

DEFAULT_PARAMETER_NAME

public static final String DEFAULT_PARAMETER_NAME

See Also:

Constant Field Values

Constructor Detail

ParameterVersionResolverConfiguration

public ParameterVersionResolverConfiguration()

Method Detail

getNames

public List<String> getNames()

Returns:

The parameter names to search for the version.

setNames

public void setNames(List<String> names)

Sets which parameter should be searched for a version.

Parameters:

names - The parameter names

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

true If parameter should be searched.

setEnabled

public void setEnabled(boolean enabled)

Sets whether parameter should be searched for a version.

Parameters:

enabled - True if parameter should be searched.