CommandClusterInteraction.java

/**
 * diqube: Distributed Query Base.
 *
 * Copyright (C) 2015 Bastian Gloeckle
 *
 * This file is part of diqube.
 *
 * diqube is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.diqube.ui.websocket.request;

import org.diqube.remote.query.thrift.ClusterInformationService;
import org.diqube.remote.query.thrift.FlattenPreparationService;
import org.diqube.remote.query.thrift.IdentityService;
import org.diqube.remote.query.thrift.QueryResultService;

/**
 * Enables a command to interact with the diqube-server cluster.
 * 
 * An instance of this interface is specific to a session/requestId.
 *
 * @author Bastian Gloeckle
 */
public interface CommandClusterInteraction {
  /**
   * Execute a diql query and provide results to the given result handler.
   */
  public void executeDiqlQuery(String diql, QueryResultService.Iface resultHandler);

  /**
   * Execute the query that was started with
   * {@link #executeDiqlQuery(String, org.diqube.remote.query.thrift.QueryResultService.Iface)}.
   */
  public void cancelQuery();

  /**
   * @return An instance of {@link ClusterInformationService} that can be used to synchronously query information about
   *         the cluster.
   */
  public ClusterInformationService.Iface getClusterInformationService();

  /**
   * @return An instance of {@link FlattenPreparationService} that can be used to warm up the cluster with a flattened
   *         table.
   */
  public FlattenPreparationService.Iface getFlattenPreparationService();

  /**
   * @return An instance of {@link IdentityService} that can be used to login/logout.
   */
  public IdentityService.Iface getIdentityService();
}