com.van.logging.IPublishHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of appender-core Show documentation

Core functionality to send content to various channels

There is a newer version: 5.5.0

package com.van.logging;

/**
 * Interface for publish implementations to actually push log events to
 * external stores.
 *
 * @author vly
 *
 */
public interface IPublishHelper {
    /**
     * A publish batch is starting.  This is a good place to (re)initialize
     * a buffer.
     *
     * @param context publish context providing useful properties for the
     * publish operation
     */
    void start(PublishContext context);

    /**
     * A log event should be published.  Implementations may want to accumulate
     * this in a batch until {{@link #end(PublishContext)}
     *
     * @param context publish context providing useful properties for the
     * publish operation
     * @param sequence counter of the sequence of this event in the batch
     * @param event the log event
     */
    void publish(PublishContext context, int sequence, T event);

    /**
     * A publish batch has ended.  Implementations should conclude a batch
     * and clean up resources here.
     *
     * @param context publish context providing useful properties for the
     * publish operation
     */
    void end(PublishContext context);
}