guicedee-vertx
Build reactive services using Vert.x 5 inside the GuicedEE DI lifecycle: event-bus consumers, publishers, verticle deployment, codecs, throttling, clustering, SPI hooks, and JPMS module setup. Use when adding Vert.x event-bus messaging, deploying verticles, wiring reactive endpoints with Guice injection, configuring Vert.x runtime options, or implementing custom codecs and cluster managers.
Best use case
guicedee-vertx is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Build reactive services using Vert.x 5 inside the GuicedEE DI lifecycle: event-bus consumers, publishers, verticle deployment, codecs, throttling, clustering, SPI hooks, and JPMS module setup. Use when adding Vert.x event-bus messaging, deploying verticles, wiring reactive endpoints with Guice injection, configuring Vert.x runtime options, or implementing custom codecs and cluster managers.
Teams using guicedee-vertx should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/guicedee-vertx/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How guicedee-vertx Compares
| Feature / Agent | guicedee-vertx | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Build reactive services using Vert.x 5 inside the GuicedEE DI lifecycle: event-bus consumers, publishers, verticle deployment, codecs, throttling, clustering, SPI hooks, and JPMS module setup. Use when adding Vert.x event-bus messaging, deploying verticles, wiring reactive endpoints with Guice injection, configuring Vert.x runtime options, or implementing custom codecs and cluster managers.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# GuicedEE Vert.x
Wire Vert.x 5 into the GuicedEE lifecycle with zero manual bootstrap.
## Core Concept
Vert.x starts automatically via SPI — never create `Vertx` manually:
```
IGuiceContext.instance().inject()
└─ VertXPreStartup (IGuicePreStartup) → creates Vertx, scans events, registers codecs
└─ VerticleBuilder → deploys verticles from @Verticle annotations
└─ VertxConsumersStartup → deploys one EventConsumerVerticle per address
└─ VertXModule (IGuiceModule) → binds Vertx, consumers, publishers into Guice
└─ VertXPostStartup (IGuicePreDestroy) → closes Vertx on shutdown
```
Bootstrap with:
```java
IGuiceContext.registerModuleForScanning.add("my.app");
IGuiceContext.instance().inject();
```
## Required Flow
1. Add `com.guicedee:vertx` dependency.
2. Configure `module-info.java`:
- `requires com.guicedee.vertx;`
- `opens` consumer/publisher packages to `com.google.guice` and `com.guicedee.vertx`
- `opens` DTO packages to `com.fasterxml.jackson.databind`
3. Declare consumers with `@VertxEventDefinition` on methods (preferred) or classes.
4. Inject publishers via `@Inject @Named("address") VertxEventPublisher<T>`.
5. Optionally configure runtime via `@VertX`, `@EventBusOptions`, `@MetricsOptions`, `@FileSystemOptions`, `@AddressResolverOptions` on `package-info.java` (preferred) or any class.
6. Optionally implement SPI hooks (`VertxConfigurator`, `ClusterVertxConfigurator`, `VerticleStartup`) and dual-register in `module-info.java` + `META-INF/services/`.
## Consumers — Quick Reference
### Method-based (preferred)
```java
public class OrderConsumers {
@VertxEventDefinition(value = "order.created",
options = @VertxEventOptions(worker = true))
public String handleOrder(Message<OrderRequest> message) {
return "Accepted: " + message.body().id();
}
}
```
- One `EventConsumerVerticle` deployed per address.
- `Message<T>` parameter gives raw access; any POJO parameter is Jackson-deserialized.
- Return `void`, a value, `Uni<T>`, or `Future<T>`.
- Set `worker = true` for blocking IO/DB work.
### Class-based (legacy)
```java
@VertxEventDefinition("user.login")
public class LoginConsumer {
public void consume(Message<LoginRequest> message) { message.reply("OK"); }
}
```
## Publishers — Quick Reference
```java
@Inject @Named("order.created")
private VertxEventPublisher<OrderRequest> publisher;
publisher.request(order); // request/reply → Future<R>
publisher.send(order); // point-to-point fire-and-forget (throttled)
publisher.publish(order); // broadcast to all consumers (throttled)
publisher.publishLocal(order); // local-only broadcast
```
`request()` is immediate; `send()`/`publish()` are throttled (default 50 ms FIFO drain).
## Non-Negotiable Constraints
- Never create `Vertx` manually — use the injected instance from `VertXModule`.
- At most **one** `@VertX` annotation per application.
- Consumer/publisher packages must `opens` to `com.google.guice` and `com.guicedee.vertx`.
- DTO packages must `opens` to `com.fasterxml.jackson.databind`.
- SPI implementations must be dual-registered (`module-info.java` + `META-INF/services/`).
- Use `worker = true` for any blocking or IO-bound consumer.
- `package-info.java` is preferred for package-level annotations; classes work too.
- Do not share packages between main and test source sets.
## References
- `references/consumers-publishers.md` — full consumer/publisher API, parameter/return tables, throttling config, environment variable overrides.
- `references/verticles-runtime.md` — `@Verticle` configuration, capabilities enum, runtime annotation details (`@VertX`, `@EventBusOptions`, etc.), SPI hooks, complete example project.
- `references/module-graph.md` — JPMS module graph and transitive dependencies.Related Skills
jwebmp-vertx
Portable connector between JWebMP and Vert.x 5 powered by GuicedEE. Provides automatic page routing, AJAX event pipeline, data component servlet, CSS endpoint, site-loader script, WebSocket broadcasting via event bus, user-agent detection, and call-scope integration. Use when working with JWebMP Vert.x integration, HTTP routing, AJAX handling, WebSocket communication, or building reactive web applications with JWebMP.
guicedee-websockets
RFC 6455 WebSocket support for GuicedEE using Vert.x 5: call-scoped connections, action-based message routing via IWebSocketMessageReceiver SPI, group management and broadcasting, WebSocketServerOptions, and lifecycle hooks. Use when adding WebSocket messaging, implementing real-time communication, managing WebSocket groups, or creating message receivers.
guicedee-webservices
SOAP web services for GuicedEE using Apache CXF conventions: JAX-WS annotations (@WebService, @WebMethod, @WebParam, @WebResult), code-first and WSDL-first approaches, endpoint publishing, CXF interceptors and logging, MTOM, WS-Security (WSS4J), SOAP 1.1/1.2 bindings, and Guice DI integration. Use when creating SOAP services, publishing JAX-WS endpoints, configuring CXF bindings, or adding WS-Security.
guicedee-web
Bootstrap reactive HTTP/HTTPS servers with Vert.x 5 inside GuicedEE: Router setup, BodyHandler configuration, TLS/HTTPS, SPI extension points (VertxRouterConfigurator, VertxHttpServerOptionsConfigurator, VertxHttpServerConfigurator), per-verticle sub-routers, and environment-driven configuration. Use when setting up the Vert.x web server, configuring HTTP/HTTPS, adding custom routes or middleware, or managing server options.
guicedee-service-registry
Named service registry with health-aware resolution for GuicedEE. Register services by simple name, auto-construct URLs from cloud DNS suffix, monitor health status, resolve services via registry:name prefix or bare name in rest-client @Endpoint. Supports aliases, multiple external URLs, Kubernetes internal URLs, and per-service health paths. Use when registering named services, checking service health, resolving service URLs by name, or integrating with rest-client for service-to-service calls.
guicedee-rest
Build Jakarta REST (JAX-RS) services on Vert.x 5 inside GuicedEE: @Path/@GET/@POST route registration, parameter binding (@PathParam, @QueryParam, @HeaderParam, etc.), Guice-managed resource classes, response handling, content negotiation, and JPMS module setup. Use when creating REST endpoints, configuring Jakarta REST resources, or wiring JAX-RS services with Guice injection.
guicedee-rest-client
Annotation-driven REST client for GuicedEE using Vert.x 5 WebClient: @Endpoint declarations, RestClient<Send, Receive> injection, authentication strategies (Bearer, Basic, API Key, OAuth2, mTLS), path parameters, environment variable overrides, package-level endpoints, service registry integration (bare name or registry: prefix), and RestClientConfigurator SPI. Use when making outbound REST calls, configuring REST client endpoints, or wiring reactive HTTP clients with Guice injection.
guicedee-rabbitmq
Annotation-driven RabbitMQ integration for GuicedEE with Vert.x 5: @RabbitConnectionOptions, @QueueExchange, @QueueDefinition, QueueConsumer/QueuePublisher injection, exchange management, queue options (priority, TTL, prefetch), publisher confirms, environment variable overrides, and verticle-scoped connections. Use when adding RabbitMQ messaging, declaring exchanges and queues, creating consumers and publishers, or configuring AMQP topology.
guicedee-persistence
Reactive JPA persistence with Hibernate Reactive 7, Vert.x 5 SQL clients, and Mutiny sessions inside GuicedEE: DatabaseModule setup, persistence.xml configuration, multi-database support, @EntityManager scoping, and environment variable resolution. Use when adding database persistence, configuring Hibernate Reactive, creating DatabaseModule subclasses, wiring Mutiny.SessionFactory, or managing multiple persistence units.
guicedee-openapi
Automatic OpenAPI 3.1 spec generation and serving for GuicedEE with Vert.x 5: scans Jakarta REST resources at startup, serves /openapi.json and /openapi.yaml endpoints, Swagger annotations support, @OpenAPIDefinition configuration, and companion Swagger UI module. Use when generating API documentation, serving OpenAPI specs, or configuring Swagger annotations on REST resources.
guicedee-metrics
Application metrics for GuicedEE using Vert.x 5 Dropwizard Metrics and MicroProfile Metrics 5.1: @Counted, @Timed, @MetricMethod annotations, Guice AOP interceptors, Prometheus scrape endpoint, Graphite reporting, JMX exposure, @MetricsOptions configuration, environment variable overrides, and Vert.x built-in metrics (event bus, HTTP, pools). Use when adding application metrics, configuring Prometheus endpoints, creating custom counters/timers, or monitoring Vert.x internals.
guicedee-mail-client
Annotation-driven SMTP mail client for GuicedEE with Vert.x 5: @MailConnectionOptions for SMTP server configuration, MailService injection for sending text/HTML/multipart emails with attachments, connection pooling, StartTLS/SSL support, DKIM signing, environment variable overrides, and graceful shutdown. Use when sending emails via SMTP, configuring mail connections, or injecting mail services.