diff --git a/docs/modules/ROOT/examples/ws-trust/application.properties b/docs/modules/ROOT/examples/ws-trust/application.properties index 561301311..ab6093d09 100644 --- a/docs/modules/ROOT/examples/ws-trust/application.properties +++ b/docs/modules/ROOT/examples/ws-trust/application.properties @@ -1,7 +1,7 @@ # STS # tag::ws-trust-usage.adoc-sts-properties[] quarkus.cxf.endpoint."/sts".implementor = io.quarkiverse.cxf.it.ws.trust.sts.Sts -quarkus.cxf.endpoint."/sts".logging.enabled = true +quarkus.cxf.endpoint."/sts".logging.enabled = pretty quarkus.cxf.endpoint."/sts".security.signature.username = sts quarkus.cxf.endpoint."/sts".security.signature.password = password @@ -16,7 +16,7 @@ quarkus.cxf.endpoint."/sts".security.signature.properties."org.apache.ws.securit # hello-ws-trust # tag::ws-trust-usage.adoc-service-properties[] quarkus.cxf.endpoint."/hello-ws-trust".implementor = io.quarkiverse.cxf.it.ws.trust.server.TrustHelloServiceImpl -quarkus.cxf.endpoint."/hello-ws-trust".logging.enabled = true +quarkus.cxf.endpoint."/hello-ws-trust".logging.enabled = pretty quarkus.cxf.endpoint."/hello-ws-trust".security.signature.username = service quarkus.cxf.endpoint."/hello-ws-trust".security.signature.password = password diff --git a/docs/modules/ROOT/pages/includes/quarkus-cxf-integration-tracing-opentelemetry.adoc b/docs/modules/ROOT/pages/includes/quarkus-cxf-integration-tracing-opentelemetry.adoc deleted file mode 100644 index 12a421cd1..000000000 --- a/docs/modules/ROOT/pages/includes/quarkus-cxf-integration-tracing-opentelemetry.adoc +++ /dev/null @@ -1,64 +0,0 @@ - -:summaryTableId: quarkus-cxf-integration-tracing-opentelemetry -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference.searchable, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-cxf-integration-tracing-opentelemetry_configuration]]link:#quarkus-cxf-integration-tracing-opentelemetry_configuration[Configuration property] - -h|Type -h|Default - -a| [[quarkus-cxf-integration-tracing-opentelemetry_quarkus-cxf-otel-enabled-for]]`link:#quarkus-cxf-integration-tracing-opentelemetry_quarkus-cxf-otel-enabled-for[quarkus.cxf.otel.enabled-for]` - - -[.description] --- -Specifies whether the OpenTelemetry tracing will be enabled for clients, services, both or none. This global setting can be overridden per client or service endpoint using the `quarkus.cxf.client."clients".otel.enabled` or `quarkus.cxf.endpoint."endpoints".otel.enabled` option respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_OTEL_ENABLED_FOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_OTEL_ENABLED_FOR+++` -endif::add-copy-button-to-env-var[] --- a| -`clients`, `services`, `both`, `none` -|`both` - - -a| [[quarkus-cxf-integration-tracing-opentelemetry_quarkus-cxf-client-clients-otel-enabled]]`link:#quarkus-cxf-integration-tracing-opentelemetry_quarkus-cxf-client-clients-otel-enabled[quarkus.cxf.client."clients".otel.enabled]` - - -[.description] --- -If `true` and if `quarkus.cxf.otel.enabled-for` is set to `both` or `clients` then the `OpenTelemetryClientFeature` will be added to this client; otherwise the feature will not be added to this client. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__OTEL_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__OTEL_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-integration-tracing-opentelemetry_quarkus-cxf-endpoint-endpoints-otel-enabled]]`link:#quarkus-cxf-integration-tracing-opentelemetry_quarkus-cxf-endpoint-endpoints-otel-enabled[quarkus.cxf.endpoint."endpoints".otel.enabled]` - - -[.description] --- -If `true` and if `quarkus.cxf.otel.enabled-for` is set to `both` or `services` then the `OpenTelemetryFeature` will be added to this service endpoint; otherwise the feature will not be added to this service endpoint. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__OTEL_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__OTEL_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - -|=== \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-cxf-rt-features-metrics.adoc b/docs/modules/ROOT/pages/includes/quarkus-cxf-rt-features-metrics.adoc deleted file mode 100644 index f54e2dbb5..000000000 --- a/docs/modules/ROOT/pages/includes/quarkus-cxf-rt-features-metrics.adoc +++ /dev/null @@ -1,64 +0,0 @@ - -:summaryTableId: quarkus-cxf-rt-features-metrics -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference.searchable, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-cxf-rt-features-metrics_configuration]]link:#quarkus-cxf-rt-features-metrics_configuration[Configuration property] - -h|Type -h|Default - -a| [[quarkus-cxf-rt-features-metrics_quarkus-cxf-metrics-enabled-for]]`link:#quarkus-cxf-rt-features-metrics_quarkus-cxf-metrics-enabled-for[quarkus.cxf.metrics.enabled-for]` - - -[.description] --- -Specifies whether the metrics collection will be enabled for clients, services, both or none. This global setting can be overridden per client or service endpoint using the `quarkus.cxf.client."clients".metrics.enabled` or `quarkus.cxf.endpoint."endpoints".metrics.enabled` option respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_METRICS_ENABLED_FOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_METRICS_ENABLED_FOR+++` -endif::add-copy-button-to-env-var[] --- a| -`clients`, `services`, `both`, `none` -|`both` - - -a| [[quarkus-cxf-rt-features-metrics_quarkus-cxf-client-clients-metrics-enabled]]`link:#quarkus-cxf-rt-features-metrics_quarkus-cxf-client-clients-metrics-enabled[quarkus.cxf.client."clients".metrics.enabled]` - - -[.description] --- -If `true` and if `quarkus.cxf.metrics.enabled-for` is set to `both` or `clients` then the `MetricsFeature` will be added to this client; otherwise the feature will not be added to this client. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__METRICS_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__METRICS_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-features-metrics_quarkus-cxf-endpoint-endpoints-metrics-enabled]]`link:#quarkus-cxf-rt-features-metrics_quarkus-cxf-endpoint-endpoints-metrics-enabled[quarkus.cxf.endpoint."endpoints".metrics.enabled]` - - -[.description] --- -If `true` and if `quarkus.cxf.metrics.enabled-for` is set to `both` or `services` then the `MetricsFeature` will be added to this service endpoint; otherwise the feature will not be added to this service endpoint. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__METRICS_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__METRICS_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - -|=== \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-cxf-rt-ws-rm.adoc b/docs/modules/ROOT/pages/includes/quarkus-cxf-rt-ws-rm.adoc deleted file mode 100644 index 1f1f89979..000000000 --- a/docs/modules/ROOT/pages/includes/quarkus-cxf-rt-ws-rm.adoc +++ /dev/null @@ -1,180 +0,0 @@ - -:summaryTableId: quarkus-cxf-rt-ws-rm -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference.searchable, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-cxf-rt-ws-rm_configuration]]link:#quarkus-cxf-rt-ws-rm_configuration[Configuration property] - -h|Type -h|Default - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-namespace]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-namespace[quarkus.cxf.rm.namespace]` - - -[.description] --- -WS-RM version namespace: `http://schemas.xmlsoap.org/ws/2005/02/rm/` or `http://docs.oasis-open.org/ws-rx/wsrm/200702` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_RM_NAMESPACE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_RM_NAMESPACE+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://schemas.xmlsoap.org/ws/2005/02/rm` - - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-wsa-namespace]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-wsa-namespace[quarkus.cxf.rm.wsa-namespace]` - - -[.description] --- -WS-Addressing version namespace: `http://schemas.xmlsoap.org/ws/2004/08/addressing` or `http://www.w3.org/2005/08/addressing`. Note that this property is ignored unless you are using the `http://schemas.xmlsoap.org/ws/2005/02/rm/` RM namespace. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_RM_WSA_NAMESPACE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_RM_WSA_NAMESPACE+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://schemas.xmlsoap.org/ws/2004/08/addressing` - - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-inactivity-timeout]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-inactivity-timeout[quarkus.cxf.rm.inactivity-timeout]` - - -[.description] --- -A time duration in milliseconds after which the associated sequence will be closed if no messages (including acknowledgments and other control messages) were exchanged between the sender and receiver during that period of time. If not set, the associated sequence will never be closed due to inactivity. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_RM_INACTIVITY_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_RM_INACTIVITY_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|long -| - - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-retransmission-interval]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-retransmission-interval[quarkus.cxf.rm.retransmission-interval]` - - -[.description] --- -A time duration in milliseconds between successive attempts to resend a message that has not been acknowledged by the receiver. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_RM_RETRANSMISSION_INTERVAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_RM_RETRANSMISSION_INTERVAL+++` -endif::add-copy-button-to-env-var[] ---|long -|`3000` - - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-exponential-backoff]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-exponential-backoff[quarkus.cxf.rm.exponential-backoff]` - - -[.description] --- -If `true` the retransmission interval will be doubled on every transmission attempt; otherwise the retransmission interval stays equal to `quarkus.cxf.rm.retransmission-interval` for every retransmission attempt. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_RM_EXPONENTIAL_BACKOFF+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_RM_EXPONENTIAL_BACKOFF+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-acknowledgement-interval]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-acknowledgement-interval[quarkus.cxf.rm.acknowledgement-interval]` - - -[.description] --- -A time duration in milliseconds within which an acknowledgement for a received message is expected to be sent by a RM destination. If not specified, the acknowledgements will be sent immediately. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_RM_ACKNOWLEDGEMENT_INTERVAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_RM_ACKNOWLEDGEMENT_INTERVAL+++` -endif::add-copy-button-to-env-var[] ---|long -| - - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-store]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-store[quarkus.cxf.rm.store]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.cxf.ws.rm.persistence.RMStore` bean used to store source and destination sequences and message references. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_RM_STORE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_RM_STORE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-feature-ref]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-rm-feature-ref[quarkus.cxf.rm.feature-ref]` - - -[.description] --- -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_RM_FEATURE_REF+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_RM_FEATURE_REF+++` -endif::add-copy-button-to-env-var[] ---|string -|`#defaultRmFeature` - - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-client-clients-rm-enabled]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-client-clients-rm-enabled[quarkus.cxf.client."clients".rm.enabled]` - - -[.description] --- -If `true` then the WS-ReliableMessaging link:https://cxf.apache.org/docs/ws-reliablemessaging.html[interceptors] will be added to this client or service endpoint. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__RM_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__RM_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-rm_quarkus-cxf-endpoint-endpoints-rm-enabled]]`link:#quarkus-cxf-rt-ws-rm_quarkus-cxf-endpoint-endpoints-rm-enabled[quarkus.cxf.endpoint."endpoints".rm.enabled]` - - -[.description] --- -If `true` then the WS-ReliableMessaging link:https://cxf.apache.org/docs/ws-reliablemessaging.html[interceptors] will be added to this client or service endpoint. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__RM_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__RM_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - -|=== \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-cxf-rt-ws-security.adoc b/docs/modules/ROOT/pages/includes/quarkus-cxf-rt-ws-security.adoc deleted file mode 100644 index 5ca969a82..000000000 --- a/docs/modules/ROOT/pages/includes/quarkus-cxf-rt-ws-security.adoc +++ /dev/null @@ -1,2626 +0,0 @@ - -:summaryTableId: quarkus-cxf-rt-ws-security -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference.searchable, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-cxf-rt-ws-security_configuration]]link:#quarkus-cxf-rt-ws-security_configuration[Configuration property] - -h|Type -h|Default - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-username]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-username[quarkus.cxf.client."clients".security.username]` - - -[.description] --- -The user's name. It is used as follows: - - - As the name in the UsernameToken for WS-Security - - As the alias name in the keystore to get the user's cert and private key for signature if `signature.username` is not set - - As the alias name in the keystore to get the user's public key for encryption if `encryption.username` is not set - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-password]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-password[quarkus.cxf.client."clients".security.password]` - - -[.description] --- -The user's password when a `callback-handler` is not defined. This is only used for the password in a WS-Security UsernameToken. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-signature-username]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-signature-username[quarkus.cxf.client."clients".security.signature.username]` - - -[.description] --- -The user's name for signature. It is used as the alias name in the keystore to get the user's cert and private key for signature. If this is not defined, then `username` is used instead. If that is also not specified, it uses the the default alias set in the properties file referenced by `signature.properties`. If that's also not set, and the keystore only contains a single key, that key will be used. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SIGNATURE_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SIGNATURE_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-signature-password]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-signature-password[quarkus.cxf.client."clients".security.signature.password]` - - -[.description] --- -The user's password for signature when a `callback-handler` is not defined. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SIGNATURE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SIGNATURE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-encryption-username]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-encryption-username[quarkus.cxf.client."clients".security.encryption.username]` - - -[.description] --- -The user's name for encryption. It is used as the alias name in the keystore to get the user's public key for encryption. If this is not defined, then `username` is used instead. If that is also not specified, it uses the the default alias set in the properties file referenced by `encrypt.properties`. If that's also not set, and the keystore only contains a single key, that key will be used. - -For the WS-Security web service provider, the `useReqSigCert` value can be used to accept (encrypt to) any client whose public key is in the service's truststore (defined in `encrypt.properties`). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENCRYPTION_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENCRYPTION_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-callback-handler]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-callback-handler[quarkus.cxf.client."clients".security.callback-handler]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `javax.security.auth.callback.CallbackHandler` bean used to obtain passwords, for both outbound and inbound requests. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_CALLBACK_HANDLER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_CALLBACK_HANDLER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-saml-callback-handler]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-saml-callback-handler[quarkus.cxf.client."clients".security.saml-callback-handler]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `javax.security.auth.callback.CallbackHandler` implementation used to construct SAML Assertions. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SAML_CALLBACK_HANDLER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SAML_CALLBACK_HANDLER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-signature-properties-signature-properties]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-signature-properties-signature-properties[quarkus.cxf.client."clients".security.signature.properties]` - - -[.description] --- -The Crypto property configuration to use for signing, if `signature.crypto` is not set. - -Example - -``` -[prefix].signature.properties."org.apache.ws.security.crypto.provider" = org.apache.ws.security.components.crypto.Merlin -[prefix].signature.properties."org.apache.ws.security.crypto.merlin.keystore.password" = password -[prefix].signature.properties."org.apache.ws.security.crypto.merlin.file" = certs/alice.jks -``` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SIGNATURE_PROPERTIES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SIGNATURE_PROPERTIES+++` -endif::add-copy-button-to-env-var[] ---|`Map` -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-encryption-properties-encryption-properties]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-encryption-properties-encryption-properties[quarkus.cxf.client."clients".security.encryption.properties]` - - -[.description] --- -The Crypto property configuration to use for encryption, if `encryption.crypto` is not set. - -Example - -``` -[prefix].encryption.properties."org.apache.ws.security.crypto.provider" = org.apache.ws.security.components.crypto.Merlin -[prefix].encryption.properties."org.apache.ws.security.crypto.merlin.keystore.password" = password -[prefix].encryption.properties."org.apache.ws.security.crypto.merlin.file" = certs/alice.jks -``` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENCRYPTION_PROPERTIES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENCRYPTION_PROPERTIES+++` -endif::add-copy-button-to-env-var[] ---|`Map` -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-signature-crypto]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-signature-crypto[quarkus.cxf.client."clients".security.signature.crypto]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` bean to be used for signature. If not set, `signature.properties` will be used to configure a `Crypto` instance. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SIGNATURE_CRYPTO+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SIGNATURE_CRYPTO+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-encryption-crypto]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-encryption-crypto[quarkus.cxf.client."clients".security.encryption.crypto]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for encryption. If not set, `encryption.properties` will be used to configure a `Crypto` instance. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENCRYPTION_CRYPTO+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENCRYPTION_CRYPTO+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-encryption-certificate]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-encryption-certificate[quarkus.cxf.client."clients".security.encryption.certificate]` - - -[.description] --- -A message property for prepared X509 certificate to be used for encryption. If this is not defined, then the certificate will be either loaded from the keystore `encryption.properties` or extracted from request (when WS-Security is used and if `encryption.username` has value `useReqSigCert`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENCRYPTION_CERTIFICATE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENCRYPTION_CERTIFICATE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-revocation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-revocation[quarkus.cxf.client."clients".security.enable-revocation]` - - -[.description] --- -If `true`, Certificate Revocation List (CRL) checking is enabled when verifying trust in a certificate; otherwise it is not enabled. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_REVOCATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_REVOCATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-unsigned-saml-assertion-principal]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-unsigned-saml-assertion-principal[quarkus.cxf.client."clients".security.enable-unsigned-saml-assertion-principal]` - - -[.description] --- -If `true`, unsigned SAML assertions will be allowed as SecurityContext Principals; otherwise they won't be allowed as SecurityContext Principals. Note that "unsigned" refers to an internal signature. Even if the token is signed by an external signature (as per the "sender-vouches" requirement), this boolean must still be configured if you want to use the token to set up the security context. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_UNSIGNED_SAML_ASSERTION_PRINCIPAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_UNSIGNED_SAML_ASSERTION_PRINCIPAL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-validate-saml-subject-confirmation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-validate-saml-subject-confirmation[quarkus.cxf.client."clients".security.validate-saml-subject-confirmation]` - - -[.description] --- -If `true`, the `SubjectConfirmation` requirements of a received SAML Token (sender-vouches or holder-of-key) will be validated; otherwise they won't be validated. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_VALIDATE_SAML_SUBJECT_CONFIRMATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_VALIDATE_SAML_SUBJECT_CONFIRMATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sc-from-jaas-subject]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sc-from-jaas-subject[quarkus.cxf.client."clients".security.sc-from-jaas-subject]` - - -[.description] --- -If `true`, security context can be created from JAAS Subject; otherwise it must not be created from JAAS Subject. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SC_FROM_JAAS_SUBJECT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SC_FROM_JAAS_SUBJECT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-audience-restriction-validation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-audience-restriction-validation[quarkus.cxf.client."clients".security.audience-restriction-validation]` - - -[.description] --- -If `true`, then if the SAML Token contains Audience Restriction URIs, one of them must match one of the values in `audience.restrictions`; otherwise the SAML AudienceRestriction validation is disabled. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_AUDIENCE_RESTRICTION_VALIDATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_AUDIENCE_RESTRICTION_VALIDATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-saml-role-attributename]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-saml-role-attributename[quarkus.cxf.client."clients".security.saml-role-attributename]` - - -[.description] --- -The attribute URI of the SAML `AttributeStatement` where the role information is stored. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SAML_ROLE_ATTRIBUTENAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SAML_ROLE_ATTRIBUTENAME+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-subject-cert-constraints]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-subject-cert-constraints[quarkus.cxf.client."clients".security.subject-cert-constraints]` - - -[.description] --- -A String of regular expressions (separated by the value specified in `security.cert.constraints.separator`) which will be applied to the subject DN of the certificate used for signature validation, after trust verification of the certificate chain associated with the certificate. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SUBJECT_CERT_CONSTRAINTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SUBJECT_CERT_CONSTRAINTS+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-cert-constraints-separator]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-cert-constraints-separator[quarkus.cxf.client."clients".security.cert-constraints-separator]` - - -[.description] --- -The separator that is used to parse certificate constraints configured in `security.subject.cert.constraints` - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_CERT_CONSTRAINTS_SEPARATOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_CERT_CONSTRAINTS_SEPARATOR+++` -endif::add-copy-button-to-env-var[] ---|string -|`,` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-actor]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-actor[quarkus.cxf.client."clients".security.actor]` - - -[.description] --- -The actor or role name of the `wsse:Security` header. If this parameter is omitted, the actor name is not set. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ACTOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ACTOR+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-validate-token]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-validate-token[quarkus.cxf.client."clients".security.validate.token]` - - -[.description] --- -If `true`, the password of a received `UsernameToken` will be validated; otherwise it won't be validated. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_VALIDATE_TOKEN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_VALIDATE_TOKEN+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-username-token-always-encrypted]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-username-token-always-encrypted[quarkus.cxf.client."clients".security.username-token.always.encrypted]` - - -[.description] --- -Whether to always encrypt `UsernameTokens` that are defined as a `SupportingToken`. This should not be set to `false` in a production environment, as it exposes the password (or the digest of the password) on the wire. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USERNAME_TOKEN_ALWAYS_ENCRYPTED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USERNAME_TOKEN_ALWAYS_ENCRYPTED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-is-bsp-compliant]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-is-bsp-compliant[quarkus.cxf.client."clients".security.is-bsp-compliant]` - - -[.description] --- -If `true`, the compliance with the Basic Security Profile (BSP) 1.1 will be ensured; otherwise it will not be ensured. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_IS_BSP_COMPLIANT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_IS_BSP_COMPLIANT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-nonce-cache]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-nonce-cache[quarkus.cxf.client."clients".security.enable.nonce.cache]` - - -[.description] --- -If `true`, the `UsernameToken` nonces will be cached for both message initiators and recipients; otherwise they won't be cached for neither message initiators nor recipients. The default is `true` for message recipients, and `false` for message initiators. - -Note that caching only applies when either a `UsernameToken` WS-SecurityPolicy is in effect, or the `UsernameToken` action has been configured for the non-security-policy case. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_NONCE_CACHE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_NONCE_CACHE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-timestamp-cache]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-timestamp-cache[quarkus.cxf.client."clients".security.enable.timestamp.cache]` - - -[.description] --- -If `true`, the `Timestamp` `Created` Strings (these are only cached in conjunction with a message Signature) will be cached for both message initiators and recipients; otherwise they won't be cached for neither message initiators nor recipients. The default is `true` for message recipients, and `false` for message initiators. - -Note that caching only applies when either a `IncludeTimestamp` policy is in effect, or the `Timestamp` action has been configured for the non-security-policy case. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_TIMESTAMP_CACHE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_TIMESTAMP_CACHE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-streaming]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-streaming[quarkus.cxf.client."clients".security.enable.streaming]` - - -[.description] --- -If `true`, the new streaming (StAX) implementation of WS-Security is used; otherwise the old DOM implementation is used. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_STREAMING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_STREAMING+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-return-security-error]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-return-security-error[quarkus.cxf.client."clients".security.return.security.error]` - - -[.description] --- -If `true`, detailed security error messages are sent to clients; otherwise the details are omitted and only a generic error message is sent. - -The "real" security errors should not be returned to the client in production, as they may leak information about the deployment, or otherwise provide an "oracle" for attacks. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_RETURN_SECURITY_ERROR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_RETURN_SECURITY_ERROR+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-must-understand]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-must-understand[quarkus.cxf.client."clients".security.must-understand]` - - -[.description] --- -If `true`, the SOAP `mustUnderstand` header is included in security headers based on a WS-SecurityPolicy; otherwise the header is always omitted. - -Works only with `enable.streaming = true` - see link:https://issues.apache.org/jira/browse/CXF-8940[CXF-8940] - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_MUST_UNDERSTAND+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_MUST_UNDERSTAND+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-saml-cache]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-enable-saml-cache[quarkus.cxf.client."clients".security.enable.saml.cache]` - - -[.description] --- -If `true` and in case the token contains a `OneTimeUse` Condition, the SAML2 Token Identifiers will be cached for both message initiators and recipients; otherwise they won't be cached for neither message initiators nor recipients. The default is `true` for message recipients, and `false` for message initiators. - -Note that caching only applies when either a `SamlToken` policy is in effect, or a SAML action has been configured for the non-security-policy case. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_SAML_CACHE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ENABLE_SAML_CACHE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-store-bytes-in-attachment]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-store-bytes-in-attachment[quarkus.cxf.client."clients".security.store.bytes.in.attachment]` - - -[.description] --- -Whether to store bytes (CipherData or BinarySecurityToken) in an attachment. The default is true if MTOM is enabled. Set it to false to BASE-64 encode the bytes and "inlined" them in the message instead. Setting this to true is more efficient, as it means that the BASE-64 encoding step can be skipped. This only applies to the DOM WS-Security stack. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STORE_BYTES_IN_ATTACHMENT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STORE_BYTES_IN_ATTACHMENT+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-swa-encryption-attachment-transform-content]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-swa-encryption-attachment-transform-content[quarkus.cxf.client."clients".security.swa.encryption.attachment.transform.content]` - - -[.description] --- -If `true`, `Attachment-Content-Only` transform will be used when an Attachment is encrypted via a WS-SecurityPolicy expression; otherwise `Attachment-Complete` transform will be used when an Attachment is encrypted via a WS-SecurityPolicy expression. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SWA_ENCRYPTION_ATTACHMENT_TRANSFORM_CONTENT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SWA_ENCRYPTION_ATTACHMENT_TRANSFORM_CONTENT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-use-str-transform]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-use-str-transform[quarkus.cxf.client."clients".security.use.str.transform]` - - -[.description] --- -If `true`, the STR (Security Token Reference) Transform will be used when (externally) signing a SAML Token; otherwise the STR (Security Token Reference) Transform will not be used. - -Some frameworks cannot process the `SecurityTokenReference`. You may set this `false` in such cases. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USE_STR_TRANSFORM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USE_STR_TRANSFORM+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-add-inclusive-prefixes]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-add-inclusive-prefixes[quarkus.cxf.client."clients".security.add.inclusive.prefixes]` - - -[.description] --- -If `true`, an `InclusiveNamespaces` `PrefixList` will be added as a `CanonicalizationMethod` child when generating Signatures using `WSConstants.C14N_EXCL_OMIT_COMMENTS`; otherwise the `PrefixList` will not be added. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ADD_INCLUSIVE_PREFIXES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ADD_INCLUSIVE_PREFIXES+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-disable-require-client-cert-check]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-disable-require-client-cert-check[quarkus.cxf.client."clients".security.disable.require.client.cert.check]` - - -[.description] --- -If `true`, the enforcement of the WS-SecurityPolicy `RequireClientCertificate` policy will be disabled; otherwise the enforcement of the WS-SecurityPolicy `RequireClientCertificate` policy is enabled. - -Some servers may not do client certificate verification at the start of the SSL handshake, and therefore the client certificates may not be available to the WS-Security layer for policy verification. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_DISABLE_REQUIRE_CLIENT_CERT_CHECK+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_DISABLE_REQUIRE_CLIENT_CERT_CHECK+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-expand-xop-include]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-expand-xop-include[quarkus.cxf.client."clients".security.expand.xop.include]` - - -[.description] --- -If `true`, the `xop:Include` elements will be searched for encryption and signature (on the outbound side) or for signature verification (on the inbound side); otherwise the search won't happen. This ensures that the actual bytes are signed, and not just the reference. The default is `true` if MTOM is enabled, otherwise the default is `false`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_EXPAND_XOP_INCLUDE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_EXPAND_XOP_INCLUDE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-timestamp-timetolive]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-timestamp-timetolive[quarkus.cxf.client."clients".security.timestamp.timeToLive]` - - -[.description] --- -The time in seconds to add to the Creation value of an incoming `Timestamp` to determine whether to accept it as valid or not. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_TIMESTAMP_TIMETOLIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_TIMESTAMP_TIMETOLIVE+++` -endif::add-copy-button-to-env-var[] ---|string -|`300` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-timestamp-futuretimetolive]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-timestamp-futuretimetolive[quarkus.cxf.client."clients".security.timestamp.futureTimeToLive]` - - -[.description] --- -The time in seconds in the future within which the `Created` time of an incoming `Timestamp` is valid. The default is greater than zero to avoid problems where clocks are slightly askew. Set this to `0` to reject all future-created `Timestamp`s. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_TIMESTAMP_FUTURETIMETOLIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_TIMESTAMP_FUTURETIMETOLIVE+++` -endif::add-copy-button-to-env-var[] ---|string -|`60` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-usernametoken-timetolive]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-usernametoken-timetolive[quarkus.cxf.client."clients".security.usernametoken.timeToLive]` - - -[.description] --- -The time in seconds to append to the Creation value of an incoming `UsernameToken` to determine whether to accept it as valid or not. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USERNAMETOKEN_TIMETOLIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USERNAMETOKEN_TIMETOLIVE+++` -endif::add-copy-button-to-env-var[] ---|string -|`300` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-usernametoken-futuretimetolive]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-usernametoken-futuretimetolive[quarkus.cxf.client."clients".security.usernametoken.futureTimeToLive]` - - -[.description] --- -The time in seconds in the future within which the `Created` time of an incoming `UsernameToken` is valid. The default is greater than zero to avoid problems where clocks are slightly askew. Set this to `0` to reject all future-created `UsernameToken`s. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USERNAMETOKEN_FUTURETIMETOLIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_USERNAMETOKEN_FUTURETIMETOLIVE+++` -endif::add-copy-button-to-env-var[] ---|string -|`60` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-spnego-client-action]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-spnego-client-action[quarkus.cxf.client."clients".security.spnego.client.action]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.spnego.SpnegoClientAction` bean to use for SPNEGO. This allows the user to plug in a different implementation to obtain a service ticket. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SPNEGO_CLIENT_ACTION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SPNEGO_CLIENT_ACTION+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-nonce-cache-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-nonce-cache-instance[quarkus.cxf.client."clients".security.nonce.cache.instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache `UsernameToken` nonces. A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_NONCE_CACHE_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_NONCE_CACHE_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-timestamp-cache-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-timestamp-cache-instance[quarkus.cxf.client."clients".security.timestamp.cache.instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache `Timestamp` `Created` Strings. A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_TIMESTAMP_CACHE_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_TIMESTAMP_CACHE_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-saml-cache-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-saml-cache-instance[quarkus.cxf.client."clients".security.saml.cache.instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache SAML2 Token Identifier Strings (if the token contains a `OneTimeUse` condition). A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SAML_CACHE_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SAML_CACHE_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-cache-config-file]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-cache-config-file[quarkus.cxf.client."clients".security.cache.config.file]` - - -[.description] --- -Set this property to point to a configuration file for the underlying caching implementation for the `TokenStore`. The default configuration file that is used is `cxf-ehcache.xml` in `org.apache.cxf:cxf-rt-security` JAR. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_CACHE_CONFIG_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_CACHE_CONFIG_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-token-store-cache-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-token-store-cache-instance[quarkus.cxf.client."clients".security.token-store-cache-instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.cxf.ws.security.tokenstore.TokenStore` bean to use for caching security tokens. By default this uses a instance. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_TOKEN_STORE_CACHE_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_TOKEN_STORE_CACHE_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-cache-identifier]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-cache-identifier[quarkus.cxf.client."clients".security.cache.identifier]` - - -[.description] --- -The Cache Identifier to use with the TokenStore. CXF uses the following key to retrieve a token store: `org.apache.cxf.ws.security.tokenstore.TokenStore-`. This key can be used to configure service-specific cache configuration. If the identifier does not match, then it falls back to a cache configuration with key `org.apache.cxf.ws.security.tokenstore.TokenStore`. - -The default `` is the QName of the service in question. However to pick up a custom cache configuration (for example, if you want to specify a TokenStore per-client proxy), it can be configured with this identifier instead. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_CACHE_IDENTIFIER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_CACHE_IDENTIFIER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-role-classifier]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-role-classifier[quarkus.cxf.client."clients".security.role.classifier]` - - -[.description] --- -The Subject Role Classifier to use. If one of the WSS4J Validators returns a JAAS Subject from Validation, then the `WSS4JInInterceptor` will attempt to create a `SecurityContext` based on this Subject. If this value is not specified, then it tries to get roles using the `DefaultSecurityContext` in `org.apache.cxf:cxf-core`. Otherwise it uses this value in combination with the `role.classifier.type` to get the roles from the `Subject`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ROLE_CLASSIFIER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ROLE_CLASSIFIER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-role-classifier-type]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-role-classifier-type[quarkus.cxf.client."clients".security.role.classifier.type]` - - -[.description] --- -The Subject Role Classifier Type to use. If one of the WSS4J Validators returns a JAAS Subject from Validation, then the `WSS4JInInterceptor` will attempt to create a `SecurityContext` based on this Subject. Currently accepted values are `prefix` or `classname`. Must be used in conjunction with the `role.classifier`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ROLE_CLASSIFIER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ROLE_CLASSIFIER_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -|`prefix` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-asymmetric-signature-algorithm]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-asymmetric-signature-algorithm[quarkus.cxf.client."clients".security.asymmetric.signature.algorithm]` - - -[.description] --- -This configuration tag allows the user to override the default Asymmetric Signature algorithm (RSA-SHA1) for use in WS-SecurityPolicy, as the WS-SecurityPolicy specification does not allow the use of other algorithms at present. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ASYMMETRIC_SIGNATURE_ALGORITHM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_ASYMMETRIC_SIGNATURE_ALGORITHM+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-symmetric-signature-algorithm]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-symmetric-signature-algorithm[quarkus.cxf.client."clients".security.symmetric.signature.algorithm]` - - -[.description] --- -This configuration tag allows the user to override the default Symmetric Signature algorithm (HMAC-SHA1) for use in WS-SecurityPolicy, as the WS-SecurityPolicy specification does not allow the use of other algorithms at present. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SYMMETRIC_SIGNATURE_ALGORITHM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SYMMETRIC_SIGNATURE_ALGORITHM+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-password-encryptor-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-password-encryptor-instance[quarkus.cxf.client."clients".security.password.encryptor.instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.crypto.PasswordEncryptor` bean, which is used to encrypt or decrypt passwords in the Merlin Crypto implementation (or any custom Crypto implementations). - -By default, WSS4J uses the `org.apache.wss4j.common.crypto.JasyptPasswordEncryptor` which must be instantiated with a password to use to decrypt keystore passwords in the Merlin Crypto definition. This password is obtained via the CallbackHandler defined via `callback-handler` - -The encrypted passwords must be stored in the format "ENC(encoded encrypted password)". - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_PASSWORD_ENCRYPTOR_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_PASSWORD_ENCRYPTOR_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-delegated-credential]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-delegated-credential[quarkus.cxf.client."clients".security.delegated.credential]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a Kerberos `org.ietf.jgss.GSSCredential` bean to use for WS-Security. This is used to retrieve a service ticket instead of using the client credentials. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_DELEGATED_CREDENTIAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_DELEGATED_CREDENTIAL+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-security-context-creator]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-security-context-creator[quarkus.cxf.client."clients".security.security.context.creator]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.cxf.ws.security.wss4j.WSS4JSecurityContextCreator` bean that is used to create a CXF SecurityContext from the set of WSS4J processing results. The default implementation is `org.apache.cxf.ws.security.wss4j.DefaultWSS4JSecurityContextCreator`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SECURITY_CONTEXT_CREATOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SECURITY_CONTEXT_CREATOR+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-security-token-lifetime]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-security-token-lifetime[quarkus.cxf.client."clients".security.security.token.lifetime]` - - -[.description] --- -The security token lifetime value (in milliseconds). - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SECURITY_TOKEN_LIFETIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_SECURITY_TOKEN_LIFETIME+++` -endif::add-copy-button-to-env-var[] ---|long -|`300000` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-request-credential-delegation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-request-credential-delegation[quarkus.cxf.client."clients".security.kerberos.request.credential.delegation]` - - -[.description] --- -If `true`, credential delegation is requested in the KerberosClient; otherwise the credential delegation is not in the KerberosClient. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_REQUEST_CREDENTIAL_DELEGATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_REQUEST_CREDENTIAL_DELEGATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-use-credential-delegation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-use-credential-delegation[quarkus.cxf.client."clients".security.kerberos.use.credential.delegation]` - - -[.description] --- -If `true`, GSSCredential bean is retrieved from the Message Context using the `delegated.credential` property and then it is used to obtain a service ticket. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_USE_CREDENTIAL_DELEGATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_USE_CREDENTIAL_DELEGATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-is-username-in-servicename-form]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-is-username-in-servicename-form[quarkus.cxf.client."clients".security.kerberos.is.username.in.servicename.form]` - - -[.description] --- -If `true`, the Kerberos username is in servicename form; otherwise the Kerberos username is not in servicename form. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_IS_USERNAME_IN_SERVICENAME_FORM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_IS_USERNAME_IN_SERVICENAME_FORM+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-jaas-context]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-jaas-context[quarkus.cxf.client."clients".security.kerberos.jaas.context]` - - -[.description] --- -The JAAS Context name to use for Kerberos. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_JAAS_CONTEXT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_JAAS_CONTEXT+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-spn]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-spn[quarkus.cxf.client."clients".security.kerberos.spn]` - - -[.description] --- -The Kerberos Service Provider Name (spn) to use. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_SPN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_SPN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-client]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-kerberos-client[quarkus.cxf.client."clients".security.kerberos.client]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.cxf.ws.security.kerberos.KerberosClient` bean used to obtain a service ticket. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_CLIENT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_KERBEROS_CLIENT+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client[quarkus.cxf.client."clients".security.sts.client]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a fully configured `org.apache.cxf.ws.security.trust.STSClient` bean to communicate with the STS. If not set, the STS client will be created and configured based on other `++[++prefix++]++.security.sts.client.++*++` properties as long as they are available. - -To workaround the fact that `org.apache.cxf.ws.security.trust.STSClient` does not have a no-args constructor and cannot thus be used as a CDI bean type, you can use the wrapper class `io.quarkiverse.cxf.ws.security.sts.client.STSClientBean` instead. - -Tip: Check the link:quarkus-cxf-services-sts.html[Security Token Service (STS)] extension page for more information about WS-Trust. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-wsdl]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-wsdl[quarkus.cxf.client."clients".security.sts.client.wsdl]` - - -[.description] --- -A URL, resource path or local filesystem path pointing to a WSDL document to use when generating the service proxy of the STS client. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_WSDL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_WSDL+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-service-name]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-service-name[quarkus.cxf.client."clients".security.sts.client.service-name]` - - -[.description] --- -A fully qualified name of the STS service. Common values include: - - - WS-Trust 1.0: `++{++http://schemas.xmlsoap.org/ws/2005/02/trust/++}++SecurityTokenService` - - WS-Trust 1.3: `++{++http://docs.oasis-open.org/ws-sx/ws-trust/200512/++}++SecurityTokenService` - - WS-Trust 1.4: `++{++http://docs.oasis-open.org/ws-sx/ws-trust/200802/++}++SecurityTokenService` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_SERVICE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_SERVICE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-endpoint-name]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-endpoint-name[quarkus.cxf.client."clients".security.sts.client.endpoint-name]` - - -[.description] --- -A fully qualified name of the STS endpoint name. Common values include: - - - `++{++http://docs.oasis-open.org/ws-sx/ws-trust/200512/++}++X509_Port` - - `++{++http://docs.oasis-open.org/ws-sx/ws-trust/200512/++}++Transport_Port` - - `++{++http://docs.oasis-open.org/ws-sx/ws-trust/200512/++}++UT_Port` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENDPOINT_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENDPOINT_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-username]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-username[quarkus.cxf.client."clients".security.sts.client.username]` - - -[.description] --- -The user name to use when authenticating against the STS. It is used as follows: - - - As the name in the UsernameToken for WS-Security - - As the alias name in the keystore to get the user's cert and private key for signature if `signature.username` is not set - - As the alias name in the keystore to get the user's public key for encryption if `encryption.username` is not set - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-password]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-password[quarkus.cxf.client."clients".security.sts.client.password]` - - -[.description] --- -The password associated with the `username`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-encryption-username]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-encryption-username[quarkus.cxf.client."clients".security.sts.client.encryption.username]` - - -[.description] --- -The user's name for encryption. It is used as the alias name in the keystore to get the user's public key for encryption. If this is not defined, then `username` is used instead. If that is also not specified, it uses the the default alias set in the properties file referenced by `encrypt.properties`. If that's also not set, and the keystore only contains a single key, that key will be used. - -For the WS-Security web service provider, the `useReqSigCert` value can be used to accept (encrypt to) any client whose public key is in the service's truststore (defined in `encrypt.properties`). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENCRYPTION_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENCRYPTION_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-encryption-properties-encryption-properties]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-encryption-properties-encryption-properties[quarkus.cxf.client."clients".security.sts.client.encryption.properties]` - - -[.description] --- -The Crypto property configuration to use for encryption, if `encryption.crypto` is not set. - -Example - -``` -[prefix].encryption.properties."org.apache.ws.security.crypto.provider" = org.apache.ws.security.components.crypto.Merlin -[prefix].encryption.properties."org.apache.ws.security.crypto.merlin.keystore.password" = password -[prefix].encryption.properties."org.apache.ws.security.crypto.merlin.file" = certs/alice.jks -``` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENCRYPTION_PROPERTIES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENCRYPTION_PROPERTIES+++` -endif::add-copy-button-to-env-var[] ---|`Map` -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-encryption-crypto]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-encryption-crypto[quarkus.cxf.client."clients".security.sts.client.encryption.crypto]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for encryption. If not set, `encryption.properties` will be used to configure a `Crypto` instance. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENCRYPTION_CRYPTO+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_ENCRYPTION_CRYPTO+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-token-crypto]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-token-crypto[quarkus.cxf.client."clients".security.sts.client.token.crypto]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for the STS. If not set, `token.properties` will be used to configure a `Crypto` instance. - -WCF's trust server sometimes will encrypt the token in the response IN ADDITION TO the full security on the message. These properties control the way the STS client will decrypt the EncryptedData elements in the response. - -These are also used by the `token.properties` to send/process any RSA/DSAKeyValue tokens used if the KeyType is `PublicKey` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_CRYPTO+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_CRYPTO+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-token-properties-token-properties]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-token-properties-token-properties[quarkus.cxf.client."clients".security.sts.client.token.properties]` - - -[.description] --- -The Crypto property configuration to use for encryption, if `encryption.crypto` is not set. - -Example - -``` -[prefix].token.properties."org.apache.ws.security.crypto.provider" = org.apache.ws.security.components.crypto.Merlin -[prefix].token.properties."org.apache.ws.security.crypto.merlin.keystore.password" = password -[prefix].token.properties."org.apache.ws.security.crypto.merlin.file" = certs/alice.jks -``` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_PROPERTIES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_PROPERTIES+++` -endif::add-copy-button-to-env-var[] ---|`Map` -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-token-username]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-token-username[quarkus.cxf.client."clients".security.sts.client.token.username]` - - -[.description] --- -The alias name in the keystore to get the user's public key to send to the STS for the PublicKey KeyType case. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-token-usecert]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-token-usecert[quarkus.cxf.client."clients".security.sts.client.token.usecert]` - - -[.description] --- -Whether to write out an X509Certificate structure in UseKey/KeyInfo, or whether to write out a KeyValue structure. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_USECERT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_TOKEN_USECERT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-soap12-binding]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client-soap12-binding[quarkus.cxf.client."clients".security.sts.client.soap12-binding]` - - -[.description] --- -If `true` the STS client will be set to send Soap 1.2 messages; otherwise it will send SOAP 1.1 messages. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_SOAP12_BINDING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURITY_STS_CLIENT_SOAP12_BINDING+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-username]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-username[quarkus.cxf.endpoint."endpoints".security.username]` - - -[.description] --- -The user's name. It is used as follows: - - - As the name in the UsernameToken for WS-Security - - As the alias name in the keystore to get the user's cert and private key for signature if `signature.username` is not set - - As the alias name in the keystore to get the user's public key for encryption if `encryption.username` is not set - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-password]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-password[quarkus.cxf.endpoint."endpoints".security.password]` - - -[.description] --- -The user's password when a `callback-handler` is not defined. This is only used for the password in a WS-Security UsernameToken. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-signature-username]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-signature-username[quarkus.cxf.endpoint."endpoints".security.signature.username]` - - -[.description] --- -The user's name for signature. It is used as the alias name in the keystore to get the user's cert and private key for signature. If this is not defined, then `username` is used instead. If that is also not specified, it uses the the default alias set in the properties file referenced by `signature.properties`. If that's also not set, and the keystore only contains a single key, that key will be used. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SIGNATURE_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SIGNATURE_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-signature-password]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-signature-password[quarkus.cxf.endpoint."endpoints".security.signature.password]` - - -[.description] --- -The user's password for signature when a `callback-handler` is not defined. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SIGNATURE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SIGNATURE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-encryption-username]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-encryption-username[quarkus.cxf.endpoint."endpoints".security.encryption.username]` - - -[.description] --- -The user's name for encryption. It is used as the alias name in the keystore to get the user's public key for encryption. If this is not defined, then `username` is used instead. If that is also not specified, it uses the the default alias set in the properties file referenced by `encrypt.properties`. If that's also not set, and the keystore only contains a single key, that key will be used. - -For the WS-Security web service provider, the `useReqSigCert` value can be used to accept (encrypt to) any client whose public key is in the service's truststore (defined in `encrypt.properties`). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENCRYPTION_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENCRYPTION_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-callback-handler]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-callback-handler[quarkus.cxf.endpoint."endpoints".security.callback-handler]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `javax.security.auth.callback.CallbackHandler` bean used to obtain passwords, for both outbound and inbound requests. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_CALLBACK_HANDLER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_CALLBACK_HANDLER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-saml-callback-handler]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-saml-callback-handler[quarkus.cxf.endpoint."endpoints".security.saml-callback-handler]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `javax.security.auth.callback.CallbackHandler` implementation used to construct SAML Assertions. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SAML_CALLBACK_HANDLER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SAML_CALLBACK_HANDLER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-signature-properties-signature-properties]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-signature-properties-signature-properties[quarkus.cxf.endpoint."endpoints".security.signature.properties]` - - -[.description] --- -The Crypto property configuration to use for signing, if `signature.crypto` is not set. - -Example - -``` -[prefix].signature.properties."org.apache.ws.security.crypto.provider" = org.apache.ws.security.components.crypto.Merlin -[prefix].signature.properties."org.apache.ws.security.crypto.merlin.keystore.password" = password -[prefix].signature.properties."org.apache.ws.security.crypto.merlin.file" = certs/alice.jks -``` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SIGNATURE_PROPERTIES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SIGNATURE_PROPERTIES+++` -endif::add-copy-button-to-env-var[] ---|`Map` -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-encryption-properties-encryption-properties]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-encryption-properties-encryption-properties[quarkus.cxf.endpoint."endpoints".security.encryption.properties]` - - -[.description] --- -The Crypto property configuration to use for encryption, if `encryption.crypto` is not set. - -Example - -``` -[prefix].encryption.properties."org.apache.ws.security.crypto.provider" = org.apache.ws.security.components.crypto.Merlin -[prefix].encryption.properties."org.apache.ws.security.crypto.merlin.keystore.password" = password -[prefix].encryption.properties."org.apache.ws.security.crypto.merlin.file" = certs/alice.jks -``` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENCRYPTION_PROPERTIES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENCRYPTION_PROPERTIES+++` -endif::add-copy-button-to-env-var[] ---|`Map` -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-signature-crypto]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-signature-crypto[quarkus.cxf.endpoint."endpoints".security.signature.crypto]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` bean to be used for signature. If not set, `signature.properties` will be used to configure a `Crypto` instance. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SIGNATURE_CRYPTO+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SIGNATURE_CRYPTO+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-encryption-crypto]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-encryption-crypto[quarkus.cxf.endpoint."endpoints".security.encryption.crypto]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.crypto.Crypto` to be used for encryption. If not set, `encryption.properties` will be used to configure a `Crypto` instance. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENCRYPTION_CRYPTO+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENCRYPTION_CRYPTO+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-encryption-certificate]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-encryption-certificate[quarkus.cxf.endpoint."endpoints".security.encryption.certificate]` - - -[.description] --- -A message property for prepared X509 certificate to be used for encryption. If this is not defined, then the certificate will be either loaded from the keystore `encryption.properties` or extracted from request (when WS-Security is used and if `encryption.username` has value `useReqSigCert`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENCRYPTION_CERTIFICATE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENCRYPTION_CERTIFICATE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-revocation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-revocation[quarkus.cxf.endpoint."endpoints".security.enable-revocation]` - - -[.description] --- -If `true`, Certificate Revocation List (CRL) checking is enabled when verifying trust in a certificate; otherwise it is not enabled. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_REVOCATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_REVOCATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-unsigned-saml-assertion-principal]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-unsigned-saml-assertion-principal[quarkus.cxf.endpoint."endpoints".security.enable-unsigned-saml-assertion-principal]` - - -[.description] --- -If `true`, unsigned SAML assertions will be allowed as SecurityContext Principals; otherwise they won't be allowed as SecurityContext Principals. Note that "unsigned" refers to an internal signature. Even if the token is signed by an external signature (as per the "sender-vouches" requirement), this boolean must still be configured if you want to use the token to set up the security context. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_UNSIGNED_SAML_ASSERTION_PRINCIPAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_UNSIGNED_SAML_ASSERTION_PRINCIPAL+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-validate-saml-subject-confirmation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-validate-saml-subject-confirmation[quarkus.cxf.endpoint."endpoints".security.validate-saml-subject-confirmation]` - - -[.description] --- -If `true`, the `SubjectConfirmation` requirements of a received SAML Token (sender-vouches or holder-of-key) will be validated; otherwise they won't be validated. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_VALIDATE_SAML_SUBJECT_CONFIRMATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_VALIDATE_SAML_SUBJECT_CONFIRMATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-sc-from-jaas-subject]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-sc-from-jaas-subject[quarkus.cxf.endpoint."endpoints".security.sc-from-jaas-subject]` - - -[.description] --- -If `true`, security context can be created from JAAS Subject; otherwise it must not be created from JAAS Subject. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SC_FROM_JAAS_SUBJECT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SC_FROM_JAAS_SUBJECT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-audience-restriction-validation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-audience-restriction-validation[quarkus.cxf.endpoint."endpoints".security.audience-restriction-validation]` - - -[.description] --- -If `true`, then if the SAML Token contains Audience Restriction URIs, one of them must match one of the values in `audience.restrictions`; otherwise the SAML AudienceRestriction validation is disabled. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_AUDIENCE_RESTRICTION_VALIDATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_AUDIENCE_RESTRICTION_VALIDATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-saml-role-attributename]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-saml-role-attributename[quarkus.cxf.endpoint."endpoints".security.saml-role-attributename]` - - -[.description] --- -The attribute URI of the SAML `AttributeStatement` where the role information is stored. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SAML_ROLE_ATTRIBUTENAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SAML_ROLE_ATTRIBUTENAME+++` -endif::add-copy-button-to-env-var[] ---|string -|`http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-subject-cert-constraints]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-subject-cert-constraints[quarkus.cxf.endpoint."endpoints".security.subject-cert-constraints]` - - -[.description] --- -A String of regular expressions (separated by the value specified in `security.cert.constraints.separator`) which will be applied to the subject DN of the certificate used for signature validation, after trust verification of the certificate chain associated with the certificate. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SUBJECT_CERT_CONSTRAINTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SUBJECT_CERT_CONSTRAINTS+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-cert-constraints-separator]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-cert-constraints-separator[quarkus.cxf.endpoint."endpoints".security.cert-constraints-separator]` - - -[.description] --- -The separator that is used to parse certificate constraints configured in `security.subject.cert.constraints` - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_CERT_CONSTRAINTS_SEPARATOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_CERT_CONSTRAINTS_SEPARATOR+++` -endif::add-copy-button-to-env-var[] ---|string -|`,` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-actor]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-actor[quarkus.cxf.endpoint."endpoints".security.actor]` - - -[.description] --- -The actor or role name of the `wsse:Security` header. If this parameter is omitted, the actor name is not set. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ACTOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ACTOR+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-validate-token]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-validate-token[quarkus.cxf.endpoint."endpoints".security.validate.token]` - - -[.description] --- -If `true`, the password of a received `UsernameToken` will be validated; otherwise it won't be validated. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_VALIDATE_TOKEN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_VALIDATE_TOKEN+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-username-token-always-encrypted]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-username-token-always-encrypted[quarkus.cxf.endpoint."endpoints".security.username-token.always.encrypted]` - - -[.description] --- -Whether to always encrypt `UsernameTokens` that are defined as a `SupportingToken`. This should not be set to `false` in a production environment, as it exposes the password (or the digest of the password) on the wire. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USERNAME_TOKEN_ALWAYS_ENCRYPTED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USERNAME_TOKEN_ALWAYS_ENCRYPTED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-is-bsp-compliant]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-is-bsp-compliant[quarkus.cxf.endpoint."endpoints".security.is-bsp-compliant]` - - -[.description] --- -If `true`, the compliance with the Basic Security Profile (BSP) 1.1 will be ensured; otherwise it will not be ensured. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_IS_BSP_COMPLIANT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_IS_BSP_COMPLIANT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-nonce-cache]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-nonce-cache[quarkus.cxf.endpoint."endpoints".security.enable.nonce.cache]` - - -[.description] --- -If `true`, the `UsernameToken` nonces will be cached for both message initiators and recipients; otherwise they won't be cached for neither message initiators nor recipients. The default is `true` for message recipients, and `false` for message initiators. - -Note that caching only applies when either a `UsernameToken` WS-SecurityPolicy is in effect, or the `UsernameToken` action has been configured for the non-security-policy case. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_NONCE_CACHE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_NONCE_CACHE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-timestamp-cache]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-timestamp-cache[quarkus.cxf.endpoint."endpoints".security.enable.timestamp.cache]` - - -[.description] --- -If `true`, the `Timestamp` `Created` Strings (these are only cached in conjunction with a message Signature) will be cached for both message initiators and recipients; otherwise they won't be cached for neither message initiators nor recipients. The default is `true` for message recipients, and `false` for message initiators. - -Note that caching only applies when either a `IncludeTimestamp` policy is in effect, or the `Timestamp` action has been configured for the non-security-policy case. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_TIMESTAMP_CACHE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_TIMESTAMP_CACHE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-streaming]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-streaming[quarkus.cxf.endpoint."endpoints".security.enable.streaming]` - - -[.description] --- -If `true`, the new streaming (StAX) implementation of WS-Security is used; otherwise the old DOM implementation is used. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_STREAMING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_STREAMING+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-return-security-error]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-return-security-error[quarkus.cxf.endpoint."endpoints".security.return.security.error]` - - -[.description] --- -If `true`, detailed security error messages are sent to clients; otherwise the details are omitted and only a generic error message is sent. - -The "real" security errors should not be returned to the client in production, as they may leak information about the deployment, or otherwise provide an "oracle" for attacks. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_RETURN_SECURITY_ERROR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_RETURN_SECURITY_ERROR+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-must-understand]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-must-understand[quarkus.cxf.endpoint."endpoints".security.must-understand]` - - -[.description] --- -If `true`, the SOAP `mustUnderstand` header is included in security headers based on a WS-SecurityPolicy; otherwise the header is always omitted. - -Works only with `enable.streaming = true` - see link:https://issues.apache.org/jira/browse/CXF-8940[CXF-8940] - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_MUST_UNDERSTAND+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_MUST_UNDERSTAND+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-saml-cache]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-enable-saml-cache[quarkus.cxf.endpoint."endpoints".security.enable.saml.cache]` - - -[.description] --- -If `true` and in case the token contains a `OneTimeUse` Condition, the SAML2 Token Identifiers will be cached for both message initiators and recipients; otherwise they won't be cached for neither message initiators nor recipients. The default is `true` for message recipients, and `false` for message initiators. - -Note that caching only applies when either a `SamlToken` policy is in effect, or a SAML action has been configured for the non-security-policy case. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_SAML_CACHE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ENABLE_SAML_CACHE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-store-bytes-in-attachment]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-store-bytes-in-attachment[quarkus.cxf.endpoint."endpoints".security.store.bytes.in.attachment]` - - -[.description] --- -Whether to store bytes (CipherData or BinarySecurityToken) in an attachment. The default is true if MTOM is enabled. Set it to false to BASE-64 encode the bytes and "inlined" them in the message instead. Setting this to true is more efficient, as it means that the BASE-64 encoding step can be skipped. This only applies to the DOM WS-Security stack. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_STORE_BYTES_IN_ATTACHMENT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_STORE_BYTES_IN_ATTACHMENT+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-swa-encryption-attachment-transform-content]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-swa-encryption-attachment-transform-content[quarkus.cxf.endpoint."endpoints".security.swa.encryption.attachment.transform.content]` - - -[.description] --- -If `true`, `Attachment-Content-Only` transform will be used when an Attachment is encrypted via a WS-SecurityPolicy expression; otherwise `Attachment-Complete` transform will be used when an Attachment is encrypted via a WS-SecurityPolicy expression. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SWA_ENCRYPTION_ATTACHMENT_TRANSFORM_CONTENT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SWA_ENCRYPTION_ATTACHMENT_TRANSFORM_CONTENT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-use-str-transform]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-use-str-transform[quarkus.cxf.endpoint."endpoints".security.use.str.transform]` - - -[.description] --- -If `true`, the STR (Security Token Reference) Transform will be used when (externally) signing a SAML Token; otherwise the STR (Security Token Reference) Transform will not be used. - -Some frameworks cannot process the `SecurityTokenReference`. You may set this `false` in such cases. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USE_STR_TRANSFORM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USE_STR_TRANSFORM+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-add-inclusive-prefixes]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-add-inclusive-prefixes[quarkus.cxf.endpoint."endpoints".security.add.inclusive.prefixes]` - - -[.description] --- -If `true`, an `InclusiveNamespaces` `PrefixList` will be added as a `CanonicalizationMethod` child when generating Signatures using `WSConstants.C14N_EXCL_OMIT_COMMENTS`; otherwise the `PrefixList` will not be added. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ADD_INCLUSIVE_PREFIXES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ADD_INCLUSIVE_PREFIXES+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-disable-require-client-cert-check]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-disable-require-client-cert-check[quarkus.cxf.endpoint."endpoints".security.disable.require.client.cert.check]` - - -[.description] --- -If `true`, the enforcement of the WS-SecurityPolicy `RequireClientCertificate` policy will be disabled; otherwise the enforcement of the WS-SecurityPolicy `RequireClientCertificate` policy is enabled. - -Some servers may not do client certificate verification at the start of the SSL handshake, and therefore the client certificates may not be available to the WS-Security layer for policy verification. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_DISABLE_REQUIRE_CLIENT_CERT_CHECK+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_DISABLE_REQUIRE_CLIENT_CERT_CHECK+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-expand-xop-include]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-expand-xop-include[quarkus.cxf.endpoint."endpoints".security.expand.xop.include]` - - -[.description] --- -If `true`, the `xop:Include` elements will be searched for encryption and signature (on the outbound side) or for signature verification (on the inbound side); otherwise the search won't happen. This ensures that the actual bytes are signed, and not just the reference. The default is `true` if MTOM is enabled, otherwise the default is `false`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_EXPAND_XOP_INCLUDE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_EXPAND_XOP_INCLUDE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-timestamp-timetolive]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-timestamp-timetolive[quarkus.cxf.endpoint."endpoints".security.timestamp.timeToLive]` - - -[.description] --- -The time in seconds to add to the Creation value of an incoming `Timestamp` to determine whether to accept it as valid or not. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_TIMESTAMP_TIMETOLIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_TIMESTAMP_TIMETOLIVE+++` -endif::add-copy-button-to-env-var[] ---|string -|`300` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-timestamp-futuretimetolive]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-timestamp-futuretimetolive[quarkus.cxf.endpoint."endpoints".security.timestamp.futureTimeToLive]` - - -[.description] --- -The time in seconds in the future within which the `Created` time of an incoming `Timestamp` is valid. The default is greater than zero to avoid problems where clocks are slightly askew. Set this to `0` to reject all future-created `Timestamp`s. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_TIMESTAMP_FUTURETIMETOLIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_TIMESTAMP_FUTURETIMETOLIVE+++` -endif::add-copy-button-to-env-var[] ---|string -|`60` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-usernametoken-timetolive]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-usernametoken-timetolive[quarkus.cxf.endpoint."endpoints".security.usernametoken.timeToLive]` - - -[.description] --- -The time in seconds to append to the Creation value of an incoming `UsernameToken` to determine whether to accept it as valid or not. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USERNAMETOKEN_TIMETOLIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USERNAMETOKEN_TIMETOLIVE+++` -endif::add-copy-button-to-env-var[] ---|string -|`300` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-usernametoken-futuretimetolive]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-usernametoken-futuretimetolive[quarkus.cxf.endpoint."endpoints".security.usernametoken.futureTimeToLive]` - - -[.description] --- -The time in seconds in the future within which the `Created` time of an incoming `UsernameToken` is valid. The default is greater than zero to avoid problems where clocks are slightly askew. Set this to `0` to reject all future-created `UsernameToken`s. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USERNAMETOKEN_FUTURETIMETOLIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_USERNAMETOKEN_FUTURETIMETOLIVE+++` -endif::add-copy-button-to-env-var[] ---|string -|`60` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-spnego-client-action]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-spnego-client-action[quarkus.cxf.endpoint."endpoints".security.spnego.client.action]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.spnego.SpnegoClientAction` bean to use for SPNEGO. This allows the user to plug in a different implementation to obtain a service ticket. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SPNEGO_CLIENT_ACTION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SPNEGO_CLIENT_ACTION+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-nonce-cache-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-nonce-cache-instance[quarkus.cxf.endpoint."endpoints".security.nonce.cache.instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache `UsernameToken` nonces. A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_NONCE_CACHE_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_NONCE_CACHE_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-timestamp-cache-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-timestamp-cache-instance[quarkus.cxf.endpoint."endpoints".security.timestamp.cache.instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache `Timestamp` `Created` Strings. A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_TIMESTAMP_CACHE_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_TIMESTAMP_CACHE_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-saml-cache-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-saml-cache-instance[quarkus.cxf.endpoint."endpoints".security.saml.cache.instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.cache.ReplayCache` bean used to cache SAML2 Token Identifier Strings (if the token contains a `OneTimeUse` condition). A `org.apache.wss4j.common.cache.EHCacheReplayCache` instance is used by default. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SAML_CACHE_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SAML_CACHE_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-cache-config-file]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-cache-config-file[quarkus.cxf.endpoint."endpoints".security.cache.config.file]` - - -[.description] --- -Set this property to point to a configuration file for the underlying caching implementation for the `TokenStore`. The default configuration file that is used is `cxf-ehcache.xml` in `org.apache.cxf:cxf-rt-security` JAR. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_CACHE_CONFIG_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_CACHE_CONFIG_FILE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-token-store-cache-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-token-store-cache-instance[quarkus.cxf.endpoint."endpoints".security.token-store-cache-instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.cxf.ws.security.tokenstore.TokenStore` bean to use for caching security tokens. By default this uses a instance. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_TOKEN_STORE_CACHE_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_TOKEN_STORE_CACHE_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-cache-identifier]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-cache-identifier[quarkus.cxf.endpoint."endpoints".security.cache.identifier]` - - -[.description] --- -The Cache Identifier to use with the TokenStore. CXF uses the following key to retrieve a token store: `org.apache.cxf.ws.security.tokenstore.TokenStore-`. This key can be used to configure service-specific cache configuration. If the identifier does not match, then it falls back to a cache configuration with key `org.apache.cxf.ws.security.tokenstore.TokenStore`. - -The default `` is the QName of the service in question. However to pick up a custom cache configuration (for example, if you want to specify a TokenStore per-client proxy), it can be configured with this identifier instead. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_CACHE_IDENTIFIER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_CACHE_IDENTIFIER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-role-classifier]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-role-classifier[quarkus.cxf.endpoint."endpoints".security.role.classifier]` - - -[.description] --- -The Subject Role Classifier to use. If one of the WSS4J Validators returns a JAAS Subject from Validation, then the `WSS4JInInterceptor` will attempt to create a `SecurityContext` based on this Subject. If this value is not specified, then it tries to get roles using the `DefaultSecurityContext` in `org.apache.cxf:cxf-core`. Otherwise it uses this value in combination with the `role.classifier.type` to get the roles from the `Subject`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ROLE_CLASSIFIER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ROLE_CLASSIFIER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-role-classifier-type]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-role-classifier-type[quarkus.cxf.endpoint."endpoints".security.role.classifier.type]` - - -[.description] --- -The Subject Role Classifier Type to use. If one of the WSS4J Validators returns a JAAS Subject from Validation, then the `WSS4JInInterceptor` will attempt to create a `SecurityContext` based on this Subject. Currently accepted values are `prefix` or `classname`. Must be used in conjunction with the `role.classifier`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ROLE_CLASSIFIER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ROLE_CLASSIFIER_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -|`prefix` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-asymmetric-signature-algorithm]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-asymmetric-signature-algorithm[quarkus.cxf.endpoint."endpoints".security.asymmetric.signature.algorithm]` - - -[.description] --- -This configuration tag allows the user to override the default Asymmetric Signature algorithm (RSA-SHA1) for use in WS-SecurityPolicy, as the WS-SecurityPolicy specification does not allow the use of other algorithms at present. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ASYMMETRIC_SIGNATURE_ALGORITHM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_ASYMMETRIC_SIGNATURE_ALGORITHM+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-symmetric-signature-algorithm]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-symmetric-signature-algorithm[quarkus.cxf.endpoint."endpoints".security.symmetric.signature.algorithm]` - - -[.description] --- -This configuration tag allows the user to override the default Symmetric Signature algorithm (HMAC-SHA1) for use in WS-SecurityPolicy, as the WS-SecurityPolicy specification does not allow the use of other algorithms at present. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SYMMETRIC_SIGNATURE_ALGORITHM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SYMMETRIC_SIGNATURE_ALGORITHM+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-password-encryptor-instance]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-password-encryptor-instance[quarkus.cxf.endpoint."endpoints".security.password.encryptor.instance]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.wss4j.common.crypto.PasswordEncryptor` bean, which is used to encrypt or decrypt passwords in the Merlin Crypto implementation (or any custom Crypto implementations). - -By default, WSS4J uses the `org.apache.wss4j.common.crypto.JasyptPasswordEncryptor` which must be instantiated with a password to use to decrypt keystore passwords in the Merlin Crypto definition. This password is obtained via the CallbackHandler defined via `callback-handler` - -The encrypted passwords must be stored in the format "ENC(encoded encrypted password)". - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_PASSWORD_ENCRYPTOR_INSTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_PASSWORD_ENCRYPTOR_INSTANCE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-delegated-credential]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-delegated-credential[quarkus.cxf.endpoint."endpoints".security.delegated.credential]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a Kerberos `org.ietf.jgss.GSSCredential` bean to use for WS-Security. This is used to retrieve a service ticket instead of using the client credentials. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_DELEGATED_CREDENTIAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_DELEGATED_CREDENTIAL+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-security-context-creator]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-security-context-creator[quarkus.cxf.endpoint."endpoints".security.security.context.creator]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.cxf.ws.security.wss4j.WSS4JSecurityContextCreator` bean that is used to create a CXF SecurityContext from the set of WSS4J processing results. The default implementation is `org.apache.cxf.ws.security.wss4j.DefaultWSS4JSecurityContextCreator`. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SECURITY_CONTEXT_CREATOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SECURITY_CONTEXT_CREATOR+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-security-token-lifetime]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-security-token-lifetime[quarkus.cxf.endpoint."endpoints".security.security.token.lifetime]` - - -[.description] --- -The security token lifetime value (in milliseconds). - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SECURITY_TOKEN_LIFETIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_SECURITY_TOKEN_LIFETIME+++` -endif::add-copy-button-to-env-var[] ---|long -|`300000` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-request-credential-delegation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-request-credential-delegation[quarkus.cxf.endpoint."endpoints".security.kerberos.request.credential.delegation]` - - -[.description] --- -If `true`, credential delegation is requested in the KerberosClient; otherwise the credential delegation is not in the KerberosClient. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_REQUEST_CREDENTIAL_DELEGATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_REQUEST_CREDENTIAL_DELEGATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-use-credential-delegation]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-use-credential-delegation[quarkus.cxf.endpoint."endpoints".security.kerberos.use.credential.delegation]` - - -[.description] --- -If `true`, GSSCredential bean is retrieved from the Message Context using the `delegated.credential` property and then it is used to obtain a service ticket. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_USE_CREDENTIAL_DELEGATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_USE_CREDENTIAL_DELEGATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-is-username-in-servicename-form]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-is-username-in-servicename-form[quarkus.cxf.endpoint."endpoints".security.kerberos.is.username.in.servicename.form]` - - -[.description] --- -If `true`, the Kerberos username is in servicename form; otherwise the Kerberos username is not in servicename form. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_IS_USERNAME_IN_SERVICENAME_FORM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_IS_USERNAME_IN_SERVICENAME_FORM+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-jaas-context]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-jaas-context[quarkus.cxf.endpoint."endpoints".security.kerberos.jaas.context]` - - -[.description] --- -The JAAS Context name to use for Kerberos. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_JAAS_CONTEXT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_JAAS_CONTEXT+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-spn]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-spn[quarkus.cxf.endpoint."endpoints".security.kerberos.spn]` - - -[.description] --- -The Kerberos Service Provider Name (spn) to use. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_SPN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_SPN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-client]]`link:#quarkus-cxf-rt-ws-security_quarkus-cxf-endpoint-endpoints-security-kerberos-client[quarkus.cxf.endpoint."endpoints".security.kerberos.client]` - - -[.description] --- -A link:../../user-guide/configuration.html#beanRefs[reference] to a `org.apache.cxf.ws.security.kerberos.KerberosClient` bean used to obtain a service ticket. - -This option is experimental, because it is link:https://github.com/quarkiverse/quarkus-cxf/issues/1052[not covered by tests] yet. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_CLIENT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SECURITY_KERBEROS_CLIENT+++` -endif::add-copy-button-to-env-var[] ---|string -| - -|=== \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-cxf.adoc b/docs/modules/ROOT/pages/includes/quarkus-cxf.adoc deleted file mode 100644 index e2fad186d..000000000 --- a/docs/modules/ROOT/pages/includes/quarkus-cxf.adoc +++ /dev/null @@ -1,2719 +0,0 @@ - -:summaryTableId: quarkus-cxf -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference.searchable, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-cxf_configuration]]link:#quarkus-cxf_configuration[Configuration property] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-enabled]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-enabled[quarkus.cxf.codegen.wsdl2java.enabled]` - - -[.description] --- -If `true` `wsdl2java` code generation is run whenever there are WSDL resources found on default or custom defined locations; otherwise `wsdl2java` is not executed. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-includes]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-includes[quarkus.cxf.codegen.wsdl2java.includes]` - - -[.description] --- -A comma separated list of glob patterns for selecting WSDL files which should be processed with `wsdl2java` tool. The paths are relative to `src/main/resources` or `src/test/resources` directories of the current Maven or Gradle module. The glob syntax is specified in `io.quarkus.util.GlobUtil`. - -Examples: - - - `calculator.wsdl,fruits.wsdl` will match `src/main/resources/calculator.wsdl` and `src/main/resources/fruits.wsdl` under the current Maven or Gradle module, but will not match anything like `src/main/resources/subdir/calculator.wsdl` - - `my-++*++-service.wsdl` will match `src/main/resources/my-foo-service.wsdl` and `src/main/resources/my-bar-service.wsdl` - - `++**++.wsdl` will match any of the above There is a separate `wsdl2java` execution for each of the matching WSDL files. If you need different `additional-params` for each WSDL file, you may want to define a separate named parameter set for each one of them. Here is an example: - -``` -# Parameters for foo.wsdl -quarkus.cxf.codegen.wsdl2java.foo-params.includes = wsdl/foo.wsdl -quarkus.cxf.codegen.wsdl2java.foo-params.wsdl-location = wsdl/foo.wsdl -# Parameters for bar.wsdl -quarkus.cxf.codegen.wsdl2java.bar-params.includes = wsdl/bar.wsdl -quarkus.cxf.codegen.wsdl2java.bar-params.wsdl-location = wsdl/bar.wsdl -quarkus.cxf.codegen.wsdl2java.bar-params.xjc = ts -``` - - - -Note that file extensions other than `.wsdl` will work during normal builds, but changes in the matching files may get overseen in Quarkus dev mode. Always using the `.wsdl` extension is thus recommended. - -There is no default value for this option, so `wsdl2java` code generation is disabled by default. - -Specifying `quarkus.cxf.codegen.wsdl2java.my-name.excludes` without setting any `includes` will cause a build time error. - -Make sure that the file sets selected by `quarkus.cxf.codegen.wsdl2java.includes` and `quarkus.cxf.codegen.wsdl2java.++[++whatever-name++]++.includes` do not overlap. Otherwise a build time exception will be thrown. - -The files from `src/main/resources` selected by `includes` and `excludes` are automatically included in native image and therefore you do not need to include them via `quarkus.cxf.wsdl-path` (deprecated) or `quarkus.native.resources.includes/excludes`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_INCLUDES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_INCLUDES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-excludes]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-excludes[quarkus.cxf.codegen.wsdl2java.excludes]` - - -[.description] --- -A comma separated list of path patterns for selecting WSDL files which should *not* be processed with `wsdl2java` tool. The paths are relative to `src/main/resources` or `src/test/resources` directories of the current Maven or Gradle module. Same syntax as `includes`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCLUDES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCLUDES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-output-directory]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-output-directory[quarkus.cxf.codegen.wsdl2java.output-directory]` - - -[.description] --- -A directory into which the generated files will be written, either absolute or relative to the current Maven or Gradle module directory. - -The default value is build tool dependent: for Maven, it is typically `target/generated-sources/wsdl2java`, while for Gradle it is `build/classes/java/quarkus-generated-sources/wsdl2java`. - -Quarkus tooling is only able to set up the default value as a source folder for the given build tool. If you set this to a custom path it is up to you to make sure that your build tool recognizes the path a as source folder. - -Also, if you choose a path outside `target` directory for Maven or outside `build` directory for Gradle, you need to take care for cleaning stale resources generated by previous builds. E.g. if you change the value of `package-names` option from `org.foo` to `org.bar` you need to take care for the removal of the removal of the old package `org.foo`. - -This will be passed as option `-d` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_OUTPUT_DIRECTORY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_OUTPUT_DIRECTORY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-package-names]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-package-names[quarkus.cxf.codegen.wsdl2java.package-names]` - - -[.description] --- -A comma separated list of tokens; each token can be one of the following: - - - A Java package under which the Java source files should be generated - - A string of the form `namespaceURI=packageName` - in this case the entities coming from the given namespace URI will be generated under the given Java package. - -This will be passed as option `-p` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_PACKAGE_NAMES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_PACKAGE_NAMES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-exclude-namespace-uris]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-exclude-namespace-uris[quarkus.cxf.codegen.wsdl2java.exclude-namespace-uris]` - - -[.description] --- -A comma separated list of WSDL schema namespace URIs to ignore when generating Java code. - -This will be passed as option `-nexclude` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCLUDE_NAMESPACE_URIS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCLUDE_NAMESPACE_URIS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-service-name]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-service-name[quarkus.cxf.codegen.wsdl2java.service-name]` - - -[.description] --- -The WSDL service name to use for the generated code. - -This will be passed as option `-sn` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_SERVICE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_SERVICE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-bindings]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-bindings[quarkus.cxf.codegen.wsdl2java.bindings]` - - -[.description] --- -A list of paths pointing at JAXWS or JAXB binding files or XMLBeans context files. The path to be either absolute or relative to the current Maven or Gradle module. - -This will be passed as option `-b` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_BINDINGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_BINDINGS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-validate]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-validate[quarkus.cxf.codegen.wsdl2java.validate]` - - -[.description] --- -If `true`, WSDLs are validated before processing; otherwise the WSDLs are not validated. - -This will be passed as option `-validate` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_VALIDATE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_VALIDATE+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-wsdl-location]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-wsdl-location[quarkus.cxf.codegen.wsdl2java.wsdl-location]` - - -[.description] --- -Specifies the value of the `@WebServiceClient` annotation's wsdlLocation property. - -This will be passed as option `-wsdlLocation` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_WSDL_LOCATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_WSDL_LOCATION+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-xjc]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-xjc[quarkus.cxf.codegen.wsdl2java.xjc]` - - -[.description] --- -A comma separated list of XJC extensions to enable. The following extensions are available through `io.quarkiverse.cxf:quarkus-cxf-xjc-plugins` dependency: - - - `bg` - generate `getX()` methods for boolean fields instead of `isX()` - - `bgi` - generate both `isX()` and `getX()` methods for boolean fields - - `dv` - initialize fields mapped from elements/attributes with their default values - - `javadoc` - generates JavaDoc based on `xsd:documentation` - - `property-listener` - add a property listener and the code for triggering the property change events to setter methods - - `ts` - generate `toString()` methods - - `wsdlextension` - generate WSDL extension methods in root classes - -These values correspond to `-wsdl2java` options `-xjc-Xbg`, `-xjc-Xbgi`, `-xjc-Xdv`, `-xjc-Xjavadoc`, `-xjc-Xproperty-listener`, `-xjc-Xts` and `-xjc-Xwsdlextension` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_XJC+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_XJC+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-exception-super]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-exception-super[quarkus.cxf.codegen.wsdl2java.exception-super]` - - -[.description] --- -A fully qualified class name to use as a superclass for fault beans generated from `wsdl:fault` elements - -This will be passed as option `-exceptionSuper` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCEPTION_SUPER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_EXCEPTION_SUPER+++` -endif::add-copy-button-to-env-var[] ---|string -|`java.lang.Exception` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-async-methods]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-async-methods[quarkus.cxf.codegen.wsdl2java.async-methods]` - - -[.description] --- -A comma separated list of SEI methods for which asynchronous sibling methods should be generated; similar to `enableAsyncMapping` in a JAX-WS binding file - -This will be passed as option `-asyncMethods` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_ASYNC_METHODS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_ASYNC_METHODS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-bare-methods]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-bare-methods[quarkus.cxf.codegen.wsdl2java.bare-methods]` - - -[.description] --- -A comma separated list of SEI methods for which wrapper style sibling methods should be generated; similar to `enableWrapperStyle` in JAX-WS binding file - -This will be passed as option `-bareMethods` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_BARE_METHODS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_BARE_METHODS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-mime-methods]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-mime-methods[quarkus.cxf.codegen.wsdl2java.mime-methods]` - - -[.description] --- -A comma separated list of SEI methods for which `mime:content` mapping should be enabled; similar to `enableMIMEContent` in JAX-WS binding file - -This will be passed as option `-mimeMethods` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_MIME_METHODS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_MIME_METHODS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-additional-params]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-additional-params[quarkus.cxf.codegen.wsdl2java.additional-params]` - - -[.description] --- -A comma separated list of additional command line parameters that should be passed to CXF `wsdl2java` tool along with the files selected by `includes` and `excludes`. Example: `-keep,-dex,false`. Check link:https://cxf.apache.org/docs/wsdl-to-java.html[`wsdl2java` documentation] for all supported options. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_ADDITIONAL_PARAMS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA_ADDITIONAL_PARAMS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-java2ws-enabled]]`link:#quarkus-cxf_quarkus-cxf-java2ws-enabled[quarkus.cxf.java2ws.enabled]` - - -[.description] --- -If `true` `java2ws` WSDL generation is run whenever there are Java classes selected via `includes` and `excludes` options; otherwise `java2ws` is not executed. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_JAVA2WS_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_JAVA2WS_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-java2ws-includes]]`link:#quarkus-cxf_quarkus-cxf-java2ws-includes[quarkus.cxf.java2ws.includes]` - - -[.description] --- -A comma separated list of glob patterns for selecting class names which should be processed with `java2ws` tool. The glob syntax is specified in `io.quarkus.util.GlobUtil`. The patterns are matched against fully qualified class names, such as `org.acme.MyClass`. - -The universe of class names to which `includes` and `excludes` are applied is defined as follows: 1. Only classes link:https://quarkus.io/guides/cdi-reference#bean_discovery[visible in Jandex] are considered. 2. From those, only the ones annotated with `@WebService` are selected. - -Examples: - -Let's say that the application contains two classes annotated with `@WebService` and that both are visible in Jandex. Their names are `org.foo.FruitWebService` and `org.bar.HelloWebService`. - -Then - - - `quarkus.cxf.java2ws.includes = ++**++.++*++WebService` will match both class names - - `quarkus.cxf.java2ws.includes = org.foo.++*++` will match only `org.foo.FruitWebService` There is a separate `java2ws` execution for each of the matching class names. If you need different `additional-params` for each class, you may want to define a separate named parameter set for each one of them. Here is an example: - -``` -# Parameters for the foo package -quarkus.cxf.java2ws.foo-params.includes = org.foo.* -quarkus.cxf.java2ws.foo-params.additional-params = -servicename,FruitService -# Parameters for the bar package -quarkus.cxf.java2ws.bar-params.includes = org.bar.* -quarkus.cxf.java2ws.bar-params.additional-params = -servicename,HelloService -``` - - - -There is no default value for this option, so `java2ws` WSDL generation is effectively disabled by default. - -Specifying `quarkus.cxf.java2ws.excludes` without setting any `includes` will cause a build time error. - -Make sure that the class names selected by `quarkus.cxf.java2ws.includes` and `quarkus.cxf.java2ws.++[++whatever-name++]++.includes` do not overlap. Otherwise a build time exception will be thrown. - -If you would like to include the generated WSDL files in native image, you need to add them yourself using `quarkus.native.resources.includes/excludes`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_JAVA2WS_INCLUDES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_JAVA2WS_INCLUDES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-java2ws-excludes]]`link:#quarkus-cxf_quarkus-cxf-java2ws-excludes[quarkus.cxf.java2ws.excludes]` - - -[.description] --- -A comma separated list of glob patterns for selecting java class names which should *not* be processed with `java2ws` tool. Same syntax as `includes`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_JAVA2WS_EXCLUDES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_JAVA2WS_EXCLUDES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-java2ws-additional-params]]`link:#quarkus-cxf_quarkus-cxf-java2ws-additional-params[quarkus.cxf.java2ws.additional-params]` - - -[.description] --- -A comma separated list of additional command line parameters that should be passed to CXF `java2ws` tool along with the files selected by `includes` and `excludes`. Example: `-portname,12345`. Check link:https://cxf.apache.org/docs/java-to-ws.html[`java2ws` documentation] for all supported options. - -Note that only options related to generation of WSDL from Java are supported currently. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_JAVA2WS_ADDITIONAL_PARAMS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_JAVA2WS_ADDITIONAL_PARAMS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-java2ws-wsdl-name-template]]`link:#quarkus-cxf_quarkus-cxf-java2ws-wsdl-name-template[quarkus.cxf.java2ws.wsdl-name-template]` - - -[.description] --- -A template for the names of generated WSDL files. - -There are 4 place holders, which can be used in the template: - - - `%SIMPLE_CLASS_NAME%` - the simple class name of the Java class from which we are generating - - `%FULLY_QUALIFIED_CLASS_NAME%` - the fully qualified name from which we are generating with all dots are replaced replaced by underscores - - `%TARGET_DIR%` - the target directory of the current module of the current build tool; typically `target` for Maven and `build` for Gradle. - - `%CLASSES_DIR%` - the compiler output directory of the current module of the current build tool; typically `target/classes` for Maven and `build/classes` for Gradle. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_JAVA2WS_WSDL_NAME_TEMPLATE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_JAVA2WS_WSDL_NAME_TEMPLATE+++` -endif::add-copy-button-to-env-var[] ---|string -|`%CLASSES_DIR%/wsdl/%SIMPLE_CLASS_NAME%.wsdl` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-http-conduit-factory]]`link:#quarkus-cxf_quarkus-cxf-http-conduit-factory[quarkus.cxf.http-conduit-factory]` - - -[.description] --- -Select the `HTTPConduitFactory` implementation for all clients except the ones that override this setting via `quarkus.cxf.client.myClient.http-conduit-factory`. - - - `QuarkusCXFDefault` (default): if `io.quarkiverse.cxf:quarkus-cxf-rt-transports-http-hc5` is present in class path, then its `HTTPConduitFactory` implementation will be used; otherwise this value is equivalent with `URLConnectionHTTPConduitFactory` (this may change, once issue link:https://github.com/quarkiverse/quarkus-cxf/issues/992[++#++992] gets resolved in CXF) - - `CXFDefault`: the selection of `HTTPConduitFactory` implementation is left to CXF - - `HttpClientHTTPConduitFactory`: the `HTTPConduitFactory` will be set to an implementation always returning `org.apache.cxf.transport.http.HttpClientHTTPConduit`. This will use `java.net.http.HttpClient` as the underlying HTTP client. - - `URLConnectionHTTPConduitFactory`: the `HTTPConduitFactory` will be set to an implementation always returning `org.apache.cxf.transport.http.URLConnectionHTTPConduit`. This will use `java.net.HttpURLConnection` as the underlying HTTP client. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_HTTP_CONDUIT_FACTORY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_HTTP_CONDUIT_FACTORY+++` -endif::add-copy-button-to-env-var[] --- a| -`QuarkusCXFDefault`, `CXFDefault`, `HttpClientHTTPConduitFactory`, `URLConnectionHTTPConduitFactory` -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-path]]`link:#quarkus-cxf_quarkus-cxf-path[quarkus.cxf.path]` - - -[.description] --- -The default path for CXF resources. - -⚠️ Note that the default value before Quarkus CXF version 2.0.0 was `/`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_PATH+++` -endif::add-copy-button-to-env-var[] ---|string -|`/services` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-min-chunk-size]]`link:#quarkus-cxf_quarkus-cxf-min-chunk-size[quarkus.cxf.min-chunk-size]` - - -[.description] --- -The size in bytes of the chunks of memory allocated when writing data. - -This is a very advanced setting that should only be set if you understand exactly how it affects the output IO operations of the application. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_MIN_CHUNK_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_MIN_CHUNK_SIZE+++` -endif::add-copy-button-to-env-var[] ---|int -|`128` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-output-buffer-size]]`link:#quarkus-cxf_quarkus-cxf-output-buffer-size[quarkus.cxf.output-buffer-size]` - - -[.description] --- -The size of the output stream response buffer in bytes. If a response is larger than this and no content-length is provided then the response will be chunked. - -Larger values may give slight performance increases for large responses, at the expense of more memory usage. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_OUTPUT_BUFFER_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_OUTPUT_BUFFER_SIZE+++` -endif::add-copy-button-to-env-var[] ---|int -|`8191` - - -a| [[quarkus-cxf_quarkus-cxf-decoupled-endpoint-base]]`link:#quarkus-cxf_quarkus-cxf-decoupled-endpoint-base[quarkus.cxf.decoupled-endpoint-base]` - - -[.description] --- -An URI base to use as a prefix of `quarkus.cxf.client.myClient.decoupled-endpoint`. You will typically want to set this to something like the following: - -``` -quarkus.cxf.decoupled-endpoint-base = https://api.example.com:${quarkus.http.ssl-port}${quarkus.cxf.path} -# or for plain HTTP -quarkus.cxf.decoupled-endpoint-base = http://api.example.com:${quarkus.http.port}${quarkus.cxf.path} -``` - -If you invoke your WS client from within a HTTP handler, you can leave this option unspecified and rather set it dynamically on the request context of your WS client using the `org.apache.cxf.ws.addressing.decoupled.endpoint.base` key. Here is an example how to do that from a RESTeasy handler method: - -``` -import java.util.Map; -import jakarta.inject.Inject; -import jakarta.ws.rs.POST; -import jakarta.ws.rs.Path; -import jakarta.ws.rs.Produces; -import jakarta.ws.rs.core.Context; -import jakarta.ws.rs.core.MediaType; -import jakarta.ws.rs.core.UriInfo; -import jakarta.xml.ws.BindingProvider; -import io.quarkiverse.cxf.annotation.CXFClient; -import org.eclipse.microprofile.config.inject.ConfigProperty; - -@Path("/my-rest") -public class MyRestEasyResource { - - @Inject - @CXFClient("hello") - HelloService helloService; - - @ConfigProperty(name = "quarkus.cxf.path") - String quarkusCxfPath; - - @POST - @Path("/hello") - @Produces(MediaType.TEXT_PLAIN) - public String hello(String body, @Context UriInfo uriInfo) throws IOException { - - // You may consider doing this only once if you are sure that your service is accessed - // through a single hostname - String decoupledEndpointBase = uriInfo.getBaseUriBuilder().path(quarkusCxfPath); - Map>String, Object< requestContext = ((BindingProvider) helloService).getRequestContext(); - requestContext.put("org.apache.cxf.ws.addressing.decoupled.endpoint.base", decoupledEndpointBase); - - return wsrmHelloService.hello(body); - } -} -``` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_DECOUPLED_ENDPOINT_BASE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_DECOUPLED_ENDPOINT_BASE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-logging-enabled-for]]`link:#quarkus-cxf_quarkus-cxf-logging-enabled-for[quarkus.cxf.logging.enabled-for]` - - -[.description] --- -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 `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-enabled[quarkus.cxf.endpoint."endpoints".logging.enabled]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-enabled[quarkus.cxf.client."clients".logging.enabled]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_ENABLED_FOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_ENABLED_FOR+++` -endif::add-copy-button-to-env-var[] --- a| -`clients`, `services`, `both`, `none` -|`none` - - -a| [[quarkus-cxf_quarkus-cxf-logging-pretty]]`link:#quarkus-cxf_quarkus-cxf-logging-pretty[quarkus.cxf.logging.pretty]` - - -[.description] --- -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 `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-pretty[quarkus.cxf.endpoint."endpoints".logging.pretty]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-pretty[quarkus.cxf.client."clients".logging.pretty]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_PRETTY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_PRETTY+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf_quarkus-cxf-logging-limit]]`link:#quarkus-cxf_quarkus-cxf-logging-limit[quarkus.cxf.logging.limit]` - - -[.description] --- -A message length in bytes at which it is truncated in the log. This setting can be overridden per client or service endpoint using `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-limit[quarkus.cxf.endpoint."endpoints".logging.limit]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-limit[quarkus.cxf.client."clients".logging.limit]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_LIMIT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_LIMIT+++` -endif::add-copy-button-to-env-var[] ---|int -|`49152` - - -a| [[quarkus-cxf_quarkus-cxf-logging-in-mem-threshold]]`link:#quarkus-cxf_quarkus-cxf-logging-in-mem-threshold[quarkus.cxf.logging.in-mem-threshold]` - - -[.description] --- -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 `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-in-mem-threshold[quarkus.cxf.endpoint."endpoints".logging.in-mem-threshold]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-in-mem-threshold[quarkus.cxf.client."clients".logging.in-mem-threshold]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_IN_MEM_THRESHOLD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_IN_MEM_THRESHOLD+++` -endif::add-copy-button-to-env-var[] ---|long -|`-1` - - -a| [[quarkus-cxf_quarkus-cxf-logging-log-binary]]`link:#quarkus-cxf_quarkus-cxf-logging-log-binary[quarkus.cxf.logging.log-binary]` - - -[.description] --- -If `true`, binary payloads will be logged; otherwise they won't be logged. This setting can be overridden per client or service endpoint using `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-log-binary[quarkus.cxf.endpoint."endpoints".logging.log-binary]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-log-binary[quarkus.cxf.client."clients".logging.log-binary]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_LOG_BINARY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_LOG_BINARY+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf_quarkus-cxf-logging-log-multipart]]`link:#quarkus-cxf_quarkus-cxf-logging-log-multipart[quarkus.cxf.logging.log-multipart]` - - -[.description] --- -If `true`, multipart payloads will be logged; otherwise they won't be logged. This setting can be overridden per client or service endpoint using `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-log-multipart[quarkus.cxf.endpoint."endpoints".logging.log-multipart]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-log-multipart[quarkus.cxf.client."clients".logging.log-multipart]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_LOG_MULTIPART+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_LOG_MULTIPART+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf_quarkus-cxf-logging-verbose]]`link:#quarkus-cxf_quarkus-cxf-logging-verbose[quarkus.cxf.logging.verbose]` - - -[.description] --- -If `true`, verbose logging will be enabled; otherwise it won't be enabled. This setting can be overridden per client or service endpoint using `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-verbose[quarkus.cxf.endpoint."endpoints".logging.verbose]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-verbose[quarkus.cxf.client."clients".logging.verbose]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_VERBOSE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_VERBOSE+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf_quarkus-cxf-logging-in-binary-content-media-types]]`link:#quarkus-cxf_quarkus-cxf-logging-in-binary-content-media-types[quarkus.cxf.logging.in-binary-content-media-types]` - - -[.description] --- -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 `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-in-binary-content-media-types[quarkus.cxf.endpoint."endpoints".logging.in-binary-content-media-types]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-in-binary-content-media-types[quarkus.cxf.client."clients".logging.in-binary-content-media-types]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_IN_BINARY_CONTENT_MEDIA_TYPES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_IN_BINARY_CONTENT_MEDIA_TYPES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-logging-out-binary-content-media-types]]`link:#quarkus-cxf_quarkus-cxf-logging-out-binary-content-media-types[quarkus.cxf.logging.out-binary-content-media-types]` - - -[.description] --- -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 `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-out-binary-content-media-types[quarkus.cxf.endpoint."endpoints".logging.out-binary-content-media-types]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-out-binary-content-media-types[quarkus.cxf.client."clients".logging.out-binary-content-media-types]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_OUT_BINARY_CONTENT_MEDIA_TYPES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_OUT_BINARY_CONTENT_MEDIA_TYPES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-logging-binary-content-media-types]]`link:#quarkus-cxf_quarkus-cxf-logging-binary-content-media-types[quarkus.cxf.logging.binary-content-media-types]` - - -[.description] --- -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 `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-binary-content-media-types[quarkus.cxf.endpoint."endpoints".logging.binary-content-media-types]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-binary-content-media-types[quarkus.cxf.client."clients".logging.binary-content-media-types]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_BINARY_CONTENT_MEDIA_TYPES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_BINARY_CONTENT_MEDIA_TYPES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-logging-sensitive-element-names]]`link:#quarkus-cxf_quarkus-cxf-logging-sensitive-element-names[quarkus.cxf.logging.sensitive-element-names]` - - -[.description] --- -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 `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-sensitive-element-names[quarkus.cxf.endpoint."endpoints".logging.sensitive-element-names]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-sensitive-element-names[quarkus.cxf.client."clients".logging.sensitive-element-names]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_SENSITIVE_ELEMENT_NAMES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_SENSITIVE_ELEMENT_NAMES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-logging-sensitive-protocol-header-names]]`link:#quarkus-cxf_quarkus-cxf-logging-sensitive-protocol-header-names[quarkus.cxf.logging.sensitive-protocol-header-names]` - - -[.description] --- -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 `link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-sensitive-protocol-header-names[quarkus.cxf.endpoint."endpoints".logging.sensitive-protocol-header-names]` or `link:#quarkus-cxf_quarkus-cxf-client-clients-logging-sensitive-protocol-header-names[quarkus.cxf.client."clients".logging.sensitive-protocol-header-names]` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_LOGGING_SENSITIVE_PROTOCOL_HEADER_NAMES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_LOGGING_SENSITIVE_PROTOCOL_HEADER_NAMES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-includes]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-includes[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".includes]` - - -[.description] --- -A comma separated list of glob patterns for selecting WSDL files which should be processed with `wsdl2java` tool. The paths are relative to `src/main/resources` or `src/test/resources` directories of the current Maven or Gradle module. The glob syntax is specified in `io.quarkus.util.GlobUtil`. - -Examples: - - - `calculator.wsdl,fruits.wsdl` will match `src/main/resources/calculator.wsdl` and `src/main/resources/fruits.wsdl` under the current Maven or Gradle module, but will not match anything like `src/main/resources/subdir/calculator.wsdl` - - `my-++*++-service.wsdl` will match `src/main/resources/my-foo-service.wsdl` and `src/main/resources/my-bar-service.wsdl` - - `++**++.wsdl` will match any of the above There is a separate `wsdl2java` execution for each of the matching WSDL files. If you need different `additional-params` for each WSDL file, you may want to define a separate named parameter set for each one of them. Here is an example: - -``` -# Parameters for foo.wsdl -quarkus.cxf.codegen.wsdl2java.foo-params.includes = wsdl/foo.wsdl -quarkus.cxf.codegen.wsdl2java.foo-params.wsdl-location = wsdl/foo.wsdl -# Parameters for bar.wsdl -quarkus.cxf.codegen.wsdl2java.bar-params.includes = wsdl/bar.wsdl -quarkus.cxf.codegen.wsdl2java.bar-params.wsdl-location = wsdl/bar.wsdl -quarkus.cxf.codegen.wsdl2java.bar-params.xjc = ts -``` - - - -Note that file extensions other than `.wsdl` will work during normal builds, but changes in the matching files may get overseen in Quarkus dev mode. Always using the `.wsdl` extension is thus recommended. - -There is no default value for this option, so `wsdl2java` code generation is disabled by default. - -Specifying `quarkus.cxf.codegen.wsdl2java.my-name.excludes` without setting any `includes` will cause a build time error. - -Make sure that the file sets selected by `quarkus.cxf.codegen.wsdl2java.includes` and `quarkus.cxf.codegen.wsdl2java.++[++whatever-name++]++.includes` do not overlap. Otherwise a build time exception will be thrown. - -The files from `src/main/resources` selected by `includes` and `excludes` are automatically included in native image and therefore you do not need to include them via `quarkus.cxf.wsdl-path` (deprecated) or `quarkus.native.resources.includes/excludes`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__INCLUDES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__INCLUDES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-excludes]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-excludes[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".excludes]` - - -[.description] --- -A comma separated list of path patterns for selecting WSDL files which should *not* be processed with `wsdl2java` tool. The paths are relative to `src/main/resources` or `src/test/resources` directories of the current Maven or Gradle module. Same syntax as `includes`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCLUDES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCLUDES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-output-directory]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-output-directory[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".output-directory]` - - -[.description] --- -A directory into which the generated files will be written, either absolute or relative to the current Maven or Gradle module directory. - -The default value is build tool dependent: for Maven, it is typically `target/generated-sources/wsdl2java`, while for Gradle it is `build/classes/java/quarkus-generated-sources/wsdl2java`. - -Quarkus tooling is only able to set up the default value as a source folder for the given build tool. If you set this to a custom path it is up to you to make sure that your build tool recognizes the path a as source folder. - -Also, if you choose a path outside `target` directory for Maven or outside `build` directory for Gradle, you need to take care for cleaning stale resources generated by previous builds. E.g. if you change the value of `package-names` option from `org.foo` to `org.bar` you need to take care for the removal of the removal of the old package `org.foo`. - -This will be passed as option `-d` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__OUTPUT_DIRECTORY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__OUTPUT_DIRECTORY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-package-names]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-package-names[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".package-names]` - - -[.description] --- -A comma separated list of tokens; each token can be one of the following: - - - A Java package under which the Java source files should be generated - - A string of the form `namespaceURI=packageName` - in this case the entities coming from the given namespace URI will be generated under the given Java package. - -This will be passed as option `-p` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__PACKAGE_NAMES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__PACKAGE_NAMES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-exclude-namespace-uris]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-exclude-namespace-uris[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".exclude-namespace-uris]` - - -[.description] --- -A comma separated list of WSDL schema namespace URIs to ignore when generating Java code. - -This will be passed as option `-nexclude` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCLUDE_NAMESPACE_URIS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCLUDE_NAMESPACE_URIS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-service-name]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-service-name[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".service-name]` - - -[.description] --- -The WSDL service name to use for the generated code. - -This will be passed as option `-sn` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__SERVICE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__SERVICE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-bindings]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-bindings[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".bindings]` - - -[.description] --- -A list of paths pointing at JAXWS or JAXB binding files or XMLBeans context files. The path to be either absolute or relative to the current Maven or Gradle module. - -This will be passed as option `-b` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__BINDINGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__BINDINGS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-validate]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-validate[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".validate]` - - -[.description] --- -If `true`, WSDLs are validated before processing; otherwise the WSDLs are not validated. - -This will be passed as option `-validate` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__VALIDATE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__VALIDATE+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-wsdl-location]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-wsdl-location[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".wsdl-location]` - - -[.description] --- -Specifies the value of the `@WebServiceClient` annotation's wsdlLocation property. - -This will be passed as option `-wsdlLocation` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__WSDL_LOCATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__WSDL_LOCATION+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-xjc]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-xjc[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".xjc]` - - -[.description] --- -A comma separated list of XJC extensions to enable. The following extensions are available through `io.quarkiverse.cxf:quarkus-cxf-xjc-plugins` dependency: - - - `bg` - generate `getX()` methods for boolean fields instead of `isX()` - - `bgi` - generate both `isX()` and `getX()` methods for boolean fields - - `dv` - initialize fields mapped from elements/attributes with their default values - - `javadoc` - generates JavaDoc based on `xsd:documentation` - - `property-listener` - add a property listener and the code for triggering the property change events to setter methods - - `ts` - generate `toString()` methods - - `wsdlextension` - generate WSDL extension methods in root classes - -These values correspond to `-wsdl2java` options `-xjc-Xbg`, `-xjc-Xbgi`, `-xjc-Xdv`, `-xjc-Xjavadoc`, `-xjc-Xproperty-listener`, `-xjc-Xts` and `-xjc-Xwsdlextension` respectively. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__XJC+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__XJC+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-exception-super]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-exception-super[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".exception-super]` - - -[.description] --- -A fully qualified class name to use as a superclass for fault beans generated from `wsdl:fault` elements - -This will be passed as option `-exceptionSuper` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCEPTION_SUPER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__EXCEPTION_SUPER+++` -endif::add-copy-button-to-env-var[] ---|string -|`java.lang.Exception` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-async-methods]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-async-methods[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".async-methods]` - - -[.description] --- -A comma separated list of SEI methods for which asynchronous sibling methods should be generated; similar to `enableAsyncMapping` in a JAX-WS binding file - -This will be passed as option `-asyncMethods` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__ASYNC_METHODS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__ASYNC_METHODS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-bare-methods]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-bare-methods[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".bare-methods]` - - -[.description] --- -A comma separated list of SEI methods for which wrapper style sibling methods should be generated; similar to `enableWrapperStyle` in JAX-WS binding file - -This will be passed as option `-bareMethods` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__BARE_METHODS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__BARE_METHODS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-mime-methods]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-mime-methods[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".mime-methods]` - - -[.description] --- -A comma separated list of SEI methods for which `mime:content` mapping should be enabled; similar to `enableMIMEContent` in JAX-WS binding file - -This will be passed as option `-mimeMethods` to `wsdl2java` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__MIME_METHODS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__MIME_METHODS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-additional-params]]`link:#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-named-parameter-sets-additional-params[quarkus.cxf.codegen.wsdl2java."named-parameter-sets".additional-params]` - - -[.description] --- -A comma separated list of additional command line parameters that should be passed to CXF `wsdl2java` tool along with the files selected by `includes` and `excludes`. Example: `-keep,-dex,false`. Check link:https://cxf.apache.org/docs/wsdl-to-java.html[`wsdl2java` documentation] for all supported options. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__ADDITIONAL_PARAMS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CODEGEN_WSDL2JAVA__NAMED_PARAMETER_SETS__ADDITIONAL_PARAMS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-java2ws-named-parameter-sets-includes]]`link:#quarkus-cxf_quarkus-cxf-java2ws-named-parameter-sets-includes[quarkus.cxf.java2ws."named-parameter-sets".includes]` - - -[.description] --- -A comma separated list of glob patterns for selecting class names which should be processed with `java2ws` tool. The glob syntax is specified in `io.quarkus.util.GlobUtil`. The patterns are matched against fully qualified class names, such as `org.acme.MyClass`. - -The universe of class names to which `includes` and `excludes` are applied is defined as follows: 1. Only classes link:https://quarkus.io/guides/cdi-reference#bean_discovery[visible in Jandex] are considered. 2. From those, only the ones annotated with `@WebService` are selected. - -Examples: - -Let's say that the application contains two classes annotated with `@WebService` and that both are visible in Jandex. Their names are `org.foo.FruitWebService` and `org.bar.HelloWebService`. - -Then - - - `quarkus.cxf.java2ws.includes = ++**++.++*++WebService` will match both class names - - `quarkus.cxf.java2ws.includes = org.foo.++*++` will match only `org.foo.FruitWebService` There is a separate `java2ws` execution for each of the matching class names. If you need different `additional-params` for each class, you may want to define a separate named parameter set for each one of them. Here is an example: - -``` -# Parameters for the foo package -quarkus.cxf.java2ws.foo-params.includes = org.foo.* -quarkus.cxf.java2ws.foo-params.additional-params = -servicename,FruitService -# Parameters for the bar package -quarkus.cxf.java2ws.bar-params.includes = org.bar.* -quarkus.cxf.java2ws.bar-params.additional-params = -servicename,HelloService -``` - - - -There is no default value for this option, so `java2ws` WSDL generation is effectively disabled by default. - -Specifying `quarkus.cxf.java2ws.excludes` without setting any `includes` will cause a build time error. - -Make sure that the class names selected by `quarkus.cxf.java2ws.includes` and `quarkus.cxf.java2ws.++[++whatever-name++]++.includes` do not overlap. Otherwise a build time exception will be thrown. - -If you would like to include the generated WSDL files in native image, you need to add them yourself using `quarkus.native.resources.includes/excludes`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__INCLUDES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__INCLUDES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-java2ws-named-parameter-sets-excludes]]`link:#quarkus-cxf_quarkus-cxf-java2ws-named-parameter-sets-excludes[quarkus.cxf.java2ws."named-parameter-sets".excludes]` - - -[.description] --- -A comma separated list of glob patterns for selecting java class names which should *not* be processed with `java2ws` tool. Same syntax as `includes`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__EXCLUDES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__EXCLUDES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-java2ws-named-parameter-sets-additional-params]]`link:#quarkus-cxf_quarkus-cxf-java2ws-named-parameter-sets-additional-params[quarkus.cxf.java2ws."named-parameter-sets".additional-params]` - - -[.description] --- -A comma separated list of additional command line parameters that should be passed to CXF `java2ws` tool along with the files selected by `includes` and `excludes`. Example: `-portname,12345`. Check link:https://cxf.apache.org/docs/java-to-ws.html[`java2ws` documentation] for all supported options. - -Note that only options related to generation of WSDL from Java are supported currently. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__ADDITIONAL_PARAMS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__ADDITIONAL_PARAMS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-java2ws-named-parameter-sets-wsdl-name-template]]`link:#quarkus-cxf_quarkus-cxf-java2ws-named-parameter-sets-wsdl-name-template[quarkus.cxf.java2ws."named-parameter-sets".wsdl-name-template]` - - -[.description] --- -A template for the names of generated WSDL files. - -There are 4 place holders, which can be used in the template: - - - `%SIMPLE_CLASS_NAME%` - the simple class name of the Java class from which we are generating - - `%FULLY_QUALIFIED_CLASS_NAME%` - the fully qualified name from which we are generating with all dots are replaced replaced by underscores - - `%TARGET_DIR%` - the target directory of the current module of the current build tool; typically `target` for Maven and `build` for Gradle. - - `%CLASSES_DIR%` - the compiler output directory of the current module of the current build tool; typically `target/classes` for Maven and `build/classes` for Gradle. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__WSDL_NAME_TEMPLATE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_JAVA2WS__NAMED_PARAMETER_SETS__WSDL_NAME_TEMPLATE+++` -endif::add-copy-button-to-env-var[] ---|string -|`%CLASSES_DIR%/wsdl/%SIMPLE_CLASS_NAME%.wsdl` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-client-clients-service-interface]]`link:#quarkus-cxf_quarkus-cxf-client-clients-service-interface[quarkus.cxf.client."clients".service-interface]` - - -[.description] --- -The client service interface class name - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SERVICE_INTERFACE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SERVICE_INTERFACE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-client-clients-alternative]]`link:#quarkus-cxf_quarkus-cxf-client-clients-alternative[quarkus.cxf.client."clients".alternative]` - - -[.description] --- -Indicates whether this is an alternative proxy client configuration. If true, then this configuration is ignored when configuring a client without annotation `@CXFClient`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__ALTERNATIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__ALTERNATIVE+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-cxf_quarkus-cxf-client-clients-native-runtime-initialized]]`link:#quarkus-cxf_quarkus-cxf-client-clients-native-runtime-initialized[quarkus.cxf.client."clients".native.runtime-initialized]` - - -[.description] --- -If `true`, the client dynamic proxy class generated by native compiler will be initialized at runtime; otherwise the proxy class will be initialized at build time. - -Setting this to `true` makes sense if your service endpoint interface references some class initialized at runtime in its method signatures. E.g. Say, your service interface has method `int add(Operands o)` and the `Operands` class was requested to be initialized at runtime. Then, without setting this configuration parameter to `true`, the native compiler will throw an exception saying something like `Classes that should be initialized at run time got initialized during image building: org.acme.Operands ... jdk.proxy.$Proxy caused initialization of this class`. `jdk.proxy.$Proxy` is the proxy class generated by the native compiler. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__NATIVE_RUNTIME_INITIALIZED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__NATIVE_RUNTIME_INITIALIZED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-implementor]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-implementor[quarkus.cxf.endpoint."endpoints".implementor]` - - -[.description] --- -The service endpoint implementation class - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__IMPLEMENTOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__IMPLEMENTOR+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-wsdl]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-wsdl[quarkus.cxf.endpoint."endpoints".wsdl]` - - -[.description] --- -The service endpoint WSDL path - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__WSDL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__WSDL+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-soap-binding]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-soap-binding[quarkus.cxf.endpoint."endpoints".soap-binding]` - - -[.description] --- -The URL of the SOAP Binding, should be one of four values: - -* `+http://schemas.xmlsoap.org/wsdl/soap/http+` for SOAP11HTTP_BINDING -* `+http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true+` for SOAP11HTTP_MTOM_BINDING -* `+http://www.w3.org/2003/05/soap/bindings/HTTP/+` for SOAP12HTTP_BINDING -* `+http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true+` for SOAP12HTTP_MTOM_BINDING - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SOAP_BINDING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SOAP_BINDING+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-published-endpoint-url]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-published-endpoint-url[quarkus.cxf.endpoint."endpoints".published-endpoint-url]` - - -[.description] --- -The published service endpoint URL - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__PUBLISHED_ENDPOINT_URL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__PUBLISHED_ENDPOINT_URL+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-enabled]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-enabled[quarkus.cxf.endpoint."endpoints".logging.enabled]` - - -[.description] --- -If `true` or `pretty`, the message logging will be enabled; otherwise it will not be enabled. If the value is `pretty` (since 2.7.0), the `pretty` attribute will effectively be set to `true`. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-enabled-for[quarkus.cxf.logging.enabled-for]`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_ENABLED+++` -endif::add-copy-button-to-env-var[] --- a| -`true`, `false`, `pretty` -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-pretty]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-pretty[quarkus.cxf.endpoint."endpoints".logging.pretty]` - - -[.description] --- -If `true`, the XML elements will be indented in the log; otherwise they will appear unindented. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-pretty[quarkus.cxf.logging.pretty]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_PRETTY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_PRETTY+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-limit]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-limit[quarkus.cxf.endpoint."endpoints".logging.limit]` - - -[.description] --- -A message length in bytes at which it is truncated in the log. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-limit[quarkus.cxf.logging.limit]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_LIMIT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_LIMIT+++` -endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-in-mem-threshold]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-in-mem-threshold[quarkus.cxf.endpoint."endpoints".logging.in-mem-threshold]` - - -[.description] --- -A message length in bytes at which it will be written to disk. `-1` is unlimited. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-in-mem-threshold[quarkus.cxf.logging.in-mem-threshold]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_IN_MEM_THRESHOLD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_IN_MEM_THRESHOLD+++` -endif::add-copy-button-to-env-var[] ---|long -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-log-binary]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-log-binary[quarkus.cxf.endpoint."endpoints".logging.log-binary]` - - -[.description] --- -If `true`, binary payloads will be logged; otherwise they won't be logged. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-log-binary[quarkus.cxf.logging.log-binary]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_LOG_BINARY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_LOG_BINARY+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-log-multipart]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-log-multipart[quarkus.cxf.endpoint."endpoints".logging.log-multipart]` - - -[.description] --- -If `true`, multipart payloads will be logged; otherwise they won't be logged. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-log-multipart[quarkus.cxf.logging.log-multipart]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_LOG_MULTIPART+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_LOG_MULTIPART+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-verbose]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-verbose[quarkus.cxf.endpoint."endpoints".logging.verbose]` - - -[.description] --- -If `true`, verbose logging will be enabled; otherwise it won't be enabled. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-verbose[quarkus.cxf.logging.verbose]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_VERBOSE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_VERBOSE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-in-binary-content-media-types]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-in-binary-content-media-types[quarkus.cxf.endpoint."endpoints".logging.in-binary-content-media-types]` - - -[.description] --- -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`. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-in-binary-content-media-types[quarkus.cxf.logging.in-binary-content-media-types]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_IN_BINARY_CONTENT_MEDIA_TYPES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_IN_BINARY_CONTENT_MEDIA_TYPES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-out-binary-content-media-types]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-out-binary-content-media-types[quarkus.cxf.endpoint."endpoints".logging.out-binary-content-media-types]` - - -[.description] --- -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`. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-out-binary-content-media-types[quarkus.cxf.logging.out-binary-content-media-types]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_OUT_BINARY_CONTENT_MEDIA_TYPES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_OUT_BINARY_CONTENT_MEDIA_TYPES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-binary-content-media-types]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-binary-content-media-types[quarkus.cxf.endpoint."endpoints".logging.binary-content-media-types]` - - -[.description] --- -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`. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-binary-content-media-types[quarkus.cxf.logging.binary-content-media-types]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_BINARY_CONTENT_MEDIA_TYPES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_BINARY_CONTENT_MEDIA_TYPES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-sensitive-element-names]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-sensitive-element-names[quarkus.cxf.endpoint."endpoints".logging.sensitive-element-names]` - - -[.description] --- -A comma separated list of XML elements containing sensitive information to be masked in the log. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-sensitive-element-names[quarkus.cxf.logging.sensitive-element-names]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_SENSITIVE_ELEMENT_NAMES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_SENSITIVE_ELEMENT_NAMES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-sensitive-protocol-header-names]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-logging-sensitive-protocol-header-names[quarkus.cxf.endpoint."endpoints".logging.sensitive-protocol-header-names]` - - -[.description] --- -A comma separated list of protocol headers containing sensitive information to be masked in the log. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-sensitive-protocol-header-names[quarkus.cxf.logging.sensitive-protocol-header-names]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_SENSITIVE_PROTOCOL_HEADER_NAMES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__LOGGING_SENSITIVE_PROTOCOL_HEADER_NAMES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-features]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-features[quarkus.cxf.endpoint."endpoints".features]` - - -[.description] --- -A comma-separated list of fully qualified CXF Feature class names or named CDI beans. - -Examples: - -``` -quarkus.cxf.endpoint."/hello".features = org.apache.cxf.ext.logging.LoggingFeature -quarkus.cxf.endpoint."/fruit".features = #myCustomLoggingFeature -``` - -In the second case, the `++#++myCustomLoggingFeature` bean can be produced as follows: - -``` -import org.apache.cxf.ext.logging.LoggingFeature; -import javax.enterprise.context.ApplicationScoped; -import javax.enterprise.inject.Produces; - -class Producers { - - @Produces - @ApplicationScoped - LoggingFeature myCustomLoggingFeature() { - LoggingFeature loggingFeature = new LoggingFeature(); - loggingFeature.setPrettyLogging(true); - return loggingFeature; - } -} -``` - - - -Note that the `LoggingFeature` is available through the link:../extensions/quarkus-cxf-rt-features-logging.html[Logging Feature] extension. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__FEATURES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__FEATURES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-handlers]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-handlers[quarkus.cxf.endpoint."endpoints".handlers]` - - -[.description] --- -The comma-separated list of Handler classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__HANDLERS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__HANDLERS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-in-interceptors]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-in-interceptors[quarkus.cxf.endpoint."endpoints".in-interceptors]` - - -[.description] --- -The comma-separated list of InInterceptor classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__IN_INTERCEPTORS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__IN_INTERCEPTORS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-out-interceptors]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-out-interceptors[quarkus.cxf.endpoint."endpoints".out-interceptors]` - - -[.description] --- -The comma-separated list of OutInterceptor classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__OUT_INTERCEPTORS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__OUT_INTERCEPTORS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-out-fault-interceptors]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-out-fault-interceptors[quarkus.cxf.endpoint."endpoints".out-fault-interceptors]` - - -[.description] --- -The comma-separated list of OutFaultInterceptor classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__OUT_FAULT_INTERCEPTORS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__OUT_FAULT_INTERCEPTORS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-in-fault-interceptors]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-in-fault-interceptors[quarkus.cxf.endpoint."endpoints".in-fault-interceptors]` - - -[.description] --- -The comma-separated list of InFaultInterceptor classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__IN_FAULT_INTERCEPTORS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__IN_FAULT_INTERCEPTORS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-endpoint-endpoints-schema-validation-enabled-for]]`link:#quarkus-cxf_quarkus-cxf-endpoint-endpoints-schema-validation-enabled-for[quarkus.cxf.endpoint."endpoints".schema-validation.enabled-for]` - - -[.description] --- -Select for which messages XML Schema validation should be enabled. If not specified, no XML Schema validation will be enforced unless it is enabled by other means, such as `&++#++64;org.apache.cxf.annotations.SchemaValidation` or `&++#++64;org.apache.cxf.annotations.EndpointProperty(key = "schema-validation-enabled", value = "true")` annotations. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SCHEMA_VALIDATION_ENABLED_FOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_ENDPOINT__ENDPOINTS__SCHEMA_VALIDATION_ENABLED_FOR+++` -endif::add-copy-button-to-env-var[] --- a| -`in`, `request`, `out`, `response`, `both`, `none` -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-wsdl]]`link:#quarkus-cxf_quarkus-cxf-client-clients-wsdl[quarkus.cxf.client."clients".wsdl]` - - -[.description] --- -A URL, resource path or local filesystem path pointing to a WSDL document to use when generating the service proxy of this client. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__WSDL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__WSDL+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-soap-binding]]`link:#quarkus-cxf_quarkus-cxf-client-clients-soap-binding[quarkus.cxf.client."clients".soap-binding]` - - -[.description] --- -The URL of the SOAP Binding, should be one of four values: - -* `+http://schemas.xmlsoap.org/wsdl/soap/http+` for SOAP11HTTP_BINDING -* `+http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true+` for SOAP11HTTP_MTOM_BINDING -* `+http://www.w3.org/2003/05/soap/bindings/HTTP/+` for SOAP12HTTP_BINDING -* `+http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true+` for SOAP12HTTP_MTOM_BINDING - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SOAP_BINDING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SOAP_BINDING+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-client-endpoint-url]]`link:#quarkus-cxf_quarkus-cxf-client-clients-client-endpoint-url[quarkus.cxf.client."clients".client-endpoint-url]` - - -[.description] --- -The client endpoint URL - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__CLIENT_ENDPOINT_URL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__CLIENT_ENDPOINT_URL+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-endpoint-namespace]]`link:#quarkus-cxf_quarkus-cxf-client-clients-endpoint-namespace[quarkus.cxf.client."clients".endpoint-namespace]` - - -[.description] --- -The client endpoint namespace - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__ENDPOINT_NAMESPACE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__ENDPOINT_NAMESPACE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-endpoint-name]]`link:#quarkus-cxf_quarkus-cxf-client-clients-endpoint-name[quarkus.cxf.client."clients".endpoint-name]` - - -[.description] --- -The client endpoint name - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__ENDPOINT_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__ENDPOINT_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-username]]`link:#quarkus-cxf_quarkus-cxf-client-clients-username[quarkus.cxf.client."clients".username]` - - -[.description] --- -The username for HTTP Basic authentication - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-password]]`link:#quarkus-cxf_quarkus-cxf-client-clients-password[quarkus.cxf.client."clients".password]` - - -[.description] --- -The password for HTTP Basic authentication - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-secure-wsdl-access]]`link:#quarkus-cxf_quarkus-cxf-client-clients-secure-wsdl-access[quarkus.cxf.client."clients".secure-wsdl-access]` - - -[.description] --- -If `true`, then the `Authentication` header will be sent preemptively when requesting the WSDL, as long as the `username` is set; otherwise the WSDL will be requested anonymously. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SECURE_WSDL_ACCESS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SECURE_WSDL_ACCESS+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-enabled]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-enabled[quarkus.cxf.client."clients".logging.enabled]` - - -[.description] --- -If `true` or `pretty`, the message logging will be enabled; otherwise it will not be enabled. If the value is `pretty` (since 2.7.0), the `pretty` attribute will effectively be set to `true`. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-enabled-for[quarkus.cxf.logging.enabled-for]`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_ENABLED+++` -endif::add-copy-button-to-env-var[] --- a| -`true`, `false`, `pretty` -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-pretty]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-pretty[quarkus.cxf.client."clients".logging.pretty]` - - -[.description] --- -If `true`, the XML elements will be indented in the log; otherwise they will appear unindented. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-pretty[quarkus.cxf.logging.pretty]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_PRETTY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_PRETTY+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-limit]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-limit[quarkus.cxf.client."clients".logging.limit]` - - -[.description] --- -A message length in bytes at which it is truncated in the log. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-limit[quarkus.cxf.logging.limit]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_LIMIT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_LIMIT+++` -endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-in-mem-threshold]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-in-mem-threshold[quarkus.cxf.client."clients".logging.in-mem-threshold]` - - -[.description] --- -A message length in bytes at which it will be written to disk. `-1` is unlimited. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-in-mem-threshold[quarkus.cxf.logging.in-mem-threshold]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_IN_MEM_THRESHOLD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_IN_MEM_THRESHOLD+++` -endif::add-copy-button-to-env-var[] ---|long -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-log-binary]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-log-binary[quarkus.cxf.client."clients".logging.log-binary]` - - -[.description] --- -If `true`, binary payloads will be logged; otherwise they won't be logged. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-log-binary[quarkus.cxf.logging.log-binary]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_LOG_BINARY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_LOG_BINARY+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-log-multipart]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-log-multipart[quarkus.cxf.client."clients".logging.log-multipart]` - - -[.description] --- -If `true`, multipart payloads will be logged; otherwise they won't be logged. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-log-multipart[quarkus.cxf.logging.log-multipart]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_LOG_MULTIPART+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_LOG_MULTIPART+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-verbose]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-verbose[quarkus.cxf.client."clients".logging.verbose]` - - -[.description] --- -If `true`, verbose logging will be enabled; otherwise it won't be enabled. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-verbose[quarkus.cxf.logging.verbose]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_VERBOSE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_VERBOSE+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-in-binary-content-media-types]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-in-binary-content-media-types[quarkus.cxf.client."clients".logging.in-binary-content-media-types]` - - -[.description] --- -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`. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-in-binary-content-media-types[quarkus.cxf.logging.in-binary-content-media-types]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_IN_BINARY_CONTENT_MEDIA_TYPES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_IN_BINARY_CONTENT_MEDIA_TYPES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-out-binary-content-media-types]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-out-binary-content-media-types[quarkus.cxf.client."clients".logging.out-binary-content-media-types]` - - -[.description] --- -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`. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-out-binary-content-media-types[quarkus.cxf.logging.out-binary-content-media-types]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_OUT_BINARY_CONTENT_MEDIA_TYPES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_OUT_BINARY_CONTENT_MEDIA_TYPES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-binary-content-media-types]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-binary-content-media-types[quarkus.cxf.client."clients".logging.binary-content-media-types]` - - -[.description] --- -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`. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-binary-content-media-types[quarkus.cxf.logging.binary-content-media-types]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_BINARY_CONTENT_MEDIA_TYPES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_BINARY_CONTENT_MEDIA_TYPES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-sensitive-element-names]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-sensitive-element-names[quarkus.cxf.client."clients".logging.sensitive-element-names]` - - -[.description] --- -A comma separated list of XML elements containing sensitive information to be masked in the log. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-sensitive-element-names[quarkus.cxf.logging.sensitive-element-names]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_SENSITIVE_ELEMENT_NAMES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_SENSITIVE_ELEMENT_NAMES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-logging-sensitive-protocol-header-names]]`link:#quarkus-cxf_quarkus-cxf-client-clients-logging-sensitive-protocol-header-names[quarkus.cxf.client."clients".logging.sensitive-protocol-header-names]` - - -[.description] --- -A comma separated list of protocol headers containing sensitive information to be masked in the log. The default is given by `link:#quarkus-cxf_quarkus-cxf-logging-sensitive-protocol-header-names[quarkus.cxf.logging.sensitive-protocol-header-names]` - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_SENSITIVE_PROTOCOL_HEADER_NAMES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__LOGGING_SENSITIVE_PROTOCOL_HEADER_NAMES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-features]]`link:#quarkus-cxf_quarkus-cxf-client-clients-features[quarkus.cxf.client."clients".features]` - - -[.description] --- -A comma-separated list of fully qualified CXF Feature class names. - -Example: - -``` -quarkus.cxf.endpoint.myClient.features = org.apache.cxf.ext.logging.LoggingFeature -``` - - - -Note that the `LoggingFeature` is available through the link:../extensions/quarkus-cxf-rt-features-logging.html[Logging Feature] extension. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__FEATURES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__FEATURES+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-handlers]]`link:#quarkus-cxf_quarkus-cxf-client-clients-handlers[quarkus.cxf.client."clients".handlers]` - - -[.description] --- -The comma-separated list of Handler classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__HANDLERS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__HANDLERS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-in-interceptors]]`link:#quarkus-cxf_quarkus-cxf-client-clients-in-interceptors[quarkus.cxf.client."clients".in-interceptors]` - - -[.description] --- -The comma-separated list of InInterceptor classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__IN_INTERCEPTORS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__IN_INTERCEPTORS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-out-interceptors]]`link:#quarkus-cxf_quarkus-cxf-client-clients-out-interceptors[quarkus.cxf.client."clients".out-interceptors]` - - -[.description] --- -The comma-separated list of OutInterceptor classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__OUT_INTERCEPTORS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__OUT_INTERCEPTORS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-out-fault-interceptors]]`link:#quarkus-cxf_quarkus-cxf-client-clients-out-fault-interceptors[quarkus.cxf.client."clients".out-fault-interceptors]` - - -[.description] --- -The comma-separated list of OutFaultInterceptor classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__OUT_FAULT_INTERCEPTORS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__OUT_FAULT_INTERCEPTORS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-in-fault-interceptors]]`link:#quarkus-cxf_quarkus-cxf-client-clients-in-fault-interceptors[quarkus.cxf.client."clients".in-fault-interceptors]` - - -[.description] --- -The comma-separated list of InFaultInterceptor classes - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__IN_FAULT_INTERCEPTORS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__IN_FAULT_INTERCEPTORS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-connection-timeout]]`link:#quarkus-cxf_quarkus-cxf-client-clients-connection-timeout[quarkus.cxf.client."clients".connection-timeout]` - - -[.description] --- -Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. 0 is infinite. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__CONNECTION_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__CONNECTION_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|long -|`30000` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-receive-timeout]]`link:#quarkus-cxf_quarkus-cxf-client-clients-receive-timeout[quarkus.cxf.client."clients".receive-timeout]` - - -[.description] --- -Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. 0 is infinite. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__RECEIVE_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__RECEIVE_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|long -|`60000` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-connection-request-timeout]]`link:#quarkus-cxf_quarkus-cxf-client-clients-connection-request-timeout[quarkus.cxf.client."clients".connection-request-timeout]` - - -[.description] --- -Specifies the amount of time, in milliseconds, used when requesting a connection from the connection manager(if appliable). 0 is infinite. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__CONNECTION_REQUEST_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__CONNECTION_REQUEST_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|long -|`60000` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-auto-redirect]]`link:#quarkus-cxf_quarkus-cxf-client-clients-auto-redirect[quarkus.cxf.client."clients".auto-redirect]` - - -[.description] --- -Specifies if the consumer will automatically follow a server issued redirection. (name is not part of standard) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__AUTO_REDIRECT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__AUTO_REDIRECT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-max-retransmits]]`link:#quarkus-cxf_quarkus-cxf-client-clients-max-retransmits[quarkus.cxf.client."clients".max-retransmits]` - - -[.description] --- -Specifies the maximum amount of retransmits that are allowed for redirects. Retransmits for authorization is included in the retransmit count. Each redirect may cause another retransmit for a UNAUTHORIZED response code, ie. 401. Any negative number indicates unlimited retransmits, although, loop protection is provided. The default is unlimited. (name is not part of standard) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__MAX_RETRANSMITS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__MAX_RETRANSMITS+++` -endif::add-copy-button-to-env-var[] ---|int -|`-1` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-allow-chunking]]`link:#quarkus-cxf_quarkus-cxf-client-clients-allow-chunking[quarkus.cxf.client."clients".allow-chunking]` - - -[.description] --- -If true, the client is free to use chunking streams if it wants, but it is not required to use chunking streams. If false, the client must use regular, non-chunked requests in all cases. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__ALLOW_CHUNKING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__ALLOW_CHUNKING+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-chunking-threshold]]`link:#quarkus-cxf_quarkus-cxf-client-clients-chunking-threshold[quarkus.cxf.client."clients".chunking-threshold]` - - -[.description] --- -If AllowChunking is true, this sets the threshold at which messages start getting chunked. Messages under this limit do not get chunked. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__CHUNKING_THRESHOLD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__CHUNKING_THRESHOLD+++` -endif::add-copy-button-to-env-var[] ---|int -|`4096` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-chunk-length]]`link:#quarkus-cxf_quarkus-cxf-client-clients-chunk-length[quarkus.cxf.client."clients".chunk-length]` - - -[.description] --- -Specifies the chunk length for a HttpURLConnection. This value is used in java.net.HttpURLConnection.setChunkedStreamingMode(int chunklen). chunklen indicates the number of bytes to write in each chunk. If chunklen is less than or equal to zero, a default value will be used. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__CHUNK_LENGTH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__CHUNK_LENGTH+++` -endif::add-copy-button-to-env-var[] ---|int -|`-1` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-accept]]`link:#quarkus-cxf_quarkus-cxf-client-clients-accept[quarkus.cxf.client."clients".accept]` - - -[.description] --- -Specifies the MIME types the client is prepared to handle (e.g., HTML, JPEG, GIF, etc.) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__ACCEPT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__ACCEPT+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-accept-language]]`link:#quarkus-cxf_quarkus-cxf-client-clients-accept-language[quarkus.cxf.client."clients".accept-language]` - - -[.description] --- -Specifies the language the client desires (e.g., English, French, etc.) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__ACCEPT_LANGUAGE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__ACCEPT_LANGUAGE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-accept-encoding]]`link:#quarkus-cxf_quarkus-cxf-client-clients-accept-encoding[quarkus.cxf.client."clients".accept-encoding]` - - -[.description] --- -Specifies the encoding the client is prepared to handle (e.g., gzip) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__ACCEPT_ENCODING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__ACCEPT_ENCODING+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-content-type]]`link:#quarkus-cxf_quarkus-cxf-client-clients-content-type[quarkus.cxf.client."clients".content-type]` - - -[.description] --- -Specifies the content type of the stream being sent in a post request. (this should be text/xml for web services, or can be set to application/x-www-form-urlencoded if the client is sending form data). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__CONTENT_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__CONTENT_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-host]]`link:#quarkus-cxf_quarkus-cxf-client-clients-host[quarkus.cxf.client."clients".host]` - - -[.description] --- -Specifies the Internet host and port number of the resource on which the request is being invoked. This is sent by default based upon the URL. Certain DNS scenarios or application designs may request you to set this, but typically it is not required. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__HOST+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__HOST+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-connection]]`link:#quarkus-cxf_quarkus-cxf-client-clients-connection[quarkus.cxf.client."clients".connection]` - - -[.description] --- -The connection disposition. If close the connection to the server is closed after each request/response dialog. If Keep-Alive the client requests the server to keep the connection open, and if the server honors the keep alive request, the connection is reused. Many servers and proxies do not honor keep-alive requests. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__CONNECTION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__CONNECTION+++` -endif::add-copy-button-to-env-var[] --- a| -`close`, `keep-alive` -|`keep-alive` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-cache-control]]`link:#quarkus-cxf_quarkus-cxf-client-clients-cache-control[quarkus.cxf.client."clients".cache-control]` - - -[.description] --- -Most commonly used to specify no-cache, however the standard supports a dozen or so caching related directives for requests - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__CACHE_CONTROL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__CACHE_CONTROL+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-version]]`link:#quarkus-cxf_quarkus-cxf-client-clients-version[quarkus.cxf.client."clients".version]` - - -[.description] --- -HTTP Version used for the connection. The default value `auto` will use whatever the default is for the `HTTPConduit` implementation defined via `quarkus.cxf.client.myClient.http-conduit-factory`. Other possible values: `1.1`, `2`. Note that some of these values might be unsupported by some `HTTPConduit` implementations. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__VERSION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__VERSION+++` -endif::add-copy-button-to-env-var[] ---|string -|`auto` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-browser-type]]`link:#quarkus-cxf_quarkus-cxf-client-clients-browser-type[quarkus.cxf.client."clients".browser-type]` - - -[.description] --- -The value of the `User-Agent` HTTP header. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__BROWSER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__BROWSER_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-decoupled-endpoint]]`link:#quarkus-cxf_quarkus-cxf-client-clients-decoupled-endpoint[quarkus.cxf.client."clients".decoupled-endpoint]` - - -[.description] --- -An URI path (starting with `/`) or a full URI for the receipt of responses over a separate provider -> consumer connection. If the value starts with `/`, then it is prefixed with the base URI configured via `quarkus.cxf.client.myClient.decoupled-endpoint-base` before being used as a value for the WS-Addressing `ReplyTo` message header. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__DECOUPLED_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__DECOUPLED_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-proxy-server]]`link:#quarkus-cxf_quarkus-cxf-client-clients-proxy-server[quarkus.cxf.client."clients".proxy-server]` - - -[.description] --- -Specifies the address of proxy server if one is used. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_SERVER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_SERVER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-proxy-server-port]]`link:#quarkus-cxf_quarkus-cxf-client-clients-proxy-server-port[quarkus.cxf.client."clients".proxy-server-port]` - - -[.description] --- -Specifies the port number used by the proxy server. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_SERVER_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_SERVER_PORT+++` -endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-non-proxy-hosts]]`link:#quarkus-cxf_quarkus-cxf-client-clients-non-proxy-hosts[quarkus.cxf.client."clients".non-proxy-hosts]` - - -[.description] --- -Specifies the list of hostnames that will not use the proxy configuration. Examples of value: ++*++ "localhost" -> A single hostname ++*++ "localhost++\|++www.google.com" -> 2 hostnames that will not use the proxy configuration ++*++ "localhost++\|++www.google.++*\|*++.apache.org" -> It's also possible to use a pattern-like value - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__NON_PROXY_HOSTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__NON_PROXY_HOSTS+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-proxy-server-type]]`link:#quarkus-cxf_quarkus-cxf-client-clients-proxy-server-type[quarkus.cxf.client."clients".proxy-server-type]` - - -[.description] --- -Specifies the type of the proxy server. Can be either HTTP or SOCKS. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_SERVER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_SERVER_TYPE+++` -endif::add-copy-button-to-env-var[] --- a| -`http`, `socks` -|`http` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-proxy-username]]`link:#quarkus-cxf_quarkus-cxf-client-clients-proxy-username[quarkus.cxf.client."clients".proxy-username]` - - -[.description] --- -Username for the proxy authentication - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-proxy-password]]`link:#quarkus-cxf_quarkus-cxf-client-clients-proxy-password[quarkus.cxf.client."clients".proxy-password]` - - -[.description] --- -Password for the proxy authentication - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-http-conduit-factory]]`link:#quarkus-cxf_quarkus-cxf-client-clients-http-conduit-factory[quarkus.cxf.client."clients".http-conduit-factory]` - - -[.description] --- -Select the `HTTPConduitFactory` implementation for this client. - - - `QuarkusCXFDefault` (default): if `io.quarkiverse.cxf:quarkus-cxf-rt-transports-http-hc5` is present in class path, then its `HTTPConduitFactory` implementation will be used; otherwise this value is equivalent with `URLConnectionHTTPConduitFactory` (this may change, once issue link:https://github.com/quarkiverse/quarkus-cxf/issues/992[++#++992] gets resolved in CXF) - - `CXFDefault`: the selection of `HTTPConduitFactory` implementation is left to CXF - - `HttpClientHTTPConduitFactory`: the `HTTPConduitFactory` for this client will be set to an implementation always returning `org.apache.cxf.transport.http.HttpClientHTTPConduit`. This will use `java.net.http.HttpClient` as the underlying HTTP client. - - `URLConnectionHTTPConduitFactory`: the `HTTPConduitFactory` for this client will be set to an implementation always returning `org.apache.cxf.transport.http.URLConnectionHTTPConduit`. This will use `java.net.HttpURLConnection` as the underlying HTTP client. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__HTTP_CONDUIT_FACTORY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__HTTP_CONDUIT_FACTORY+++` -endif::add-copy-button-to-env-var[] --- a| -`QuarkusCXFDefault`, `CXFDefault`, `HttpClientHTTPConduitFactory`, `URLConnectionHTTPConduitFactory` -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-trust-store]]`link:#quarkus-cxf_quarkus-cxf-client-clients-trust-store[quarkus.cxf.client."clients".trust-store]` - - -[.description] --- -The trust store location for this client. The resource is first looked up in the classpath, then in the file system. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__TRUST_STORE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__TRUST_STORE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-trust-store-password]]`link:#quarkus-cxf_quarkus-cxf-client-clients-trust-store-password[quarkus.cxf.client."clients".trust-store-password]` - - -[.description] --- -The trust store password - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-trust-store-type]]`link:#quarkus-cxf_quarkus-cxf-client-clients-trust-store-type[quarkus.cxf.client."clients".trust-store-type]` - - -[.description] --- -The type of the trust store. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__TRUST_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__TRUST_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -|`JKS` - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-hostname-verifier]]`link:#quarkus-cxf_quarkus-cxf-client-clients-hostname-verifier[quarkus.cxf.client."clients".hostname-verifier]` - - -[.description] --- -Can be one of the following: - - - One of the well known values: `AllowAllHostnameVerifier`, `HttpsURLConnectionDefaultHostnameVerifier` - - A fully qualified class name implementing `javax.net.ssl.HostnameVerifier` to look up in the CDI container. - - A bean name prefixed with `++#++` that will be looked up in the CDI container; example: `++#++myHostnameVerifier` If not specified, then the creation of the `HostnameVerifier` is delegated to CXF, which boils down to `org.apache.cxf.transport.https.httpclient.DefaultHostnameVerifier` with the default `org.apache.cxf.transport.https.httpclient.PublicSuffixMatcherLoader` as returned from `PublicSuffixMatcherLoader.getDefault()`. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__HOSTNAME_VERIFIER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__HOSTNAME_VERIFIER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-cxf_quarkus-cxf-client-clients-schema-validation-enabled-for]]`link:#quarkus-cxf_quarkus-cxf-client-clients-schema-validation-enabled-for[quarkus.cxf.client."clients".schema-validation.enabled-for]` - - -[.description] --- -Select for which messages XML Schema validation should be enabled. If not specified, no XML Schema validation will be enforced unless it is enabled by other means, such as `&++#++64;org.apache.cxf.annotations.SchemaValidation` or `&++#++64;org.apache.cxf.annotations.EndpointProperty(key = "schema-validation-enabled", value = "true")` annotations. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CXF_CLIENT__CLIENTS__SCHEMA_VALIDATION_ENABLED_FOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CXF_CLIENT__CLIENTS__SCHEMA_VALIDATION_ENABLED_FOR+++` -endif::add-copy-button-to-env-var[] --- a| -`in`, `request`, `out`, `response`, `both`, `none` -| - -|=== \ No newline at end of file diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc index 892531ee6..252afb49a 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-integration-tracing-opentelemetry.adoc @@ -60,7 +60,3 @@ so that the spans can be inspected from tests easily. Refer to Quarkus https://quarkus.io/guides/opentelemetry#exporters[OpenTelemetry guide] for information about other supported span exporters and collectors. - -[id="quarkus-cxf-integration-tracing-opentelemetry-configuration"] -== Configuration -include::../../includes/quarkus-cxf-integration-tracing-opentelemetry.adoc[] diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc index 3957fa59e..2d4ecb1bf 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-features-metrics.adoc @@ -118,7 +118,3 @@ metrics: { } ---- - -[id="quarkus-cxf-rt-features-metrics-configuration"] -== Configuration -include::../../includes/quarkus-cxf-rt-features-metrics.adoc[] diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc index e172b0ad5..cc28930b6 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-rm.adoc @@ -88,7 +88,3 @@ $ mvn clean test You should see the exchange of SOAP messages between the client, the server and the decoupled endpoint in the console. - -[id="quarkus-cxf-rt-ws-rm-configuration"] -== Configuration -include::../../includes/quarkus-cxf-rt-ws-rm.adoc[] diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc index 3afa538dc..c9c533c22 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf-rt-ws-security.adoc @@ -138,7 +138,3 @@ $ mvn clean test -Dtest=EncryptSignPolicyTest You should see some messages containing `Signature` elements and encrypted bodies in the console output. - -[id="quarkus-cxf-rt-ws-security-configuration"] -== Configuration -include::../../includes/quarkus-cxf-rt-ws-security.adoc[] diff --git a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc index 7e516c20b..a3482f357 100644 --- a/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/quarkus-cxf.adoc @@ -67,7 +67,3 @@ There are several chapters in the xref:user-guide/index.adoc[User guide] coverin * xref:user-guide/examples.adoc[Examples] * xref:user-guide/common-problems-troubleshooting.adoc[Common problems and troubleshooting] - -[id="quarkus-cxf-configuration"] -== Configuration -include::../../includes/quarkus-cxf.adoc[] diff --git a/extensions/core/deployment/pom.xml b/extensions/core/deployment/pom.xml index 48f20b0ad..59238cc6d 100644 --- a/extensions/core/deployment/pom.xml +++ b/extensions/core/deployment/pom.xml @@ -132,26 +132,6 @@ - - org.codehaus.gmaven - groovy-maven-plugin - - - filter-and-move-config-options-docs - - execute - - process-classes - - file:${maven.multiModuleProjectDirectory}/src/build/scripts/filter-and-move-config-options-docs.groovy - - ${maven.multiModuleProjectDirectory}/target/asciidoc/generated/config/quarkus-cxf.adoc - ${maven.multiModuleProjectDirectory}/docs/modules/ROOT/pages/includes - - - - - diff --git a/extensions/core/runtime/pom.xml b/extensions/core/runtime/pom.xml index 80892da3c..972d6abda 100644 --- a/extensions/core/runtime/pom.xml +++ b/extensions/core/runtime/pom.xml @@ -154,20 +154,6 @@ - - filter-and-move-config-options-docs - - execute - - process-classes - - file:${maven.multiModuleProjectDirectory}/src/build/scripts/filter-and-move-config-options-docs.groovy - - ${maven.multiModuleProjectDirectory}/target/asciidoc/generated/config/quarkus-cxf.adoc - ${maven.multiModuleProjectDirectory}/docs/modules/ROOT/pages/includes - - - diff --git a/extensions/core/runtime/src/main/java/io/quarkiverse/cxf/CxfClientConfig.java b/extensions/core/runtime/src/main/java/io/quarkiverse/cxf/CxfClientConfig.java index 9a7d428db..7738cdc27 100644 --- a/extensions/core/runtime/src/main/java/io/quarkiverse/cxf/CxfClientConfig.java +++ b/extensions/core/runtime/src/main/java/io/quarkiverse/cxf/CxfClientConfig.java @@ -302,10 +302,12 @@ public interface CxfClientConfig { /** * Specifies the list of hostnames that will not use the proxy configuration. - * Examples of value: - * * "localhost" -> A single hostname - * * "localhost|www.google.com" -> 2 hostnames that will not use the proxy configuration - * * "localhost|www.google.*|*.apache.org" -> It's also possible to use a pattern-like value + * Examples: + *
    + *
  • {@code localhost} - a single hostname + *
  • {@code localhost|www.google.com} - two hostnames that will not use the proxy configuration + *
  • {@code localhost|www.google.*|*.apache.org} - hostname patterns + *
* * @since 2.2.3 */ diff --git a/extensions/core/runtime/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java b/extensions/core/runtime/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java index 3b8414d0f..c90dbb24c 100644 --- a/extensions/core/runtime/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java +++ b/extensions/core/runtime/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java @@ -9,7 +9,7 @@ /** * Adapted by sync-quarkus-classes.groovy from * ResteasyReactiveOutputStream + * "https://github.com/quarkusio/quarkus/blob/main/independent-projects/resteasy-reactive/server/vertx/src/main/java/org/jboss/resteasy/reactive/server/vertx/ResteasyReactiveOutputStream.java">ResteasyReactiveOutputStream * from Quarkus. * *

diff --git a/extensions/core/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java b/extensions/core/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java index 3b8414d0f..c90dbb24c 100644 --- a/extensions/core/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java +++ b/extensions/core/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java @@ -9,7 +9,7 @@ /** * Adapted by sync-quarkus-classes.groovy from * ResteasyReactiveOutputStream + * "https://github.com/quarkusio/quarkus/blob/main/independent-projects/resteasy-reactive/server/vertx/src/main/java/org/jboss/resteasy/reactive/server/vertx/ResteasyReactiveOutputStream.java">ResteasyReactiveOutputStream * from Quarkus. * *

diff --git a/extensions/core/src/main/java/io/quarkiverse/cxf/transport/generated/VertxServletOutputStream.java b/extensions/core/src/main/java/io/quarkiverse/cxf/transport/generated/VertxServletOutputStream.java index 1a92283e7..b7656a92b 100644 --- a/extensions/core/src/main/java/io/quarkiverse/cxf/transport/generated/VertxServletOutputStream.java +++ b/extensions/core/src/main/java/io/quarkiverse/cxf/transport/generated/VertxServletOutputStream.java @@ -12,16 +12,17 @@ import io.quarkiverse.cxf.transport.VertxReactiveRequestContext; import io.quarkus.vertx.core.runtime.VertxBufferImpl; import io.vertx.core.AsyncResult; -import io.vertx.core.Context; import io.vertx.core.Handler; +import io.vertx.core.Vertx; import io.vertx.core.buffer.Buffer; import io.vertx.core.http.HttpServerRequest; import io.vertx.core.http.HttpServerResponse; +import io.vertx.core.http.impl.HttpServerRequestInternal; /** * Adapted by sync-quarkus-classes.groovy from * ResteasyReactiveOutputStream + * "https://github.com/quarkusio/quarkus/blob/main/independent-projects/resteasy-reactive/server/vertx/src/main/java/org/jboss/resteasy/reactive/server/vertx/ResteasyReactiveOutputStream.java">ResteasyReactiveOutputStream * from Quarkus. */ public class VertxServletOutputStream extends ServletOutputStream { @@ -68,6 +69,9 @@ public void handle(Throwable event) { } } }); + Handler handler = new DrainHandler(this); + request.response().drainHandler(handler); + request.response().closeHandler(handler); context.getContext().addEndHandler(new Handler>() { @Override @@ -100,7 +104,7 @@ public void write(ByteBuf data, boolean last) throws IOException { boolean bufferRequired = awaitWriteable() || (overflow != null && overflow.size() > 0); if (bufferRequired) { //just buffer everything - registerDrainHandler(); + // registerDrainHandler(); if (overflow == null) { overflow = new ByteArrayOutputStream(); } @@ -130,8 +134,9 @@ public void write(ByteBuf data, boolean last) throws IOException { } private boolean awaitWriteable() throws IOException { - if (Context.isOnEventLoopThread()) { - return request.response().writeQueueFull(); + if (Vertx.currentContext() == ((HttpServerRequestInternal) request).context()) { + // we are on the (right) event loop, so we can write - Netty will do the right thing. + return false; } if (first) { first = false; @@ -145,7 +150,7 @@ private boolean awaitWriteable() throws IOException { if (request.response().closed()) { throw new IOException("Connection has been closed"); } - registerDrainHandler(); + // registerDrainHandler(); try { waitingForDrain = true; request.connection().wait(); @@ -158,35 +163,14 @@ private boolean awaitWriteable() throws IOException { return false; } - private void registerDrainHandler() { - if (!drainHandlerRegistered) { - drainHandlerRegistered = true; - Handler handler = new Handler() { - - @Override - public void handle(Void event) { - synchronized (request.connection()) { - if (waitingForDrain) { - request.connection().notifyAll(); - } - if (overflow != null) { - if (overflow.size() > 0) { - if (closed) { - request.response().end(Buffer.buffer(overflow.toByteArray()), null); - } else { - request.response().write(Buffer.buffer(overflow.toByteArray()), null); - } - overflow.reset(); - } - } - } - } - }; - request.response().drainHandler(handler); - request.response().closeHandler(handler); - } - } - + // private void registerDrainHandler() { + // if (!drainHandlerRegistered) { + // drainHandlerRegistered = true; + // Handler handler = new DrainHandler(this); + // request.response().drainHandler(handler); + // request.response().closeHandler(handler); + // } + // } /** * {@inheritDoc} */ @@ -282,6 +266,34 @@ public void close() throws IOException { } } + private static class DrainHandler implements Handler { + + private final VertxServletOutputStream out; + + public DrainHandler(VertxServletOutputStream out) { + this.out = out; + } + + @Override + public void handle(Void event) { + synchronized (out.request.connection()) { + if (out.waitingForDrain) { + out.request.connection().notifyAll(); + } + if (out.overflow != null) { + if (out.overflow.size() > 0) { + if (out.closed) { + out.request.response().end(Buffer.buffer(out.overflow.toByteArray()), null); + } else { + out.request.response().write(Buffer.buffer(out.overflow.toByteArray()), null); + } + out.overflow.reset(); + } + } + } + } + } + @Override public boolean isReady() { throw new UnsupportedOperationException(); diff --git a/extensions/features-logging/runtime/pom.xml b/extensions/features-logging/runtime/pom.xml index 3d756fdde..d7471c2ab 100644 --- a/extensions/features-logging/runtime/pom.xml +++ b/extensions/features-logging/runtime/pom.xml @@ -67,29 +67,6 @@ - - org.apache.maven.plugins - maven-resources-plugin - - - copy-configuration-documentation - process-classes - - copy-resources - - - ${maven.multiModuleProjectDirectory}/docs/modules/ROOT/pages/includes/ - - - ${maven.multiModuleProjectDirectory}/target/asciidoc/generated/config/ - ${project.artifactId}.adoc - false - - - - - - diff --git a/extensions/features-metrics/runtime/pom.xml b/extensions/features-metrics/runtime/pom.xml index 9b1f676ec..b655579b3 100644 --- a/extensions/features-metrics/runtime/pom.xml +++ b/extensions/features-metrics/runtime/pom.xml @@ -81,29 +81,6 @@ - - org.apache.maven.plugins - maven-resources-plugin - - - copy-configuration-documentation - process-classes - - copy-resources - - - ${maven.multiModuleProjectDirectory}/docs/modules/ROOT/pages/includes/ - - - ${maven.multiModuleProjectDirectory}/target/asciidoc/generated/config/ - ${project.artifactId}.adoc - false - - - - - - diff --git a/extensions/integration-tracing-opentelemetry/runtime/pom.xml b/extensions/integration-tracing-opentelemetry/runtime/pom.xml index caffab820..7150497f7 100644 --- a/extensions/integration-tracing-opentelemetry/runtime/pom.xml +++ b/extensions/integration-tracing-opentelemetry/runtime/pom.xml @@ -75,29 +75,6 @@ - - org.apache.maven.plugins - maven-resources-plugin - - - copy-configuration-documentation - process-classes - - copy-resources - - - ${maven.multiModuleProjectDirectory}/docs/modules/ROOT/pages/includes/ - - - ${maven.multiModuleProjectDirectory}/target/asciidoc/generated/config/ - ${project.artifactId}.adoc - false - - - - - - diff --git a/extensions/ws-rm/runtime/pom.xml b/extensions/ws-rm/runtime/pom.xml index f3b53deb7..63cc6eb20 100644 --- a/extensions/ws-rm/runtime/pom.xml +++ b/extensions/ws-rm/runtime/pom.xml @@ -74,29 +74,6 @@ - - org.apache.maven.plugins - maven-resources-plugin - - - copy-configuration-documentation - process-classes - - copy-resources - - - ${maven.multiModuleProjectDirectory}/docs/modules/ROOT/pages/includes/ - - - ${maven.multiModuleProjectDirectory}/target/asciidoc/generated/config/ - ${project.artifactId}.adoc - false - - - - - - diff --git a/extensions/ws-rm/runtime/src/main/java/io/quarkiverse/cxf/ws/rm/CxfWsRmConfig.java b/extensions/ws-rm/runtime/src/main/java/io/quarkiverse/cxf/ws/rm/CxfWsRmConfig.java index 5cd55f135..2eadf9755 100644 --- a/extensions/ws-rm/runtime/src/main/java/io/quarkiverse/cxf/ws/rm/CxfWsRmConfig.java +++ b/extensions/ws-rm/runtime/src/main/java/io/quarkiverse/cxf/ws/rm/CxfWsRmConfig.java @@ -110,7 +110,11 @@ public interface GlobalRmConfig { Optional store(); /** - * + * A reference to a + * {@code org.apache.cxf.ws.rm.feature.RMFeature} bean to set on clients and service endpoint which have + * {@code quarkus.cxf.[client|service]."name".rm.enabled = true}. + *

+ * If the value is {@code #defaultRmFeature} then Quarkus CXF creates and configures the bean for you. * * @since 2.7.0 */ diff --git a/extensions/ws-security/runtime/pom.xml b/extensions/ws-security/runtime/pom.xml index bff2bd31e..466cc79c5 100644 --- a/extensions/ws-security/runtime/pom.xml +++ b/extensions/ws-security/runtime/pom.xml @@ -95,29 +95,6 @@ - - org.apache.maven.plugins - maven-resources-plugin - - - copy-configuration-documentation - process-classes - - copy-resources - - - ${maven.multiModuleProjectDirectory}/docs/modules/ROOT/pages/includes/ - - - ${maven.multiModuleProjectDirectory}/target/asciidoc/generated/config/ - ${project.artifactId}.adoc - false - - - - - - diff --git a/integration-tests/ws-trust/src/main/resources/application.properties b/integration-tests/ws-trust/src/main/resources/application.properties index 561301311..ab6093d09 100644 --- a/integration-tests/ws-trust/src/main/resources/application.properties +++ b/integration-tests/ws-trust/src/main/resources/application.properties @@ -1,7 +1,7 @@ # STS # tag::ws-trust-usage.adoc-sts-properties[] quarkus.cxf.endpoint."/sts".implementor = io.quarkiverse.cxf.it.ws.trust.sts.Sts -quarkus.cxf.endpoint."/sts".logging.enabled = true +quarkus.cxf.endpoint."/sts".logging.enabled = pretty quarkus.cxf.endpoint."/sts".security.signature.username = sts quarkus.cxf.endpoint."/sts".security.signature.password = password @@ -16,7 +16,7 @@ quarkus.cxf.endpoint."/sts".security.signature.properties."org.apache.ws.securit # hello-ws-trust # tag::ws-trust-usage.adoc-service-properties[] quarkus.cxf.endpoint."/hello-ws-trust".implementor = io.quarkiverse.cxf.it.ws.trust.server.TrustHelloServiceImpl -quarkus.cxf.endpoint."/hello-ws-trust".logging.enabled = true +quarkus.cxf.endpoint."/hello-ws-trust".logging.enabled = pretty quarkus.cxf.endpoint."/hello-ws-trust".security.signature.username = service quarkus.cxf.endpoint."/hello-ws-trust".security.signature.password = password diff --git a/pom.xml b/pom.xml index 61dbf8b1c..3fe13e6f4 100644 --- a/pom.xml +++ b/pom.xml @@ -72,7 +72,7 @@ 3.25.8 - 4.4.7 + 4.4.9 3.1.1 2.1.1 3.0.20 @@ -240,7 +240,18 @@ ${cq-maven-plugin.version} file:${maven.multiModuleProjectDirectory}/src/build/doc-templates + \Qlink:http\Es?\Q://docs.quarkiverse.io/quarkus-cxf/dev/\E([^\[]+).html + + ^quarkus\.cxf\.internal + + + + io.quarkus + quarkus-extension-processor + ${quarkus.version} + + diff --git a/src/build/doc-templates/extension-doc-page.adoc b/src/build/doc-templates/extension-doc-page.adoc index ca7ce83ad..e18dc2791 100644 --- a/src/build/doc-templates/extension-doc-page.adoc +++ b/src/build/doc-templates/extension-doc-page.adoc @@ -68,7 +68,29 @@ endif::[] [=configuration] [/#if] -[#if configurationPropertiesInclude?? ] -include::[=configurationPropertiesInclude][] +[#if configOptions?size != 0 ] + +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime. + +[.configuration-reference.searchable, cols="80,.^10,.^10", stripes=odd] +|=== +| Configuration property | Type | Default + +[#list configOptions as configDocItem][#assign anchor = toAnchor(configDocItem.key)] + +|[=configDocItem.illustration] [[quarkus-cxf_[=anchor]]]`link:#quarkus-cxf_[=anchor][[=configDocItem.key]]` +| [=configDocItem.type] +| [#if configDocItem.defaultValue?has_content]`[=configDocItem.defaultValue]`[#elseif ! configDocItem.optional]required icon:exclamation-circle[title=Configuration property is required][/#if] + +3+a|[=configDocItem.configDoc] +[#if configDocItem.environmentVariable?? ] + +*Environment variable*: `+++[=configDocItem.environmentVariable]+++`[/#if][#if configDocItem.since?? ] + +*Since Quarkus CXF*: [=configDocItem.since] +[/#if] +[/#list] +|=== + [/#if] [/#if] diff --git a/src/build/scripts/filter-and-move-config-options-docs.groovy b/src/build/scripts/filter-and-move-config-options-docs.groovy deleted file mode 100644 index 1065d5ce1..000000000 --- a/src/build/scripts/filter-and-move-config-options-docs.groovy +++ /dev/null @@ -1,57 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/** - * Remove the docs of all config options starting with quarkus.cxf.internal - */ -import java.nio.file.Path -import java.nio.file.Paths -import java.nio.file.Files - - -final Path inputFile = Paths.get(properties['inputFile']) -final Path outputDirectory = Paths.get(properties['outputDirectory']) - -final String content = inputFile.getText('UTF-8') - -final String propPrefix = 'a| [[quarkus-cxf_quarkus-cxf-internal' -final int start = content.indexOf(propPrefix) -if (start < 0) { - throw new IllegalStateException('Could not find ' + propPrefix + ' in '+ inputFile); -} - -final int lastStart = content.lastIndexOf(propPrefix) - -final String nextPrefix = '\n\na|' -final int end = content.indexOf(nextPrefix, lastStart) -if (end < 0) { - throw new IllegalStateException('Could not find ' + nextPrefix + ' in '+ inputFile); -} - -String newContentString = content.substring(0, start) + content.substring(end + 2) - -if (!Files.exists(outputDirectory)) { - Files.createDirectories(outputDirectory) -} - -final Path outputFile = outputDirectory.resolve(inputFile.getFileName()) -if (!Files.exists(outputFile) || !newContentString.equals(outputFile.getText('UTF-8'))) { - println 'Updated ' + outputFile - Files.write(outputFile, newContentString.getBytes('UTF-8')) -} else { - println 'No change in ' + outputFile -} diff --git a/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java b/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java index 3b8414d0f..c90dbb24c 100644 --- a/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java +++ b/src/main/java/io/quarkiverse/cxf/transport/generated/AppendBuffer.java @@ -9,7 +9,7 @@ /** * Adapted by sync-quarkus-classes.groovy from * ResteasyReactiveOutputStream + * "https://github.com/quarkusio/quarkus/blob/main/independent-projects/resteasy-reactive/server/vertx/src/main/java/org/jboss/resteasy/reactive/server/vertx/ResteasyReactiveOutputStream.java">ResteasyReactiveOutputStream * from Quarkus. * *

diff --git a/src/main/java/io/quarkiverse/cxf/transport/generated/VertxServletOutputStream.java b/src/main/java/io/quarkiverse/cxf/transport/generated/VertxServletOutputStream.java index 6c8444f95..b7656a92b 100644 --- a/src/main/java/io/quarkiverse/cxf/transport/generated/VertxServletOutputStream.java +++ b/src/main/java/io/quarkiverse/cxf/transport/generated/VertxServletOutputStream.java @@ -22,7 +22,7 @@ /** * Adapted by sync-quarkus-classes.groovy from * ResteasyReactiveOutputStream + * "https://github.com/quarkusio/quarkus/blob/main/independent-projects/resteasy-reactive/server/vertx/src/main/java/org/jboss/resteasy/reactive/server/vertx/ResteasyReactiveOutputStream.java">ResteasyReactiveOutputStream * from Quarkus. */ public class VertxServletOutputStream extends ServletOutputStream { @@ -268,9 +268,9 @@ public void close() throws IOException { private static class DrainHandler implements Handler { - private final ResteasyReactiveOutputStream out; + private final VertxServletOutputStream out; - public DrainHandler(ResteasyReactiveOutputStream out) { + public DrainHandler(VertxServletOutputStream out) { this.out = out; }