Class SerializationProperties

java.lang.Object
com.vaadin.kubernetes.starter.SerializationProperties

@ConfigurationProperties(prefix="vaadin.serialization") public class SerializationProperties extends Object
Definition of configuration properties for Session serialization.
Since:
1.0
Author:
Vaadin Ltd
  • Field Details

    • PREFIX

      public static final String PREFIX
      See Also:
    • DEFAULT_SERIALIZATION_TIMEOUT_MS

      public static final int DEFAULT_SERIALIZATION_TIMEOUT_MS
      See Also:
    • DEFAULT_DESERIALIZATION_LOCK_TIMEOUT_MS

      public static final int DEFAULT_DESERIALIZATION_LOCK_TIMEOUT_MS
      See Also:
    • DEFAULT_OPTIMISTIC_SERIALIZATION_TIMEOUT_MS

      public static final int DEFAULT_OPTIMISTIC_SERIALIZATION_TIMEOUT_MS
      See Also:
    • DEFAULT_OPTIMISTIC_SERIALIZATION_DELAY_MS

      public static final int DEFAULT_OPTIMISTIC_SERIALIZATION_DELAY_MS
      See Also:
  • Constructor Details

    • SerializationProperties

      public SerializationProperties()
  • Method Details

    • getTimeout

      public int getTimeout()
      Gets the timeout in milliseconds to wait for the serialization to be completed.
      Returns:
      the timeout in milliseconds to wait for the serialization to be completed, defaults to 30000 ms
    • setTimeout

      public void setTimeout(int timeout)
      Sets the timeout in milliseconds to wait for the serialization to be completed.
      Parameters:
      timeout - the timeout in milliseconds to wait for the serialization to be completed, defaults to 30000 ms
    • getDeserializationLockTimeout

      public int getDeserializationLockTimeout()
      Gets the timeout in milliseconds to wait for the deserialization lock to be released if the deserialization is not completed.
      Returns:
      the timeout in milliseconds to wait for the deserialization to be completed, defaults to 10000 ms
    • setDeserializationLockTimeout

      public void setDeserializationLockTimeout(int timeout)
      Sets the timeout in milliseconds to wait for the deserialization lock to be released if the deserialization is not completed.
      Parameters:
      timeout - the timeout in milliseconds to wait for the deserialization to be completed, defaults to 10000 ms
    • getOptimisticTimeout

      public int getOptimisticTimeout()
      Gets the timeout in milliseconds to wait for the optimistic serialization to be completed.

      0 or negative value means that the optimistic serialization is disabled and only the pessimistic serialization is performed. Pessimistic serialization locks the Vaadin session during the serialization process. Disabling the optimistic serialization may affect the UI performance.

      Returns:
      the timeout in milliseconds to wait for the optimistic serialization to be completed, defaults to 30000 ms
    • setOptimisticTimeout

      public void setOptimisticTimeout(int optimisticTimeout)
      Sets the timeout in milliseconds to wait for the optimistic serialization to be completed.

      0 or negative value means that the optimistic serialization is disabled and only the pessimistic serialization is performed. Pessimistic serialization locks the Vaadin session during the serialization process. Disabling the optimistic serialization may affect the UI performance.

      Parameters:
      optimisticTimeout - the timeout in milliseconds to wait for the optimistic serialization to be completed, defaults to 30000 ms
    • getOptimisticDelay

      public int getOptimisticDelay()
      Gets the delay in milliseconds to wait between optimistic serialization attempts.

      A value of 0 or negative means no delay is applied between attempts. Note that disabling the delay may increase CPU usage significantly.

      Returns:
      the delay in milliseconds between optimistic serialization attempts (default: 10)
    • setOptimisticDelay

      public void setOptimisticDelay(int delay)
      Sets the delay in milliseconds to wait between optimistic serialization attempts.

      A value of 0 or negative means no delay is applied between attempts. Note that disabling the delay may increase CPU usage significantly.

      Parameters:
      delay - the delay in milliseconds between optimistic serialization attempts (default: 10)
    • getTransients

      public com.vaadin.kubernetes.starter.SerializationProperties.TransientsProperties getTransients()
      Gets configuration for transient fields handling during serialization.
      Returns:
      configuration for transient fields handling.