Package io.micronaut.multitenancy.tenantresolver

Class HttpHeaderTenantResolverConfigurationProperties

java.lang.Object

io.micronaut.multitenancy.tenantresolver.HttpHeaderTenantResolverConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, HttpHeaderTenantResolverConfiguration

@ConfigurationProperties("micronaut.multitenancy.tenantresolver.httpheader")
public class HttpHeaderTenantResolverConfigurationProperties
extends Object
implements HttpHeaderTenantResolverConfiguration

ConfigurationProperties implementation of HttpHeaderTenantResolverConfiguration.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLE	The default enable value.
static final String	PREFIX	Configuration Properties Prefix.

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

DEFAULT_HEADER_NAME

Constructor Summary

Constructors

Constructor	Description
HttpHeaderTenantResolverConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
String	getHeaderName()	Http Header name which should be used to resolve the tenant id from.
boolean	isEnabled()
void	setEnabled(boolean enabled)	Enables HttpHeaderTenantResolver.
void	setHeaderName(String headerName)	Http Header name which should be used to resolve the tenant id from.

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

Configuration Properties Prefix.

See Also:

• Constant Field Values

DEFAULT_ENABLE

public static final boolean DEFAULT_ENABLE

The default enable value.

See Also:

• Constant Field Values

Constructor Details

HttpHeaderTenantResolverConfigurationProperties

public HttpHeaderTenantResolverConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

setEnabled

public void setEnabled(boolean enabled)

Enables HttpHeaderTenantResolver. Default value (false).

Parameters:

enabled - True or False

setHeaderName

public void setHeaderName(String headerName)

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

Parameters:

headerName - Http Header name.

getHeaderName

public String getHeaderName()

Description copied from interface: HttpHeaderTenantResolverConfiguration

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

Specified by:

getHeaderName in interface HttpHeaderTenantResolverConfiguration

Returns:

a String containing the Http Header name.