Package io.quarkiverse.cxf

Interface LoggingConfig.GlobalLoggingConfig

Enclosing interface:
LoggingConfig
public static interface LoggingConfig.GlobalLoggingConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<List<String>>
    binaryContentMediaTypes()
    A comma separated list of additional binary media types to add to the default values in the `LoggingOutInterceptor` and `LoggingInInterceptor` whose content will not be logged unless `log-binary` is `true`.
    @WithConverter(EnabledForConverter.class) EnabledFor
    enabledFor()
    Specifies whether the message logging will be enabled for clients, services, both or none.
    Optional<List<String>>
    inBinaryContentMediaTypes()
    A comma separated list of additional binary media types to add to the default values in the `LoggingInInterceptor` whose content will not be logged unless `log-binary` is `true`.
    long
    inMemThreshold()
    A message length in bytes at which it will be written to disk.
    int
    limit()
    A message length in bytes at which it is truncated in the log.
    boolean
    logBinary()
    If `true`, binary payloads will be logged; otherwise they won't be logged.
    boolean
    logMultipart()
    If `true`, multipart payloads will be logged; otherwise they won't be logged.
    Optional<List<String>>
    outBinaryContentMediaTypes()
    A comma separated list of additional binary media types to add to the default values in the `LoggingOutInterceptor` whose content will not be logged unless `log-binary` is `true`.
    boolean
    pretty()
    If `true`, the XML elements will be indented in the log; otherwise they will appear unindented.
    Optional<Set<String>>
    sensitiveElementNames()
    A comma separated list of XML elements containing sensitive information to be masked in the log.
    Optional<Set<String>>
    sensitiveProtocolHeaderNames()
    A comma separated list of protocol headers containing sensitive information to be masked in the log.
    boolean
    verbose()
    If `true`, verbose logging will be enabled; otherwise it won't be enabled.

  • Method Details

    • enabledFor

      @WithDefault("none") @WithConverter(EnabledForConverter.class) @WithConverter(EnabledForConverter.class) EnabledFor enabledFor()
      Specifies whether the message logging will be enabled for clients, services, both or none. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-enabled[quarkus.cxf.endpoint."/endpoint-path".logging.enabled]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-enabled[quarkus.cxf.client."client-name".logging.enabled]` respectively.
      Since:
      2.6.0

    • pretty

      @WithDefault("false") boolean pretty()
      If `true`, the XML elements will be indented in the log; otherwise they will appear unindented. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-pretty[quarkus.cxf.endpoint."/endpoint-path".logging.pretty]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-pretty[quarkus.cxf.client."client-name".logging.pretty]` respectively.
      Since:
      2.6.0

    • limit

      @WithDefault("49152") int limit()
      A message length in bytes at which it is truncated in the log. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-limit[quarkus.cxf.endpoint."/endpoint-path".logging.limit]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-limit[quarkus.cxf.client."client-name".logging.limit]` respectively.
      Since:
      2.6.0

    • inMemThreshold

      @WithDefault("-1") long inMemThreshold()
      A message length in bytes at which it will be written to disk. `-1` is unlimited. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-in-mem-threshold[quarkus.cxf.endpoint."/endpoint-path".logging.in-mem-threshold]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-in-mem-threshold[quarkus.cxf.client."client-name".logging.in-mem-threshold]` respectively.
      Since:
      2.6.0

    • logBinary

      @WithDefault("false") boolean logBinary()
      If `true`, binary payloads will be logged; otherwise they won't be logged. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-log-binary[quarkus.cxf.endpoint."/endpoint-path".logging.log-binary]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-log-binary[quarkus.cxf.client."client-name".logging.log-binary]` respectively.
      Since:
      2.6.0

    • logMultipart

      @WithDefault("true") boolean logMultipart()
      If `true`, multipart payloads will be logged; otherwise they won't be logged. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-log-multipart[quarkus.cxf.endpoint."/endpoint-path".logging.log-multipart]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-log-multipart[quarkus.cxf.client."client-name".logging.log-multipart]` respectively.
      Since:
      2.6.0

    • verbose

      @WithDefault("true") boolean verbose()
      If `true`, verbose logging will be enabled; otherwise it won't be enabled. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-verbose[quarkus.cxf.endpoint."/endpoint-path".logging.verbose]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-verbose[quarkus.cxf.client."client-name".logging.verbose]` respectively.
      Since:
      2.6.0

    • inBinaryContentMediaTypes

      Optional<List<String>> inBinaryContentMediaTypes()
      A comma separated list of additional binary media types to add to the default values in the `LoggingInInterceptor` whose content will not be logged unless `log-binary` is `true`. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-in-binary-content-media-types[quarkus.cxf.endpoint."/endpoint-path".logging.in-binary-content-media-types]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-in-binary-content-media-types[quarkus.cxf.client."client-name".logging.in-binary-content-media-types]` respectively.
      Since:
      2.6.0

    • outBinaryContentMediaTypes

      Optional<List<String>> outBinaryContentMediaTypes()
      A comma separated list of additional binary media types to add to the default values in the `LoggingOutInterceptor` whose content will not be logged unless `log-binary` is `true`. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-out-binary-content-media-types[quarkus.cxf.endpoint."/endpoint-path".logging.out-binary-content-media-types]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-out-binary-content-media-types[quarkus.cxf.client."client-name".logging.out-binary-content-media-types]` respectively.
      Since:
      2.6.0

    • binaryContentMediaTypes

      Optional<List<String>> binaryContentMediaTypes()
      A comma separated list of additional binary media types to add to the default values in the `LoggingOutInterceptor` and `LoggingInInterceptor` whose content will not be logged unless `log-binary` is `true`. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-binary-content-media-types[quarkus.cxf.endpoint."/endpoint-path".logging.binary-content-media-types]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-binary-content-media-types[quarkus.cxf.client."client-name".logging.binary-content-media-types]` respectively.
      Since:
      2.6.0

    • sensitiveElementNames

      Optional<Set<String>> sensitiveElementNames()
      A comma separated list of XML elements containing sensitive information to be masked in the log. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-sensitive-element-names[quarkus.cxf.endpoint."/endpoint-path".logging.sensitive-element-names]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-sensitive-element-names[quarkus.cxf.client."client-name".logging.sensitive-element-names]` respectively.
      Since:
      2.6.0

    • sensitiveProtocolHeaderNames

      Optional<Set<String>> sensitiveProtocolHeaderNames()
      A comma separated list of protocol headers containing sensitive information to be masked in the log. This setting can be overridden per client or service endpoint using `xref:#quarkus-cxf_quarkus-cxf-endpoint-endpoint-path-logging-sensitive-protocol-header-names[quarkus.cxf.endpoint."/endpoint-path".logging.sensitive-protocol-header-names]` or `xref:#quarkus-cxf_quarkus-cxf-client-client-name-logging-sensitive-protocol-header-names[quarkus.cxf.client."client-name".logging.sensitive-protocol-header-names]` respectively.
      Since:
      2.6.0