Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jun 12, 2024
1 parent 9ab16ac commit 1895dc0
Show file tree
Hide file tree
Showing 24 changed files with 294 additions and 431 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"string","key":".auth-failure-redirect-url","additionalKeys":[],"configDoc":"Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the `@RolesAllowed` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-failure-redirect-url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_AUTH_FAILURE_REDIRECT_URL","enum":false}}]

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.client.offer-per-message-compression","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"offer-per-message-compression","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_OFFER_PER_MESSAGE_COMPRESSION","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.client.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.client.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_MAX_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.client.auto-ping-interval","additionalKeys":[],"configDoc":"The interval after which, when set, the client sends a ping message to a connected server automatically.\n\nPing messages are not sent automatically by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"auto-ping-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.websockets.next.UnhandledFailureStrategy","key":"quarkus.websockets-next.client.unhandled-failure-strategy","additionalKeys":[],"configDoc":"The strategy used when an error occurs but no error handler can handle the failure.\n\nBy default, the connection is closed when an unhandled failure occurs.","withinAMap":false,"defaultValue":"close","javaDocSiteLink":"","docMapKey":"unhandled-failure-strategy","configPhase":"RUN_TIME","acceptedValues":["`close`","`log`","`noop`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY","enum":true}}]
[{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.client.offer-per-message-compression","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"offer-per-message-compression","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_OFFER_PER_MESSAGE_COMPRESSION","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.client.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.client.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_MAX_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.client.auto-ping-interval","additionalKeys":[],"configDoc":"The interval after which, when set, the client sends a ping message to a connected server automatically.\n\nPing messages are not sent automatically by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"auto-ping-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.websockets.next.UnhandledFailureStrategy","key":"quarkus.websockets-next.client.unhandled-failure-strategy","additionalKeys":[],"configDoc":"The strategy used when an error occurs but no error handler can handle the failure.\n\nBy default, the connection is closed when an unhandled failure occurs.","withinAMap":false,"defaultValue":"close","javaDocSiteLink":"","docMapKey":"unhandled-failure-strategy","configPhase":"RUN_TIME","acceptedValues":["`close`","`log`","`noop`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.websockets-next.client.tls-configuration-name","additionalKeys":[],"configDoc":"The name of the TLS configuration to use.\n\nIf a name is configured, it uses the configuration from `quarkus.tls.<name>.++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown.\n\nThe default TLS configuration is *not* used by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tls-configuration-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.client","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_CLIENT_TLS_CONFIGURATION_NAME","enum":false}}]
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"string","key":"quarkus.websockets-next.server.supported-subprotocols","additionalKeys":[],"configDoc":"See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol]","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"supported-subprotocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.server.per-message-compression-supported","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"per-message-compression-supported","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.server.auto-ping-interval","additionalKeys":[],"configDoc":"The interval after which, when set, the server sends a ping message to a connected client automatically.\n\nPing messages are not sent automatically by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"auto-ping-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.websockets.next.UnhandledFailureStrategy","key":"quarkus.websockets-next.server.unhandled-failure-strategy","additionalKeys":[],"configDoc":"The strategy used when an error occurs but no error handler can handle the failure.\n\nBy default, the connection is closed when an unhandled failure occurs.","withinAMap":false,"defaultValue":"close","javaDocSiteLink":"","docMapKey":"unhandled-failure-strategy","configPhase":"RUN_TIME","acceptedValues":["`close`","`log`","`noop`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY","enum":true}}]
[{"configDocKey":{"type":"string","key":"quarkus.websockets-next.server.supported-subprotocols","additionalKeys":[],"configDoc":"See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol]","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"supported-subprotocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.server.per-message-compression-supported","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"per-message-compression-supported","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `io.vertx.core.http.HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.server.auto-ping-interval","additionalKeys":[],"configDoc":"The interval after which, when set, the server sends a ping message to a connected client automatically.\n\nPing messages are not sent automatically by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"auto-ping-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL","enum":false}},{"configDocKey":{"type":"io.quarkus.websockets.next.UnhandledFailureStrategy","key":"quarkus.websockets-next.server.unhandled-failure-strategy","additionalKeys":[],"configDoc":"The strategy used when an error occurs but no error handler can handle the failure.\n\nBy default, the connection is closed when an unhandled failure occurs.","withinAMap":false,"defaultValue":"close","javaDocSiteLink":"","docMapKey":"unhandled-failure-strategy","configPhase":"RUN_TIME","acceptedValues":["`close`","`log`","`noop`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.websockets-next.server.security.auth-failure-redirect-url","additionalKeys":[],"configDoc":"Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the `@RolesAllowed` annotation.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-failure-redirect-url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL","enum":false}}]
6 changes: 6 additions & 0 deletions _generated-doc/main/config/quarkus-all-build-items.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2167,6 +2167,12 @@ a| `Collection additionalSecuredMethods` :: +++<i>No Javadoc found</i>+++
a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/AdditionalSecurityConstrainerEventPropsBuildItem.java[`io.quarkus.security.spi.AdditionalSecurityConstrainerEventPropsBuildItem`, window="_blank"] :: +++This item allows to enhance properties of security events produced by SecurityConstrainer. The SecurityConstrainer is usually invoked when CDI request context is already fully setup, and the additional properties can be added based on the active context.+++
a| `Supplier additionalEventPropsSupplier` :: +++<i>No Javadoc found</i>+++
a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/ClassSecurityCheckAnnotationBuildItem.java[`io.quarkus.security.spi.ClassSecurityCheckAnnotationBuildItem`, window="_blank"] :: +++Allows to create additional security checks for standard security annotations defined on a class level. We strongly recommended to secure CDI beans with if additional security is required. If you decide to use this build item, you must use class security check storage and apply checks manually. Thus, it's only suitable for very special cases.+++
a| `DotName classAnnotation` :: +++<i>No Javadoc found</i>+++
a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/ClassSecurityCheckStorageBuildItem.java[`io.quarkus.security.spi.ClassSecurityCheckStorageBuildItem`, window="_blank"] :: +++Security check storage containing additional security checks created for secured classes matching one of the filters during the static init.+++
a| `Map classNameToSecurityCheck` :: +++<i>No Javadoc found</i>+++
a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/DefaultSecurityCheckBuildItem.java[`io.quarkus.security.spi.DefaultSecurityCheckBuildItem`, window="_blank"] :: +++Registers default SecurityCheck with the SecurityCheckStorage. Please make sure this build item is produced exactly once or validation will fail and exception will be thrown.+++
a| `List rolesAllowed` :: +++<i>No Javadoc found</i>+++
Expand Down
Loading

0 comments on commit 1895dc0

Please sign in to comment.