io.micronaut.multitenancy.writer

Class CookieTenantWriterConfigurationProperties

java.lang.Object

io.micronaut.multitenancy.writer.CookieTenantWriterConfigurationProperties

@ConfigurationProperties(value="micronaut.multitenancy.tenantwriter.cookie")
public class CookieTenantWriterConfigurationProperties
extends Object

ConfigurationProperties implementation of CookieTenantWriterConfiguration.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COOKIENAME The default cookie name.
static String	DEFAULT_COOKIEPATH Default Cookie Path.
static boolean	DEFAULT_ENABLED The default enable value.
static boolean	DEFAULT_HTTPONLY The default http only value.
static boolean	DEFAULT_SECURE The default secure value.
static String	PREFIX

Constructor Summary

Constructors

Constructor and Description
CookieTenantWriterConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
Optional<String>	getCookieDomain() Gets the domain name of this Cookie.
Optional<TemporalAmount>	getCookieMaxAge()
String	getCookiename()
String	getCookieName()
Optional<String>	getCookiePath() The path of the cookie.
Optional<Boolean>	isCookieHttpOnly() Checks to see if this Cookie can only be accessed via HTTP.
Optional<Boolean>	isCookieSecure()
boolean	isEnabled()
void	setCookieDomain(String cookieDomain) Sets the domain name of this Cookie.
void	setCookieHttpOnly(boolean cookieHttpOnly) Whether the Cookie can only be accessed via HTTP.
void	setCookieMaxAge(Duration cookieMaxAge) Sets the maximum age of the cookie.
void	setCookiename(String cookiename) Cookie Name.
void	setCookiePath(String cookiePath) Sets the path of the cookie.
void	setCookieSecure(boolean cookieSecure) Sets whether the cookie is secured.
void	setEnabled(boolean enabled) Enables CookieTenantWriter.

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_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

DEFAULT_SECURE

public static final boolean DEFAULT_SECURE

The default secure value.

See Also:

Constant Field Values

DEFAULT_HTTPONLY

public static final boolean DEFAULT_HTTPONLY

The default http only value.

See Also:

Constant Field Values

DEFAULT_COOKIENAME

public static final String DEFAULT_COOKIENAME

The default cookie name.

See Also:

Constant Field Values

DEFAULT_COOKIEPATH

public static final String DEFAULT_COOKIEPATH

Default Cookie Path.

See Also:

Constant Field Values

Constructor Detail

CookieTenantWriterConfigurationProperties

public CookieTenantWriterConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Returns:

Whether the component is enabled

setEnabled

public void setEnabled(boolean enabled)

Enables CookieTenantWriter. Default value (false).

Parameters:

enabled - enabled flag

setCookiename

public void setCookiename(String cookiename)

Cookie Name. Default value ("tenantId").

Parameters:

cookiename - Cookie name

getCookiename

@Nonnull
public String getCookiename()

Returns:

an HTTP Header name. e.g. Authorization

getCookieName

@Nonnull
public String getCookieName()

Returns:

The name of the cookie

getCookieDomain

public Optional<String> getCookieDomain()

Description copied from interface: CookieConfiguration

Gets the domain name of this Cookie.

Returns:

the domain name of this Cookie

getCookiePath

@Nullable
public Optional<String> getCookiePath()

Description copied from interface: CookieConfiguration

The path of the cookie. The cookie is visible to all paths below the request path on the server.

Returns:

The path of the cookie.

isCookieHttpOnly

public Optional<Boolean> isCookieHttpOnly()

Description copied from interface: CookieConfiguration

Checks to see if this Cookie can only be accessed via HTTP.

Returns:

Whether the Cookie can only be accessed via HTTP.

isCookieSecure

public Optional<Boolean> isCookieSecure()

Returns:

True if the cookie is secure

getCookieMaxAge

public Optional<TemporalAmount> getCookieMaxAge()

Returns:

The max age to use for the cookie

setCookieDomain

public void setCookieDomain(@Nullable
                            String cookieDomain)

Sets the domain name of this Cookie. Default value ("tenantId").

Parameters:

cookieDomain - the domain name of this Cookie

setCookiePath

public void setCookiePath(@Nullable
                          String cookiePath)

Sets the path of the cookie. Default value ("/".

Parameters:

cookiePath - The path of the cookie.

setCookieHttpOnly

public void setCookieHttpOnly(boolean cookieHttpOnly)

Whether the Cookie can only be accessed via HTTP. Default value (true.

Parameters:

cookieHttpOnly - Whether the Cookie can only be accessed via HTTP.

setCookieSecure

public void setCookieSecure(boolean cookieSecure)

Sets whether the cookie is secured. Default value (true.

Parameters:

cookieSecure - True if the cookie is secure

setCookieMaxAge

public void setCookieMaxAge(Duration cookieMaxAge)

Sets the maximum age of the cookie.

Parameters:

cookieMaxAge - The maximum age of the cookie