Package io.micronaut.multitenancy.writer

Class HttpHeaderTenantWriterConfigurationProperties

java.lang.Object

io.micronaut.multitenancy.writer.HttpHeaderTenantWriterConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, HttpHeaderTenantWriterConfiguration

@ConfigurationProperties("micronaut.multitenancy.tenantwriter.httpheader")
public class HttpHeaderTenantWriterConfigurationProperties
extends java.lang.Object
implements HttpHeaderTenantWriterConfiguration

Tenant Writer Configuration Properties.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_ENABLED	The default enable value.
static java.lang.String	DEFAULT_HEADERNAME	The default header name.
static java.lang.String	PREFIX	Configuration Properties Prefix.

Constructor Summary

Constructors

Constructor	Description
HttpHeaderTenantWriterConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHeaderName()
boolean	isEnabled()
void	setEnabled(boolean enabled)	Enables HttpHeaderTenantWriter.
void	setHeaderName(java.lang.String headerName)	Http Header name.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

Configuration Properties Prefix.

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

DEFAULT_HEADERNAME

public static final java.lang.String DEFAULT_HEADERNAME

The default header name.

See Also:

Constant Field Values

Constructor Detail

HttpHeaderTenantWriterConfigurationProperties

public HttpHeaderTenantWriterConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

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

setEnabled

public void setEnabled(boolean enabled)

Enables HttpHeaderTenantWriter. Default value (false).

Parameters:

enabled - enabled flag

setHeaderName

public void setHeaderName(java.lang.String headerName)

Http Header name. Default value ("tenantId").

Parameters:

headerName - HTTP header name

getHeaderName

public java.lang.String getHeaderName()

Specified by:

getHeaderName in interface HttpHeaderTenantWriterConfiguration

Returns:

an HTTP Header name. e.g. Authorization