Package io.quarkiverse.cxf

Interface CxfConfig.RetransmitCacheConfig

Enclosing interface:
CxfConfig
public static interface CxfConfig.RetransmitCacheConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    directory()
    A directory where request bodies exceeding `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-retransmit-cache-threshold[quarkus.cxf.retransmit-cache.threshold]` will be be stored for retransmission.
    @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration
    gcDelay()
    A delay for periodic cleaning of stale temporary files in the xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-retransmit-cache-directory[retransmit cache directory].
    boolean
    gcOnShutDown()
    If `true` and if periodic cleaning of stale temporary files is enabled via `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-retransmit-cache-gc-delay[quarkus.cxf.retransmit-cache.gc-delay]` then temporary files will be removed on application shutdown.
    @WithConverter(io.quarkus.runtime.configuration.MemorySizeConverter.class) Optional<io.quarkus.runtime.configuration.MemorySize>
    maxSize()
    The maximum size of a request body allowed to be cached on disk when retransmitting.
    @WithConverter(io.quarkus.runtime.configuration.MemorySizeConverter.class) io.quarkus.runtime.configuration.MemorySize
    threshold()
    If the request retransmission is active for the given client and if request body is larger than this threshold, then the body is cached on disk instead of keeping it in memory.

  • Method Details

    • threshold

      @WithDefault("128K") @WithConverter(io.quarkus.runtime.configuration.MemorySizeConverter.class) @WithConverter(io.quarkus.runtime.configuration.MemorySizeConverter.class) io.quarkus.runtime.configuration.MemorySize threshold()
      If the request retransmission is active for the given client and if request body is larger than this threshold, then the body is cached on disk instead of keeping it in memory. In plain CXF, this is equivalent to setting the `bus.io.CachedOutputStream.Threshold` property on CXF Bus. See also: * `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-auto-redirect[quarkus.cxf.client."client-name".auto-redirect]`
      Since:
      3.18.0

    • maxSize

      @WithConverter(io.quarkus.runtime.configuration.MemorySizeConverter.class) @WithConverter(io.quarkus.runtime.configuration.MemorySizeConverter.class) Optional<io.quarkus.runtime.configuration.MemorySize> maxSize()
      The maximum size of a request body allowed to be cached on disk when retransmitting. If not set, no limit will be enforced. If set and the limit is exceeded, an exception will be thrown and therefore the request will neither be sent nor redirected. In plain CXF, this is equivalent to setting the `bus.io.CachedOutputStream.MaxSize` property on CXF Bus. See also: * `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-auto-redirect[quarkus.cxf.client."client-name".auto-redirect]` * `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-retransmit-cache-threshold[quarkus.cxf.retransmit-cache.threshold]`
      Since:
      3.18.0

    • directory

      Optional<String> directory()
      A directory where request bodies exceeding `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-retransmit-cache-threshold[quarkus.cxf.retransmit-cache.threshold]` will be be stored for retransmission. If specified, the directory must exist on application startup. If not specified, the system temporary directory will be used. In plain CXF, this is equivalent to setting the `bus.io.CachedOutputStream.OutputDirectory` property on CXF Bus. See also: * `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-auto-redirect[quarkus.cxf.client."client-name".auto-redirect]` * `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-retransmit-cache-threshold[quarkus.cxf.retransmit-cache.threshold]`
      Since:
      3.18.0

    • gcDelay

      @WithDefault("30m") @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) @WithConverter(io.quarkus.runtime.configuration.DurationConverter.class) Duration gcDelay()
      A delay for periodic cleaning of stale temporary files in the xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-retransmit-cache-directory[retransmit cache directory]. Those temporary files are normally removed upon receiving a non-redirect response. The periodic garbage collection is a fallback mechanism for exceptional conditions. The minimum value is 2 seconds. If the value of the delay is set to 0, the garbage collection of stale temporary files will be deactivated. In plain CXF, this is equivalent to setting the `bus.io.CachedOutputStreamCleaner.Delay` property on CXF Bus. See also: * `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-auto-redirect[quarkus.cxf.client."client-name".auto-redirect]`
      Since:
      3.18.0

    • gcOnShutDown

      @WithDefault("true") boolean gcOnShutDown()
      If `true` and if periodic cleaning of stale temporary files is enabled via `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-retransmit-cache-gc-delay[quarkus.cxf.retransmit-cache.gc-delay]` then temporary files will be removed on application shutdown. Otherwise the stale temporary files in the xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-retransmit-cache-directory[retransmit cache directory] will not be removed on on application shutdown. In plain CXF, this is equivalent to setting the `bus.io.CachedOutputStreamCleaner.CleanOnShutdown` property on CXF Bus. See also: * `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-auto-redirect[quarkus.cxf.client."client-name".auto-redirect]`
      Since:
      3.18.0