thomaswega / rabbitmqevents

Send global events through RabbitMQ

RabbitMQEvents Documentation

Initialization

To start using RabbitMQEvents, you need initialize the necessary RabbitManager, RabbitEventManager and create an EventBus. Below is an example:

// Initialize RabbitMQ manager
public RabbitManager rabbitManager = new RabbitManager("guest", "guest", "127.0.0.1", 5672);

// Initialize RabbitMQ event manager and event bus
public RabbitEventManager rabbitEventManager;
public RabbitEventBus<RabbitEvent> rabbitEventBus;

public void initialize() {
    this.rabbitManager.onChannelInitialized(() -> {
        // Initialize event manager and event bus when the RabbitMQ channel is ready
        this.rabbitEventManager = new RabbitEventManager("events", this.rabbitManager.getChannel());
        this.rabbitEventBus = EventBus.rabbitEventBus(this.rabbitEventManager, RabbitEvent.class);
    }, 10, 250);
}

Creating Custom Events

Define custom events by implementing the RabbitEvent interface. Here's an example:

public class TestEvent implements RabbitEvent {
    private final @NotNull UUID uuid;

    public TestEvent(@NotNull UUID uuid) {
        this.uuid = uuid;
    }

    public @NotNull UUID getUUID() {
        return this.uuid;
   }
}

Creating Event Configuration

Every event needs it's own configuration class where you can customize the behavior of event publishing and consumption. Create a configuration class implementing the RabbitEventConfigFactory or RabbitEventConfig interface. Here's an example:

public class TestEventConfig implements RabbitEventConfigFactory<TestEvent> {

    @Override
    public @NotNull RabbitEventConfig<TestEvent> config() {
        return new RabbitEventConfigBuilder<TestEvent>()
                .exchangeName("event.test")
                .exchangeType(BuiltinExchangeType.FANOUT)
                .exchangeRoutingKey("test.#")
                .properties(new AMQP.BasicProperties().builder()
                        .expiration("10000")
                        .build()
                )
                .toJson(event -> new JSONObject()
                        .put("uuid", event.getUUID())
                )
                .fromJson(jsonObject -> new TestEvent(UUID.fromString(jsonObject.getString("uuid"))))
                .build();
    }
}

Cancellable events

Events can be cancellable with priorities in mind. Just implement from Cancellable interface or extend from AbstractCancellable class

Subscribing to Events

Subscribe to events with a dedicated event subscriber class:

public class TestEventSubscriber implements EventSubscriber<TestEvent> {
    @Override
    public void onEvent(@NotNull TestEvent event) {
        System.out.println("EVENT UUID = " + event.getUUID());
    }

    @Override
    public int postOrder() {
        return PostOrder.NORMAL;
    }

    @Override
    public boolean acceptsCancelled() {
        return false;
    }
}

This will create the following queues and exchanges

Publishing Events

Publish events using the event manager:

rabbitEventManager.publish(new TestEvent(uuid), new TestEventConfig().config());

Closing Connections

Ensure all connections are closed when they are no longer needed:

rabbitManager.close();

Example Usage

Explore a complete example of RabbitMQEvents used in a Minecraft Spigot plugin here.