guicedee-kafka
Annotation-driven Kafka integration for GuicedEE with Vert.x 5: @KafkaConnectionOptions, @KafkaTopicDefinition, @KafkaTopicCreate, KafkaTopicConsumer/KafkaTopicPublisher injection, KafkaAdminClient binding, per-topic consumers, manual offset commit, worker thread support, partition assignment and revocation handlers, environment variable overrides, call-scoped message handling, and graceful shutdown. Use when adding Kafka messaging, declaring topic consumers and publishers, creating topics via admin client, or configuring Kafka connections.
Best use case
guicedee-kafka is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Annotation-driven Kafka integration for GuicedEE with Vert.x 5: @KafkaConnectionOptions, @KafkaTopicDefinition, @KafkaTopicCreate, KafkaTopicConsumer/KafkaTopicPublisher injection, KafkaAdminClient binding, per-topic consumers, manual offset commit, worker thread support, partition assignment and revocation handlers, environment variable overrides, call-scoped message handling, and graceful shutdown. Use when adding Kafka messaging, declaring topic consumers and publishers, creating topics via admin client, or configuring Kafka connections.
Teams using guicedee-kafka 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-kafka/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How guicedee-kafka Compares
| Feature / Agent | guicedee-kafka | 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?
Annotation-driven Kafka integration for GuicedEE with Vert.x 5: @KafkaConnectionOptions, @KafkaTopicDefinition, @KafkaTopicCreate, KafkaTopicConsumer/KafkaTopicPublisher injection, KafkaAdminClient binding, per-topic consumers, manual offset commit, worker thread support, partition assignment and revocation handlers, environment variable overrides, call-scoped message handling, and graceful shutdown. Use when adding Kafka messaging, declaring topic consumers and publishers, creating topics via admin client, or configuring Kafka connections.
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 Kafka
Annotation-driven Apache Kafka integration for GuicedEE using the Vert.x Kafka client.
## Core Concept
Declare connections, topics, consumers, and publishers with annotations — everything is discovered at startup via ClassGraph, wired through Guice, and managed by the Vert.x Kafka client.
## Required Flow
1. Add `com.guicedee:kafka` dependency.
2. Define a connection on `package-info.java` (preferred) or any class:
```java
@KafkaConnectionOptions(
value = "my-connection",
bootstrapServers = "localhost:9092",
groupId = "my-group"
)
@KafkaTopicCreate(value = "order-events", partitions = 3, replicationFactor = 1)
package com.example.messaging;
```
3. Create a consumer:
```java
@KafkaTopicDefinition(
value = "order-events",
options = @KafkaTopicOptions(worker = true)
)
public class OrderConsumer implements KafkaTopicConsumer<String, String> {
@Override
public void consume(KafkaConsumerRecord<String, String> record) {
System.out.println("Received: " + record.value());
}
}
```
4. Inject a publisher:
```java
public class OrderService {
@Inject @Named("order-events")
private KafkaTopicPublisher orderPublisher;
public void placeOrder(String orderJson) {
orderPublisher.send("order-key", orderJson);
}
}
```
5. Configure `module-info.java`:
```java
module my.app {
requires com.guicedee.kafka;
opens my.app.messaging to com.google.guice, com.guicedee.kafka;
}
```
## Annotations
### `@KafkaConnectionOptions`
Connection configuration: bootstrap servers, group id, serializers/deserializers, acks, retries, timeouts, batch size, buffer memory. Targets `TYPE` and `PACKAGE`.
### `@KafkaTopicDefinition`
Topic declaration: name, consumer options. Targets `TYPE`, `FIELD`, and `PACKAGE`.
### `@KafkaTopicOptions`
Consumer tuning: auto-commit, worker threads, consumer count, partition assignment, max poll interval, pause on start.
### `@KafkaTopicCreate` (Repeatable)
Admin client topic creation at startup: topic name, partitions, replication factor, ignore-if-exists. Targets `TYPE` and `PACKAGE`.
## Injectable Components
| Binding | Key | Description |
|---|---|---|
| `KafkaTopicPublisher` | `@Named("topic-name")` | Publisher for a specific topic |
| `KafkaTopicConsumer` | `@Named("topic-name")` | Consumer for a specific topic |
| `KafkaProducer<String,String>` | `@Named("connection-name")` | Raw Vert.x Kafka producer per connection |
| `KafkaConsumer<String,String>` | `@Named("connection-name")` | Raw Vert.x Kafka consumer per connection |
| `KafkaAdminClient` | `@Named("connection-name")` | Vert.x Kafka admin client per connection |
## Environment Variable Overrides
Every annotation attribute can be overridden via system properties or environment variables at runtime, scoped by connection/topic name:
- `KAFKA_{NORMALIZED_NAME}_{PROPERTY}` — name-specific override
- `KAFKA_{PROPERTY}` — global fallback
## Startup Flow
```
IGuiceContext.instance().inject()
└─ KafkaPreStartup (annotation scanning)
├─ Discovers @KafkaConnectionOptions (classes and package-info.java)
├─ Discovers @KafkaTopicCreate annotations
├─ Discovers @KafkaTopicDefinition consumers
└─ Registers metadata for binding
└─ KafkaModule (Guice bindings)
├─ Creates KafkaProducer per connection
├─ Creates KafkaConsumer per connection
├─ Creates KafkaAdminClient per connection
├─ Binds KafkaTopicConsumer as singletons
└─ Binds KafkaTopicPublisher as @Named("topic-name")
└─ KafkaPostStartup (runtime initialization)
├─ Creates declared topics via admin client
├─ Creates per-topic consumers
├─ Registers partition assigned/revoked handlers
├─ Subscribes to topics or assigns partitions
└─ Starts consuming with call-scoped message handling
└─ KafkaPreDestroy (shutdown)
├─ Closes all topic consumers
├─ Closes all package consumers
├─ Closes all producers
└─ Closes all admin clients
```
## Non-Negotiable Constraints
- Module must `requires com.guicedee.kafka;`.
- Consumer/publisher packages must `opens` to `com.google.guice` and `com.guicedee.kafka`.
- DTO packages must `opens` to `com.fasterxml.jackson.databind`.
- SPI implementations must be dual-registered (`module-info.java` + `META-INF/services/`).
- `@KafkaConnectionOptions` can be placed on `package-info.java` (preferred) or any class.
- `@KafkaTopicCreate` can be placed on `package-info.java` (preferred) or any class. It is repeatable.Related Skills
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-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.
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.