Automatic Module Names

Provides a reliable module name, instead of using the name derived from the JAR file, without having to target Java 9+ and/or use module-info java/class file. This can be used until there is a module-info file.

When choosing module names, these rules should be taken into consideration.

Table of automatic module names and their status:

Notes:

• The deprecated MySQL / PostgreSQL clients are not included.
• AMPQ Bridge is not included as it will be removed in Vertx 4.
• Module names cannot contain -, .. or Java keywords, as this article suggests.

Core

Component	Artifact id	Automatic Module Name	Status
Vertx core	vertx-core	io.vertx.core	✓

Web

Component	Artifact id	Automatic Module Name	Status
Web	vertx-web	io.vertx.web	✓
Web client	vertx-web-client	io.vertx.web.client	✓
Web common	vertx-web-common	io.vertx.web.common	✓
Web OpenAPI	vertx-web-openapi	io.vertx.web.openapi	✓
Web validation	vertx-web-validation	io.vertx.web.validation	✓
Web templates	vertx-web-templ-[x]	io.vertx.web.template.[x]	✓
Web API	vertx-web-api-contract	io.vertx.web.apicontract	✓
Web API service	vertx-web-api-service	io.vertx.web.apiservice	✓
Web GraphQL Handler	vertx-web-graphql	io.vertx.web.graphql	✓
Web sstores	vertx-web-sstore-[x]	io.vertx.web.sstore.[x]	✓
Web Proxy	vertx-web-proxy	io.vertx.web.proxy	✓
Web OpenAPI Router	vertx-web-openapi-router	io.vertx.web.openapi.router	✓

Data access

Component	Artifact id	Automatic Module Name	Status
MongoDB client	vertx-mongo-client	io.vertx.client.mongo	✓
Redis client	vertx-redis-client	io.vertx.client.redis	✓
Cassandra client	vertx-cassandra-client	io.vertx.client.cassandra	✓
Common SQL interfaces	vertx-sql-common	N/A	✓
JDBC client	vertx-jdbc-client	io.vertx.client.jdbc	✓

Reactive SQL clients

Component	Artifact id	Automatic Module Name	Status
SQL client	vertx-sql-client	io.vertx.client.sql	✓
DB2 client	vertx-db2-client	io.vertx.client.sql.db2	✓
MSSQL client	vertx-mssql-client	io.vertx.client.sql.mssql	✓
MySQL client	vertx-mysql-client	io.vertx.client.sql.mysql	✓
PostgreSQL client	vertx-pg-client	io.vertx.client.sql.pg	✓
Templates	vertx-client-sql-templates	io.vertx.client.sql.templates	✓

Reactive

Component	Artifact id	Automatic Module Name	Status
Reactive Streams	vertx-reactive-streams	io.vertx.reactivestreams	✓
Vertx Sync	vertx-sync	N/A	-
Kotlin coroutines	vertx-lang-kotlin-coroutines	io.vertx.kotlin.coroutines	✓

Reactive Extensions

Component	Artifact id	Automatic Module Name	Status
Rx code generator	vertx-rx-gen	io.vertx.rx.gen	Postponed
RxJava code generator	vertx-rx-java-gen	io.vertx.rx.java.gen	Postponed
RxJava API	vertx-rx-java	io.vertx.rx.java	Postponed
RxJava2 Code Generator	vertx-rx-java2-gen	io.vertx.rx.java2.gen	Postponed
RxJava2 API	vertx-rx-java2	io.vertx.rx.java2	Postponed
JUnit 5 RxJava support	vertx-junit5-rx-java	io.vertx.junit5.rx.java	Postponed
JUnit 5 RxJava2 support	vertx-junit5-rx-java2	io.vertx.junit5.rx.java2	Postponed

Microservices

Component	Artifact id	Automatic Module Name	Status
Circuit Breaker	vertx-circuit-breaker	io.vertx.circuitbreaker	✓

Vertx Config

Component	Artifact id	Automatic Module Name	Status
Vertx Config	vertx-config	io.vertx.config	✓
Consul	vertx-config-consul	io.vertx.config.consul	✓
Git	vertx-config-git	io.vertx.config.git	✓
HOCON	vertx-config-hocon	io.vertx.config.hocon	✓
Kubernetes ConfigMap	vertx-config-kubernetes-configmap	io.vertx.config.configmap	✓
Redis	vertx-config-redis	io.vertx.config.redis	✓
Spring config server	vertx-config-spring-config-server	io.vertx.config.springconfigserver	✓
Vault	vertx-config-vault	io.vertx.config.vault	✓
YAML	vertx-config-yaml	io.vertx.config.yaml	✓
Zookeeper	vertx-config-zookeeper	io.vertx.config.zookeeper	✓

Vertx Service Discovery

Component	Artifact id	Automatic Module Name	Status
Service Discovery	vertx-service-discovery	io.vertx.servicediscovery	✓
Consul Backend	vertx-service-discovery-backend-consul	io.vertx.servicediscovery.backend.consul	✓
Redis Backend	vertx-service-discovery-backend-redis	io.vertx.servicediscovery.backend.redis	✓
Zookeeper Backend	vertx-service-discovery-backend-zookeeper	io.vertx.servicediscovery.backend.zookeeper	✓
Consul Bridge	vertx-service-discovery-bridge-consul	io.vertx.servicediscovery.bridge.consul	✓
Docker links Bridge	vertx-service-discovery-bridge-docker-links	io.vertx.servicediscovery.bridge.dockerlinks	✓
Docker Bridge	vertx-service-discovery-bridge-docker	io.vertx.servicediscovery.bridge.docker	✓
Kubernetes Bridge	vertx-service-discovery-bridge-kubernetes	io.vertx.servicediscovery.bridge.kubernetes	✓
Zookeeper Bridge	vertx-service-discovery-bridge-zookeeper	io.vertx.servicediscovery.bridge.zookeeper	✓

Standards

Component	Artifact id	Automatic Module Name	Status
Vertx OpenAPI	vertx-openapi	io.vertx.openapi	✓
Vertx Json Schema	vertx-json-schema	io.vertx.jsonschema	✓
Vertx URI Template	vertx-uri-temlate	io.vertx.uritemplate	✓

HTTP Proxy

Component	Artifact id	Automatic Module Name	Status
Vertx Http Proxy	vertx-http-proxy	io.vertx.httpproxy	✓

MQTT

Component	Artifact id	Automatic Module Name	Status
Vertx MQTT	vertx-mqtt	io.vertx.mqtt	✓

Authentication and Authorisation

Component	Artifact id	Automatic Module Name	Status
Auth Common	vertx-auth-common	io.vertx.auth.common	✓
JDBC Auth	vertx-auth-jdbc	io.vertx.auth.jdbc	✓
JWT Auth	vertx-auth-jwt	io.vertx.auth.jwt	✓
JWT	vertx-jwt	N/A	Artifact code ✓ into vertx-auth-common
LDAP	vertx-auth-ldap	io.vertx.auth.ldap	✓
Shiro Auth	vertx-auth-shiro	io.vertx.auth.shiro	✓
MongoDB Auth	vertx-auth-mongo	io.vertx.auth.mongo	✓
OAuth 2	vertx-auth-oauth2	Io.vertx.auth.oauth2	✓
Properties	vertx-auth-properties	Io.vertx.auth.properties	✓
.htdigest Auth	vertx-auth-htdigest	io.vertx.auth.htdigest	✓
.htpasswd	vertx-auth-htpasswd	io.vertx.auth.htpasswd	✓
SQL Auth	vertx-auth-sql	io.vertx.auth.sql	✓
WebAuthN	vertx-auth-webauthn	io.vertx.auth.webauthn	✓

Messaging

Component	Artifact id	Automatic Module Name	Status
AMQP Client	vertx-amqp-client	io.vertx.client.amqp	✓
STOMP	vertx-stomp	io.vertx.stomp	✓
RabbitMQ Client	vertx-rabbitmq-client	io.vertx.client.rabbitmq	✓
Vert.x Proton	vertx-proton	io.vertx.proton	✓

Integration

Component	Artifact id	Automatic Module Name	Status
Kafka Client	vertx-kafka-client	io.vertx.client.kafka	✓
Mail Client	vertx-mail-client	io.vertx.client.mail	✓
Consul Client	vertx-consul-client	io.vertx.client.consul	✓

JCA Adaptor

Component	Artifact id	Automatic Module Name	Status
JCA Adapter	vertx-jca-adapter	N/A	-
JCA API	vertx-jca-api	N/A	-

Event Bus Bridge

Component	Artifact id	Automatic Module Name	Status
Common	vertx-bridge-common	io.vertx.eventbusbridge.common	✓
TCP Event Bus Bridge	vertx-tcp-eventbus-bridge	io.vertx.eventbusbridge.tcp	Under discussion
Camel Bridge	vertx-camel-bridge	io.vertx.eventbusbridge.camel	Under discussion

Devops

Component	Artifact id	Automatic Module Name	Status
Dropwizard metrics	vertx-dropwizard-metrics	io.vertx.metrics.dropwizard	✓
Micrometer	vertx-micrometer-metrics	io.vertx.metrics.micrometer	✓
Health Check	vertx-health-check	io.vertx.healthcheck	✓
Shell	vertx-shell	io.vertx.shell	✓
Docker	vertx-stack-docker	N/A	-
Stack Manager	vertx-stack-manager	N/A	-

Tracing

Component	Artifact id	Automatic Module Name	Status
Zipkin	vertx-zipkin	io.vertx.tracing.zipkin	✓
OpenTracing	vertx-opentracing	io.vertx.tracing.opentracing	✓
OpenTelemetry	vertx-opentelemetry	io.vertx.tracing.opentelemetry	✓

Testing

Component	Artifact id	Automatic Module Name	Status
Vertx Unit	vertx-unit	io.vertx.testing.unit	✓
JUnit 5	vertx-junit5	io.vertx.testing.junit5	✓

Clustering

Component	Artifact id	Automatic Module Name	Status
Hazelcast	vertx-hazelcast	io.vertx.clustermanager.hazelcast	✓
Infinispan	vertx-infinispan	io.vertx.clustermanager.infinispan	✓
Apache Ignite	vertx-ignite	io.vertx.clustermanager.ignite	✓
Zookeeper	vertx-zookeeper	io.vertx.clustermanager.zookeeper	✓

Services

Component	Artifact id	Automatic Module Name	Status
Service Proxies	vertx-service-proxy	io.vertx.serviceproxy	✓
Service Factories	vertx-service-factory	N/A	-
HTTP Service Factory	vertx-http-service-factory	N/A	-
SockJs Service Proxy	vertx-sockjs-service-proxy	io.vertx.serviceproxy.sockjs	✓
Maven Service Factory	vertx-maven-service-factory	N/A	-

gRPC

Component	Artifact id	Automatic Module Name	Status
gRPC	vertx-grpc	io.vertx.grpc	✓
gRPC Client	vertx-grpc-client	io.vertx.grpc.client	✓
gRPC Server	vertx-grpc-server	io.vertx.grpc.server	✓
gRPC Common	vertx-grpc-common	io.vertx.grpc.common	✓
gRPC Context Storage	vertx-grpc-context-storage	N/A	-
gRPC protoc plugin	vertx-grpc-protoc-plugin	N/A	-

Internal Magic

Component	Artifact id	Automatic Module Name	Status
Codegen	vertx-codegen	io.vertx.codegen	✓
Docgen	vertx-docgen	N/A	-
Codetrans	vertx-codetrans	N/A	-
Bridge Common	vertx-bridge-common	io.vertx.eventbusbridge.common	✓
Distro Stack Manager	vertx-stack-manager	io.vertx.stack.manager	N/A

Languages

Component	Artifact id	Automatic Module Name	Status
Groovy lang	vertx-lang-groovy	N/A	N/A

Kotlin

Component	Artifact id	Automatic Module Name	Status
Kotlin gen	vertx-lang-kotlin-gen	io.vertx.kotlin.gen	Under discussion
Kotling lang	vertx-lang-kotlin	io.vertx.kotlin	✓

Scala

Component	Artifact id	Automatic Module Name	Status
Scala lang codegen	vertx-lang-scala-codegen	N/A	-
Scala language support	vertx-lang-scala_2.13	N/A	-