rapture.common.api.NotificationApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.exception.RaptureException;
import rapture.common.CallingContext;
import java.util.List;
import java.util.Map;
import rapture.common.model.RaptureNotificationConfig;
import rapture.common.NotificationInfo;
import rapture.common.RaptureFolderInfo;
import rapture.common.NotificationResult;


@SuppressWarnings("all")
public interface NotificationApi {
     /**
     * This method retrieves the notification providers in use at this Rapture system.
     * 
     */
     List getNotificationManagerConfigs(CallingContext context);

     /**
     * Returns a list of full display names of the paths below this one. Ideally optimized
     * depending on the repo.
     * 
     */
     List listNotificationsByUriPrefix(CallingContext context, String uriPrefix);

     /**
     * Notification providers have an associated purpose - this method returns only those
     * providers that match the given purpose.
     * 
     */
     List findNotificationManagerConfigsByPurpose(CallingContext context, String purpose);

     /**
     * This method creates a definition of a notification provider.
     * 
     */
     RaptureNotificationConfig createNotificationManager(CallingContext context, String notificationManagerUri, String config, String purpose);

     /**
     * Indicates whether a notification provider with notificationName was found.
     * 
     */
     Boolean notificationManagerExists(CallingContext context, String notificationManagerUri);

     /**
     * This method returns the low level config for a given notification provider.
     * 
     */
     RaptureNotificationConfig getNotificationManagerConfig(CallingContext context, String notificationManagerUri);

     /**
     * This method removes a notification provider and all its content.
     * 
     */
     void deleteNotificationManager(CallingContext context, String notificationManagerUri);

     /**
     * This method retrieves the current epoch number for a given notification point.
     * 
     */
     Long getLatestNotificationEpoch(CallingContext context, String notificationManagerUri);

     /**
     * This method pushes a notification to a provider.
     * 
     */
     String publishNotification(CallingContext context, String notificationManagerUri, String referenceId, String content, String contentType);

     /**
     * This method returns the changes seen on a notification since an epoch. A client would
     * then update its latest epoch by using the value in the notification result.
     * 
     */
     NotificationResult findNotificationsAfterEpoch(CallingContext context, String notificationManagerUri, Long epoch);

     /**
     * This method returns a notification message given its id.
     * 
     */
     NotificationInfo getNotification(CallingContext context, String notificationUri, String id);

}