com.addc.commons.queue.PersistingQueueStatistics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of addc-queues Show documentation

The addc-queues library supplies support for internal persistent queues using an optional DERBY database for storage.

The newest version!

package com.addc.commons.queue;

import javax.management.ObjectName;

/**
 * The PersitingQueueStatistics stores statistics for queuing events in a
 * {@link PersistingQueue}
 */
public interface PersistingQueueStatistics {

    /**
     * An item was added to the queue
     * 
     * @param payload
     *            The item added
     */
    void itemCreated(T payload);

    /**
     * An item was dropped by the queue
     * 
     * @param payload
     *            the item dropped
     */
    void itemDropped(T payload);

    /**
     * An item was read from persistence
     * 
     * @param payload
     *            The item read
     */
    void itemReadFromPersistence(T payload);

    /**
     * An item was written to persistence
     * 
     * @param payload
     *            The item written
     */
    void itemWrittenToPersistence(T payload);

    /**
     * Get a dump of the statistics for the queue
     * 
     * @return A dump of the statistics
     */
    String getQueueStatistics();

    /**
     * Get the JMX object name for this object.
     *
     * @return The JMX object name for this object.
     */
    ObjectName getObjectName();
}