Package com.vaadin.kubernetes.starter

Class KubernetesKitProperties

java.lang.Object
com.vaadin.kubernetes.starter.KubernetesKitProperties
@ConfigurationProperties(prefix="vaadin.kubernetes") public class KubernetesKitProperties extends Object
Definition of configuration properties for the Kubernetes Kit starter.
Since:
1.0
Author:
Vaadin Ltd

  • Field Details

  • Constructor Details

    • KubernetesKitProperties

      public KubernetesKitProperties()

  • Method Details

    • isAutoConfigure

      public boolean isAutoConfigure()
      Checks if auto-configuration of Kubernetes Kit is enabled.
      Returns:
      true, if auto-configuration is enabled

    • setAutoConfigure

      public void setAutoConfigure(boolean autoConfigure)
      Enables or disables auto-configuration of KubernetesKitConfiguration.
      Parameters:
      autoConfigure - true to enable auto-configuration, false to disable

    • setBackendSessionExpirationTolerance

      public void setBackendSessionExpirationTolerance(Duration backendSessionExpirationTolerance)
      Sets the amount of time to be added to the HTTP session timeout to determine the expiration of the backend session.

    • getBackendSessionExpirationTolerance

      public Duration getBackendSessionExpirationTolerance()
      Gets the amount of time to be added to the HTTP session timeout to determine the expiration of the backend session.

    • getClusterKeyCookieName

      public String getClusterKeyCookieName()
      Gets the name of the distributed storage session key cookie.
      Returns:
      the name of the distributed storage session key cookie

    • setClusterKeyCookieName

      public void setClusterKeyCookieName(String clusterKeyCookieName)
      Sets the name of the distributed storage session key cookie.
      Parameters:
      clusterKeyCookieName - the name of the distributed storage session key cookie

    • getClusterKeyCookieSameSite

      public SameSite getClusterKeyCookieSameSite()
      Gets the distributed storage session key cookie's SameSite attribute value.
      Returns:
      the distributed storage session key cookie's SameSite attribute value

    • setClusterKeyCookieSameSite

      public void setClusterKeyCookieSameSite(SameSite sameSite)
      Sets the distributed storage session key cookie's SameSite attribute.
      Parameters:
      sameSite - value of the distributed storage session key cookie's SameSite attribute

    • isRollingUpdates

      public boolean isRollingUpdates()
      Checks if rolling update support is enabled.
      Returns:
      true if rolling update support is enabled
      See Also:

    • setRollingUpdates

      public void setRollingUpdates(boolean rollingUpdates)
      Enables or disables rolling update support.
      Parameters:
      rollingUpdates - true to enable, false to disable
      See Also:

    • getUpdateVersionHeaderName

      public String getUpdateVersionHeaderName()
      Gets the name of the HTTP request header used to detect a new application version during rolling updates.
      Returns:
      the update version header name
      See Also:
      • updateVersionHeaderName

    • setUpdateVersionHeaderName

      public void setUpdateVersionHeaderName(String updateVersionHeaderName)
      Sets the name of the HTTP request header used to detect a new application version during rolling updates.
      Parameters:
      updateVersionHeaderName - the update version header name
      See Also:
      • updateVersionHeaderName

    • getAppVersion

      public String getAppVersion()
      Gets the application version used during rolling updates.
      Returns:
      the application version, or null if not set
      See Also:
      • appVersion

    • setAppVersion

      public void setAppVersion(String appVersion)
      Sets the application version used during rolling updates.
      Parameters:
      appVersion - the application version
      See Also:
      • appVersion

    • getStickySessionCookieNames

      public List<String> getStickySessionCookieNames()
      Gets the names of the cookies used by the ingress controller or gateway implementation for sticky sessions.
      Returns:
      the sticky session cookie names
      See Also:
      • stickySessionCookieNames

    • getStickySessionCookieName

      @Deprecated(since="3.1", forRemoval=true) @DeprecatedConfigurationProperty(since="3.1", replacement="vaadin.kubernetes.sticky-session-cookie-names", reason="Replaced by vaadin.kubernetes.sticky-session-cookie-names which accepts a list of cookie names.") public String getStickySessionCookieName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getStickySessionCookieNames() instead to get all configured cookie names.
      Gets the name of the cookie used by the ingress controller or gateway implementation for sticky sessions.
      Returns:
      the first sticky session cookie name, or null if none configured
      See Also:
      • stickySessionCookieNames

    • setStickySessionCookieNames

      public void setStickySessionCookieNames(List<String> stickySessionCookieName)
      Sets the names of the cookies used by the ingress controller or gateway implementation for sticky sessions.
      Parameters:
      stickySessionCookieName - the sticky session cookie names
      See Also:
      • stickySessionCookieNames

    • setStickySessionCookieName

      @Deprecated(since="3.1", forRemoval=true) public void setStickySessionCookieName(String stickySessionCookieName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use setStickySessionCookieNames(List) instead to support multiple cookie names.
      Sets the name of the cookie used by the ingress controller or gateway implementation for sticky sessions.
      Parameters:
      stickySessionCookieName - the sticky session cookie name
      See Also:
      • stickySessionCookieNames