guicedee-ibmmq

Annotation-driven IBM MQ integration for GuicedEE with JMS 3.0: @IBMMQConnectionOptions, @IBMMQQueueDefinition, @IBMMQQueueOptions, IBMMQConsumer/IBMMQPublisher injection, JMS ConnectionFactory binding, queue and topic support, durable subscriptions, message selectors, transacted sessions, environment variable overrides, call-scoped message handling, and graceful shutdown. Use when adding IBM MQ messaging, declaring queue/topic consumers and publishers, configuring MQ connections, or integrating with IBM MQ queue managers.

5 stars

Best use case

guicedee-ibmmq is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Annotation-driven IBM MQ integration for GuicedEE with JMS 3.0: @IBMMQConnectionOptions, @IBMMQQueueDefinition, @IBMMQQueueOptions, IBMMQConsumer/IBMMQPublisher injection, JMS ConnectionFactory binding, queue and topic support, durable subscriptions, message selectors, transacted sessions, environment variable overrides, call-scoped message handling, and graceful shutdown. Use when adding IBM MQ messaging, declaring queue/topic consumers and publishers, configuring MQ connections, or integrating with IBM MQ queue managers.

Teams using guicedee-ibmmq 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

$curl -o ~/.claude/skills/guicedee-ibmmq/SKILL.md --create-dirs "https://raw.githubusercontent.com/GuicedEE/ai-rules/main/skills/.system/guicedee-ibmmq/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/guicedee-ibmmq/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How guicedee-ibmmq Compares

Feature / Agentguicedee-ibmmqStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Annotation-driven IBM MQ integration for GuicedEE with JMS 3.0: @IBMMQConnectionOptions, @IBMMQQueueDefinition, @IBMMQQueueOptions, IBMMQConsumer/IBMMQPublisher injection, JMS ConnectionFactory binding, queue and topic support, durable subscriptions, message selectors, transacted sessions, environment variable overrides, call-scoped message handling, and graceful shutdown. Use when adding IBM MQ messaging, declaring queue/topic consumers and publishers, configuring MQ connections, or integrating with IBM MQ queue 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 IBM MQ

Annotation-driven IBM MQ integration for GuicedEE using the IBM MQ JMS client (com.ibm.mq.allclient).

## Core Concept

Declare connections, queues/topics, consumers, and publishers with annotations — everything is discovered at startup via ClassGraph, wired through Guice, and managed by the IBM MQ JMS client.

## Required Flow

1. Add `com.guicedee:ibmmq` dependency.
2. Define a connection on `package-info.java` (preferred) or any class:
   ```java
   @com.guicedee.vertx.Verticle
   @IBMMQConnectionOptions(
       value = "my-connection",
       host = "localhost",
       port = 1414,
       queueManager = "QM1",
       channel = "DEV.APP.SVRCONN",
       user = "app",
       password = "passw0rd"
   )
   package com.example.messaging;
   ```
3. Create a consumer:
   ```java
   @IBMMQQueueDefinition(
       value = "DEV.QUEUE.1",
       options = @IBMMQQueueOptions(worker = true, transacted = true)
   )
   public class OrderConsumer implements IBMMQConsumer {
       @Override
       public void consume(Message message) {
           try {
               TextMessage tm = (TextMessage) message;
               System.out.println("Received: " + tm.getText());
           } catch (JMSException e) {
               throw new RuntimeException(e);
           }
       }
   }
   ```
4. Inject a publisher:
   ```java
   public class OrderService {
       @Inject @Named("DEV.QUEUE.1")
       private IBMMQPublisher orderPublisher;

       public void placeOrder(String orderJson) {
           orderPublisher.publish(orderJson);
       }
   }
   ```
5. Configure `module-info.java`:
   ```java
   module my.app {
       requires com.guicedee.ibmmq;
       opens my.app.messaging to com.google.guice, com.guicedee.ibmmq;
   }
   ```

## Annotations

### `@IBMMQConnectionOptions`
Connection configuration: host, port, queue manager, channel, credentials, transport type (client/bindings), SSL/TLS, CCSID, reconnect settings, application name. Targets `TYPE` and `PACKAGE`.

### `@IBMMQQueueDefinition`
Queue/topic declaration: name, consumer options, connection reference. Targets `TYPE` and `FIELD`.

### `@IBMMQQueueOptions`
Consumer tuning: auto-ack, worker threads, consumer count, transacted sessions, autobind, receive timeout, topic mode, durable subscriptions, message selectors, persistence, priority, time-to-live.

## Injectable Components

| Binding | Key | Description |
|---|---|---|
| `IBMMQPublisher` | `@Named("queue-name")` | Publisher for a specific queue or topic |
| `IBMMQConsumer` | `@Named("queue-name")` | Consumer for a specific queue or topic |
| `ConnectionFactory` | `@Named("connection-name")` | JMS ConnectionFactory per connection |

## Environment Variable Overrides

Every annotation attribute can be overridden via system properties or environment variables at runtime, scoped by connection/queue name:
- `IBMMQ_{NORMALIZED_NAME}_{PROPERTY}` — name-specific override
- `IBMMQ_{PROPERTY}` — global fallback

## Startup Flow

```
IGuiceContext.instance().inject()
 └─ IBMMQPreStartup (annotation scanning)
     ├─ Discovers @IBMMQConnectionOptions
     ├─ Discovers @IBMMQQueueDefinition consumers
     ├─ Registers publisher metadata
     └─ Registers consumer metadata
 └─ IBMMQModule (Guice bindings)
     ├─ Creates JMS ConnectionFactory per connection
     ├─ Binds IBMMQConsumer as singletons
     └─ Binds IBMMQPublisher as @Named("queue-name")
 └─ IBMMQPostStartup (runtime initialization)
     ├─ Creates JMS contexts and consumers
     ├─ Starts polling threads for message consumption
     └─ Call-scoped message dispatch with transacted/ack support
 └─ IBMMQPreDestroy (shutdown)
     ├─ Closes all JMS consumers
     └─ Closes all JMS contexts
```

## Non-Negotiable Constraints

- Module must `requires com.guicedee.ibmmq;`.
- Consumer/publisher packages must `opens` to `com.google.guice` and `com.guicedee.ibmmq`.
- DTO packages must `opens` to `com.fasterxml.jackson.databind`.
- SPI implementations must be dual-registered (`module-info.java` + `META-INF/services/`).
- `@IBMMQConnectionOptions` can be placed on `package-info.java` (preferred) or any class.
- Consumer classes must implement `IBMMQConsumer` and be annotated with `@IBMMQQueueDefinition`.
- IBM MQ client JAR (`com.ibm.mq.allclient`) must be available on the module path.

Related Skills

guicedee-websockets

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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

5
from GuicedEE/ai-rules

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.