rapture.common.api.PipelineApi 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.RapturePipelineTask;
import rapture.common.CategoryQueueBindings;
import rapture.common.PipelineTaskStatus;
import rapture.common.model.RaptureExchange;
import rapture.common.TableQuery;


@SuppressWarnings("all")
public interface PipelineApi {
     /**
     * Deletes a given category.
     * 
     */
     void removeServerCategory(CallingContext context, String category);

     /**
     * List server categories.
     * 
     */
     List getServerCategories(CallingContext context);

     /**
     * Get bound exchanges for a category
     * 
     */
     List getBoundExchanges(CallingContext context, String category);

     /**
     * Removes an exchange.
     * 
     */
     void deregisterPipelineExchange(CallingContext context, String name);

     /**
     * Retrieves all registered exchanges.
     * 
     */
     List getExchanges(CallingContext context);

     /**
     * Retrieves an exchange object by name.
     * 
     */
     RaptureExchange getExchange(CallingContext context, String name);

     /**
     * Publishes a message. This message will be published to the category specified in
     * the RapturePipelineTask object. If no category is specified, an error is thrown.
     * This type of message should be handled by only one of the servers belonging to this
     * category; in other words, it is not a broadcast.
     * 
     */
     void publishMessageToCategory(CallingContext context, RapturePipelineTask task);

     /**
     * This message will be broadcasted to all servers belonging to the category specified
     * in the RapturePipelineTask object. If no category is specified, an error is thrown.
     * 
     */
     void broadcastMessageToCategory(CallingContext context, RapturePipelineTask task);

     /**
     * This message will be broadcasted to all servers connected to the pipeline system.
     * 
     */
     void broadcastMessageToAll(CallingContext context, RapturePipelineTask task);

     /**
     * Gets the status for a published RapturePipelineTask.
     * 
     */
     PipelineTaskStatus getStatus(CallingContext context, String taskId);

     /**
     * Queries for pipeline statuses.
     * 
     */
     List queryTasks(CallingContext context, String query);

     /**
     * Queries for pipeline statuses.
     * 
     */
     List queryTasksOld(CallingContext context, TableQuery query);

     /**
     * On the task information, get the latest epoch (the maximum message id).
     * 
     */
     Long getLatestTaskEpoch(CallingContext context);

     /**
     * Drain an exchange - remove all messages.
     * 
     */
     void drainPipeline(CallingContext context, String exchange);

     /**
     * Registers a new exchange domain.
     * 
     */
     void registerExchangeDomain(CallingContext context, String domainURI, String config);

     /**
     * Removes an exchange domain.
     * 
     */
     void deregisterExchangeDomain(CallingContext context, String domainURI);

     /**
     * Retrieves all registered exchange domains.
     * 
     */
     List getExchangeDomains(CallingContext context);

     /**
     * Sets up the default queue-exchanges and bindings for a given category.
     * 
     */
     void setupStandardCategory(CallingContext context, String category);

     /**
     * Make an RPC call using a pair of queues on the pipeline of the default exchange.
     * I notice that the exchange is removed from the above call which seems to be a
     * bit of a regression
     * 
     */
     Map makeRPC(CallingContext context, String queueName, String fnName, Map params, Long timeoutInSeconds);

     /**
     * Create a topic exchange that can be used to pub/sub on
     * 
     */
     void createTopicExchange(CallingContext context, String domain, String exchange);

     /**
     * Publish on topic exchange (Subscription has to go low level)
     * 
     */
     void publishTopicMessage(CallingContext context, String domain, String exchange, String topic, String message);

}