API Reference¶

Complete reference for all public classes, interfaces, methods, and fields in IgnisMQ.

IQueue¶

The primary interface for interacting with a queue. Generic parameter M is the message type.

Methods¶

IgnisMQManager¶

public final class IgnisMQManager implements Managed

Central manager for all queue lifecycle operations. Implements Dropwizard Managed for start/stop hooks.

Constructors¶

public IgnisMQManager(
    String clientId,
    BaseStorage storage,
    ObjectMapper mapper,
    MetricRegistry metricRegistry,
    CuratorFramework curatorFramework,
    String farmId
) throws Exception

Creates the manager without an externally provided StorageClient. The client is constructed internally from the storage configuration.

public IgnisMQManager(
    String clientId,
    BaseStorage storage,
    ObjectMapper mapper,
    MetricRegistry metricRegistry,
    StorageClient storageClient,
    CuratorFramework curatorFramework,
    String farmId
) throws Exception

Creates the manager with an externally managed StorageClient, allowing the caller to share or reuse the underlying database connection.

Methods¶

initialiseMessageHandlers¶

void initialiseMessageHandlers(Map<String, Map.Entry<Class, MessageHandler>> messageHandlers)

Registers all message handler mappings. Must be called exactly once before any call to createQueue. Subsequent calls will fail. Internally calls refreshQueues() to sync state from the database and registers a QueueStatGauge for metrics.

[!WARNING] Calling this method more than once will throw an exception. Ensure all handlers are collected into a single map before invoking.

getQueue¶

<M> IQueue<M> getQueue(String name)

Returns the in-memory IQueue instance for the given queue name.

Throws: IgnisMQException with ErrorCode.QUEUE_NOT_FOUND if no queue with that name exists.

getAllQueues¶

Map<String, IQueue<?>> getAllQueues()

Returns the full in-memory map of queue name to IQueue instance.

getAllQueuesFromDB¶

Set<String> getAllQueuesFromDB()

Queries Aerospike and returns the set of all active queue names persisted in the database.

createQueue¶

void createQueue(CreateQueueRequest queueRequest) throws Exception

Validates the request, creates the underlying Magazine structure, and persists a QueueEntity to the database. Starts consumers and schedules sweeps/shovels as configured.

Throws: IgnisMQException with ErrorCode.QUEUE_ALREADY_EXISTS if a queue with the same name is already active.

deactivateQueue¶

void deactivateQueue(String queueName)

Stops all consumers for the queue, removes it from the in-memory map, and sets active=false in the database.

[!CAUTION] This operation is irreversible. The queue cannot be reactivated after deactivation.

increaseConsumers¶

void increaseConsumers(String queueName, int count)

Adds count new consumer timers for the specified queue and updates the concurrency value in the database.

decreaseConsumers¶

void decreaseConsumers(String queueName, int count)

Stops count consumer timers for the specified queue and updates the concurrency value in the database.

scheduleShoveling¶

void scheduleShoveling(String queueName, ShovelConfig shovelConfig)

Schedules periodic shoveling for the queue using the interval and concurrency defined in shovelConfig.

sweepQueue¶

void sweepQueue(String queueName)

Manually triggers a sweep operation for the specified queue.

refreshQueues¶

void refreshQueues()

Synchronizes the in-memory queue map with the persisted state in the database. Creates or removes queue instances as needed.

getTaskInitializer¶

TaskInitializer getTaskInitializer()

Returns the internal TaskInitializer instance used for scheduling consumer and sweep tasks.

MessageHandler<M>¶

public interface MessageHandler<M>

User-implemented interface for processing messages consumed from a queue.

Methods¶

CreateQueueRequest¶

@Data
public class CreateQueueRequest

Request object for creating a new queue via IgnisMQManager.createQueue().

Fields¶

[!IMPORTANT] Validation requires queueExpiry >= messageExpiry. Both queueExpiry and messageExpiry must resolve to valid durations within the allowed maximum.

ShovelConfig¶

@Data @Builder @AllArgsConstructor
public class ShovelConfig

Configuration for periodic shoveling of sidelined messages back into the queue.

Fields¶

BatchingConfig¶

@Data @Builder @AllArgsConstructor
public class BatchingConfig

Configuration for batch message consumption.

Fields¶

TimeToLive¶

@Getter
public class TimeToLive

Represents a duration with a unit, used for message and queue expiry.

Fields¶

Methods¶

[!NOTE] Maximum allowed value after conversion is 31,536,000 seconds (1 year).

TimeUnit¶

public enum TimeUnit {
    MINUTE,
    HOUR,
    DAY
}

QueueMetaData¶

@Data @Builder @AllArgsConstructor @NoArgsConstructor
public class QueueMetaData

Fields¶

QueueEntity¶

@Data @Builder @AllArgsConstructor @NoArgsConstructor
public class QueueEntity

Persistent representation of a queue stored in Aerospike.

Fields¶

BaseStorage¶

public abstract sealed class BaseStorage permits AerospikeStorage

Abstract base for storage backends.

Fields¶

Methods¶

AerospikeStorage¶

public final class AerospikeStorage extends BaseStorage

Aerospike-backed storage implementation.

Fields¶

Constructor¶

public AerospikeStorage(AerospikeConfiguration configuration, String namespace)

StorageClient\<T>¶

public interface StorageClient<T>

Generic interface for obtaining a database client handle.

Methods¶

AerospikeStoreClient¶

public final class AerospikeStoreClient implements StorageClient<IAerospikeClient>, Managed

Aerospike client wrapper that auto-starts on construction.

Constructor¶

public AerospikeStoreClient(AerospikeConfiguration aerospikeConfiguration)

[!NOTE] The client starts automatically on construction. Write policy is configured with COMMIT_ALL commit level and MASTER_PROLES replica policy.

QueueService¶

public sealed interface QueueService permits AerospikeQueueService

Internal service interface for queue persistence operations.

Methods¶

IgnisMQBundle\<T>¶

public abstract class IgnisMQBundle<T extends Configuration> implements ConfiguredBundle<T>

Dropwizard bundle for integrating IgnisMQ into a Dropwizard application.

Abstract Methods¶

Methods¶

IgnisMQException¶

public class IgnisMQException extends RuntimeException

Fields¶

Static Methods¶

ErrorCode¶

public enum ErrorCode

QueueStat¶

@Data @Builder
public class QueueStat

Fields¶

Constants¶

All constants defined in Constants.java: