io.micronaut.multitenancy.writer

Class CookieTenantWriterConfigurationProperties

java.lang.Object

io.micronaut.multitenancy.writer.CookieTenantWriterConfigurationProperties

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

ConfigurationProperties implementation of CookieTenantWriterConfiguration.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_COOKIENAME The default cookie name.
static java.lang.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 java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
CookieTenantWriterConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getCookieDomain() Gets the domain name of this Cookie.
java.util.Optional<java.time.temporal.TemporalAmount>	getCookieMaxAge()
java.lang.String	getCookiename()
java.lang.String	getCookieName()
java.util.Optional<java.lang.String>	getCookiePath() The path of the cookie.
java.util.Optional<SameSite>	getCookieSameSite()
java.util.Optional<java.lang.Boolean>	isCookieHttpOnly() Checks to see if this Cookie can only be accessed via HTTP.
java.util.Optional<java.lang.Boolean>	isCookieSecure()
boolean	isEnabled()
void	setCookieDomain(java.lang.String cookieDomain) Sets the domain name of this Cookie.
void	setCookieHttpOnly(boolean cookieHttpOnly) Whether the Cookie can only be accessed via HTTP.
void	setCookieMaxAge(java.time.temporal.TemporalAmount cookieMaxAge) Sets the maximum age of the cookie.
void	setCookiename(java.lang.String cookiename) Cookie Name.
void	setCookiePath(java.lang.String cookiePath) Sets the path of the cookie.
void	setCookieSameSite(SameSite sameSite) Determines if this this Cookie can be sent along cross-site requests.
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 java.lang.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 java.lang.String DEFAULT_COOKIENAME

The default cookie name.

See Also:

Constant Field Values

DEFAULT_COOKIEPATH

public static final java.lang.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(java.lang.String cookiename)

Cookie Name. Default value ("tenantId").

Parameters:

cookiename - Cookie name

getCookiename

@NonNull
public java.lang.String getCookiename()

Returns:

an HTTP Header name. e.g. Authorization

getCookieName

@NonNull
public java.lang.String getCookieName()

Returns:

The name of the cookie

getCookieDomain

public java.util.Optional<java.lang.String> getCookieDomain()

Description copied from interface: CookieConfiguration

Gets the domain name of this Cookie.

Returns:

the domain name of this Cookie

getCookiePath

@Nullable
public java.util.Optional<java.lang.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 java.util.Optional<java.lang.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 java.util.Optional<java.lang.Boolean> isCookieSecure()

Returns:

True if the cookie is secure

getCookieMaxAge

public java.util.Optional<java.time.temporal.TemporalAmount> getCookieMaxAge()

Returns:

The max age to use for the cookie

setCookieDomain

public void setCookieDomain(@Nullable
                            java.lang.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
                          java.lang.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(java.time.temporal.TemporalAmount cookieMaxAge)

Sets the maximum age of the cookie.

Parameters:

cookieMaxAge - The maximum age of the cookie

getCookieSameSite

public java.util.Optional<SameSite> getCookieSameSite()

Returns:

return the SameSite to use for the cookie.

setCookieSameSite

public void setCookieSameSite(SameSite sameSite)

Determines if this this Cookie can be sent along cross-site requests. For more information, please look here

Parameters:

sameSite - SameSite value