3.7.0 Deprecations and breaking changes

API

Vert.x Core

• Deprecation
  • KeyCertOptions#clone() and TrustOptions#clone() methods are deprecated and now instead KeyCertOptions#copy() and TrustOptions#copy() methods should be used. See https://github.com/eclipse-vertx/vert.x/issues/2833
  • SSLEngineOptions#clone() method is deprecated and now instead the SSLEngineOptions#copy() method should be used. See https://github.com/eclipse-vertx/vert.x/issues/2839
• Breaking
  • HttpServerOptions and HttpClientOptions fixed a few inconsistencies around WebSocket per-message compression. See https://github.com/eclipse-vertx/vert.x/issues/2838
  • Future#completer() method is deprecated since Future<T> extends Handler<AsyncResult<T>> for some time now (and the default implementation actually returns this). See https://github.com/eclipse-vertx/vert.x/issues/2778
  • EventBusOptions delegates in VertxOptions are no longer needed as it is possible to configure all Vert.x options with -options arg since 3.6. See https://github.com/eclipse-vertx/vert.x/issues/2873

Vert.x Cassandra Client

• Breaking
  • Redesign client lifecycle: this enhancement breaks the previous tech preview API; CassandraClient no longer has connect and disconnect methods; instead, client is connected on first request; if created inside a verticle the client is closed automatically; otherwise, it should be closed manually with close

Vert.x Kafka Client

• Deprecation
  • The AdminUtils class, for doing administrative operations on a Kafka cluster, is now deprecated. The new KafkaAdminClient class should be used for that.

Vert.x Mongo Client

• Breaking RxJava and RxJava 2 changes that return Maybe instead of Single
  • save
  • saveWithOptions
  • insert
  • insertWithOptions
  • findOne
  • findOneAndUpdate
  • findOneAndUpdateWithOptions
  • findOneAndReplace
  • findOneAndReplaceWithOptions
  • findOneAndDelete
  • findOneAndDeleteWithOptions

Vert.x Web

Deprecations

The UserSessionHandler is now deprecated, indeed this feature is now merged in the SessionHandler itself.

The following:

router.route().handler(SessionHandler.create(LocalSessionStore.create(vertx)));
router.route().handler(UserSessionHandler.create(authProvider));

should be replaced by

router.route().handler(SessionHandler.create(LocalSessionStore.create(vertx)).setAuthProvider(authProvider));

Vert.x Web API Contract

• Breaking
  • The default option for "automatic mount validation failure handler" now is false
  • Now the router is configured to correctly fail with 405 Method Not Allowed more than always failing with 501 Not Implemented when you have a path that has multiple HTTP methods, which some are configured and some are not configured. https://github.com/vert-x3/vertx-web/issues/1167
• Deprecation
  • Validation failure handler and not implemented handler are deprecated, now you should use new Router.errorHandler() for managing routing related errors https://github.com/vert-x3/vertx-web/pull/1166