com.sap.cloud.alert.notification.client.IAlertNotificationAsyncClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of clm-sl-alert-notification-client Show documentation

Means for out-of-the-box events management in SAP Alert Notification service for SAP BTP service.

There is a newer version: 1.11.0

Show newest version

package com.sap.cloud.alert.notification.client;

import com.sap.cloud.alert.notification.client.exceptions.BufferOverflowException;
import com.sap.cloud.alert.notification.client.model.CustomerResourceEvent;
import com.sap.cloud.alert.notification.client.model.PagedResponse;

import java.util.Map;
import java.util.concurrent.CompletableFuture;

public interface IAlertNotificationAsyncClient {

    /**
     * Posts an event for async processing.
     *
     * @param event to be sent to SAP Alert Notification service for SAP BTP
     * @return the posted event enhanced with an unique ID that could be used for tracing
     * @throws BufferOverflowException if the event cannot be accepted for execution due to full buffer capacity
     */
    CompletableFuture sendEvent(CustomerResourceEvent event) throws BufferOverflowException;

    /**
     * Gets events that are matched by client's subscription.
     *
     * @param queryParameters for filtering of all available matched events
     * @return found results in pages
     * @throws BufferOverflowException if the event cannot be accepted for execution due to full buffer capacity
     */
    CompletableFuture getMatchedEvents(Map queryParameters) throws BufferOverflowException;

    /**
     * Gets event that is matched by client's subscription.
     *
     * @param eventId is the ID that was received in the response body when event was sent to SAP Alert Notification service for SAP BTP
     * @param queryParameters for filtering of all available events (those could be more than one with the same ID due to multiple matched subscriptions)
     * @return found results in pages
     * @throws BufferOverflowException if the event cannot be accepted for execution due to full buffer capacity
     */
    CompletableFuture getMatchedEvent(String eventId, Map queryParameters) throws BufferOverflowException;

    /**
     * Gets events undelivered to some targets.
     *
     * @param queryParameters for filtering of all available undelivered events
     * @return found results in pages
     * @throws BufferOverflowException if the event cannot be accepted for execution due to full buffer capacity
     */
    CompletableFuture getUndeliveredEvents(Map queryParameters) throws BufferOverflowException;

    /**
     * Gets event undelivered to some targets.
     *
     * @param eventId is the ID that was received in the response body when event was sent to SAP Alert Notification service for SAP BTP
     * @param queryParameters for filtering of all available events (those could be more than one with the same ID due to multiple matched subscriptions)
     * @return found results in pages
     * @throws BufferOverflowException if the event cannot be accepted for execution due to full buffer capacity
     */
    CompletableFuture getUndeliveredEvent(String eventId, Map queryParameters)
            throws BufferOverflowException;

    void shutdown();
}