Module org.refcodes.runtime
Package org.refcodes.runtime

Interface RequestCorrelation<B extends RequestCorrelation<B>>

Type Parameters:
B - The builder to return in order to be able to apply multiple build operations.
public interface RequestCorrelation<B extends RequestCorrelation<B>>
Provides methods to set Request-Correlation behavior: When enabled via setRequestCorrelation(boolean) (or the like), then an existing Request-Correlation-TID might be forwarded by setting it into the Correlation singleton via Correlation.REQUEST's Correlation.setId(String). When being disabled, then no Request-Correlation handling will be done, any existing Correlation.REQUEST's Correlation.getId() may stay untouched!

  • Method Details

    • setRequestCorrelation

      void setRequestCorrelation(boolean hasRequestCorrelation)
      Enables or disables the automatic Request-Correlation mechanism.
      Parameters:
      hasRequestCorrelation - When true then Request-Correlation is enabled, else disabled.

    • withRequestCorrelation

      B withRequestCorrelation(boolean hasRequestCorrelation)
      Builder method for the setRequestCorrelation(boolean) operation.
      Parameters:
      hasRequestCorrelation - When true then Request-Correlation is enabled, else disabled.
      Returns:
      The builder for applying multiple build operations.

    • enableRequestCorrelation

      default void enableRequestCorrelation()
      Enables the automatic Request-Correlation mechanism.

    • withEnableRequestCorrelation

      B withEnableRequestCorrelation()
      Builder method for the enableRequestCorrelation() operation.
      Returns:
      The builder for applying multiple build operations.

    • disableRequestCorrelation

      default void disableRequestCorrelation()
      Disables the automatic Request-Correlation mechanism.

    • withDisableRequestCorrelation

      B withDisableRequestCorrelation()
      Builder method for the disableRequestCorrelation() operation.
      Returns:
      The builder for applying multiple build operations.

    • hasRequestCorrelation

      boolean hasRequestCorrelation()
      Determines whether Request-Correlation is being enabled or disabled.
      Returns:
      True in case Request-Correlation is being enabled, else false.