org.symphonyoss.symphony.clients.DataFeedClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of symphony-client Show documentation
The newest version!
/*
 *
 * Copyright 2016 The Symphony Software Foundation
 *
 * Licensed to The Symphony Software Foundation (SSF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.symphonyoss.symphony.clients;

import org.symphonyoss.client.exceptions.DataFeedException;
import org.symphonyoss.symphony.agent.model.Datafeed;
import org.symphonyoss.client.events.SymEvent;
import org.symphonyoss.symphony.clients.model.ApiVersion;
import org.symphonyoss.symphony.clients.model.SymDatafeed;


import java.util.List;

/**
 * Provides access to datafeed in order to stream all message events (messages) through blocking calls.
 *
 * Created by Frank Tarsillo on 5/15/2016.
 */
public interface DataFeedClient {


    /**
     * Create a datafeed to consume messages/events from
     *
     * @param apiVersion {@link ApiVersion} to use (V2, V4..)
     * @return Datafeed object to process messages from
     * @throws DataFeedException Caused by Symphony API calls
     */
    SymDatafeed createDatafeed(ApiVersion apiVersion) throws DataFeedException;


    /**
     * This will return events from datafeed object through underlying blocking calls.  This method should be called
     * repeatedly to pull event based data.
     *
     * This is only used for V4+ enabled clients.
     *
     * @param datafeed Datafeed object associated with BOT user
     * @param maxMessages maximum number of messages returned.
     * @return List of base messages
     * @throws DataFeedException Caused by Symphony API calls
     */
    List getEventsFromDatafeed(SymDatafeed datafeed, int maxMessages) throws DataFeedException;


    /**
     * This will return events from datafeed object through underlying blocking calls.  This method should be called
     * repeatedly to pull event based data.
     *
     * This is only used for V4+ enabled clients.
     *
     * @param datafeed Datafeed object associated with BOT user
     * @return List of base messages
     * @throws DataFeedException Caused by Symphony API calls
     */
    List getEventsFromDatafeed(SymDatafeed datafeed) throws DataFeedException;
}