io.micronaut.multitenancy.tenantresolver

Class CookieTenantResolverConfigurationProperties

java.lang.Object

io.micronaut.multitenancy.tenantresolver.CookieTenantResolverConfigurationProperties

All Implemented Interfaces:

Toggleable, CookieTenantResolverConfiguration

@ConfigurationProperties(value="micronaut.multitenancy.tenantresolver.cookie")
public class CookieTenantResolverConfigurationProperties
extends Object
implements CookieTenantResolverConfiguration

ConfigurationProperties implementation of CookieTenantResolverConfiguration.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLE The default enable value.
static String	PREFIX

Fields inherited from interface io.micronaut.multitenancy.tenantresolver.CookieTenantResolverConfiguration

DEFAULT_COOKIENAME

Constructor Summary

Constructors

Constructor and Description
CookieTenantResolverConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
String	getCookiename() Cookie name which should be used to resolve the tenant id from.
boolean	isEnabled()
void	setCookiename(String cookiename) Cookie name which should be used to resolve the tenant id from.
void	setEnabled(boolean enabled) Whether to enable CookieTenantResolver.

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_ENABLE

public static final boolean DEFAULT_ENABLE

The default enable value.

See Also:

Constant Field Values

Constructor Detail

CookieTenantResolverConfigurationProperties

public CookieTenantResolverConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Whether the component is enabled

setEnabled

public void setEnabled(boolean enabled)

Whether to enable CookieTenantResolver. Default value (false).

Parameters:

enabled - True or False

setCookiename

public void setCookiename(String cookiename)

Cookie name which should be used to resolve the tenant id from. Default value ("tenantId").

Parameters:

cookiename - Http Header name.

getCookiename

public String getCookiename()

Description copied from interface: CookieTenantResolverConfiguration

Cookie name which should be used to resolve the tenant id from.

Specified by:

getCookiename in interface CookieTenantResolverConfiguration

Returns:

a String with the Cookie name.