Package io.micronaut.multitenancy.writer

Class HttpHeaderTenantWriter

java.lang.Object

io.micronaut.multitenancy.writer.HttpHeaderTenantWriter

All Implemented Interfaces:

TenantWriter

@Singleton
@Requires(property="micronaut.multitenancy.tenantwriter.httpheader.enabled") @Requires(beans=HttpHeaderTenantWriterConfiguration.class)
public class HttpHeaderTenantWriter
extends java.lang.Object
implements TenantWriter

Write the tenant id in an HTTP header.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
protected HttpHeaderTenantWriterConfiguration	httpHeaderTenantWriterConfiguration	The HttpHeaderTenantWriter configuration.

Fields inherited from interface io.micronaut.multitenancy.writer.TenantWriter

PREFIX

Constructor Summary

Constructors

Constructor	Description
HttpHeaderTenantWriter(HttpHeaderTenantWriterConfiguration httpHeaderTenantWriterConfiguration)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getHeaderName()
void	writeTenant(io.micronaut.http.MutableHttpRequest<?> request, java.io.Serializable tenant)	Writes the token to the request.

Methods inherited from class java.lang.Object

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

Field Detail

httpHeaderTenantWriterConfiguration

protected final HttpHeaderTenantWriterConfiguration httpHeaderTenantWriterConfiguration

The HttpHeaderTenantWriter configuration.

Constructor Detail

HttpHeaderTenantWriter

public HttpHeaderTenantWriter(HttpHeaderTenantWriterConfiguration httpHeaderTenantWriterConfiguration)

Parameters:

httpHeaderTenantWriterConfiguration - The HttpHeaderTenantWriter configuration

Method Detail

getHeaderName

protected java.lang.String getHeaderName()

Returns:

the HTTP Header name where the token will be written to

writeTenant

public void writeTenant(io.micronaut.http.MutableHttpRequest<?> request,
                        java.io.Serializable tenant)

Writes the token to the request.

Specified by:

writeTenant in interface TenantWriter

Parameters:

request - The MutableHttpRequest instance

tenant - Tenant Id