io.keen.client.java.KeenEventStore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of keen-client-java-core Show documentation

Java Client Core Library for Keen

There is a newer version: 6.0.0

Show newest version

package io.keen.client.java;

import java.io.IOException;
import java.util.List;
import java.util.Map;

/**
 * Interface which provides an abstraction layer around how events are stored in between being
 * queued and being uploaded by a batch post operation.
 *
 * @author Kevin Litwack ([email protected])
 * @since 2.0.0
 */
public interface KeenEventStore {

    /**
     * Stores the given event.
     *
     * @param projectId       The ID of the project in which the event should be stored.
     * @param eventCollection The name of the collection in which the event should be stored.
     * @param event           The serialized JSON for the event to store.
     * @return A handle which can be used to retrieve or remove the event.
     * @throws IOException If there is an error storing the event.
     */
    Object store(String projectId, String eventCollection, String event) throws IOException;

    /**
     * Gets the event corresponding to the given handle.
     *
     * @param handle A handle returned from a previous call to {@link #store(String, String,
     * String)}
     *               or {@link #getHandles(String)}.
     * @return The serialized JSON for the event, or null if the handle is no longer present in
     * the store.
     * @throws IOException If there is an error retrieving the event.
     */
    String get(Object handle) throws IOException;

    /**
     * Removes the specified event from the store.
     *
     * @param handle A handle returned from a previous call to {@link #store(String, String,
     * String)}
     *               or {@link #getHandles(String)}.
     * @throws IOException If there is an error removing the event.
     */
    void remove(Object handle) throws IOException;

    /**
     * Retrieves a map from collection names to lists of handles currently stored under each
     * collection. This will be used by the {@link io.keen.client.java.KeenClient} to retrieve the
     * events to send in a batch to the Keen server, as well as to remove all successfully posted
     * events after processing the response.
     *
     * @param projectId The ID of the project for which to retrieve event handles.
     * @return A map from collection names to lists of handles currently stored under each
     * collection. If there are no events, an empty map will be returned.
     * @throws IOException If there is an error retrieving the handles.
     */
    Map> getHandles(String projectId) throws IOException;

}