source: branches/irace/HeuristicLab.Services.Hive/3.3/ServiceContracts/IHiveService.cs @ 11503

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Net.Security;
using System.ServiceModel;
using HeuristicLab.Services.Hive.DataTransfer;

namespace HeuristicLab.Services.Hive.ServiceContracts {

  [ServiceContract(ProtectionLevel = ProtectionLevel.EncryptAndSign)]
  public interface IHiveService {
    #region Task Methods
    [OperationContract]
    Guid AddTask(Task task, TaskData taskData, IEnumerable<Guid> resourceIds);

    [OperationContract]
    Guid AddChildTask(Guid parentTaskId, Task task, TaskData taskData);

    [OperationContract]
    Task GetTask(Guid taskId);

    [OperationContract]
    IEnumerable<Task> GetTasks();

    [OperationContract]
    IEnumerable<LightweightTask> GetLightweightTasks(IEnumerable<Guid> taskIds);

    [OperationContract]
    IEnumerable<LightweightTask> GetLightweightChildTasks(Guid? parentTaskId, bool recursive, bool includeParent);

    [OperationContract]
    IEnumerable<LightweightTask> GetLightweightJobTasks(Guid jobId);

    [OperationContract]
    IEnumerable<LightweightTask> GetLightweightJobTasksWithoutStateLog(Guid jobId);

    [OperationContract]
    TaskData GetTaskData(Guid taskId);

    [OperationContract]
    void UpdateTask(Task taskDto);

    [OperationContract]
    void UpdateTaskData(Task taskDto, TaskData taskDataDto);

    [OperationContract]
    void DeleteTask(Guid taskId);

    [OperationContract]
    void DeleteChildTasks(Guid parentTaskId);

    [OperationContract]
    Task UpdateTaskState(Guid taskId, TaskState taskState, Guid? slaveId, Guid? userId, string exception);
    #endregion

    #region Task Control Methods
    [OperationContract]
    void StopTask(Guid taskId);

    [OperationContract]
    void PauseTask(Guid taskId);

    [OperationContract]
    void RestartTask(Guid taskId);
    #endregion

    #region Job Methods
    [OperationContract]
    Job GetJob(Guid id);

    /// <summary>
    /// Returns all task for the current user
    /// </summary>
    [OperationContract]
    IEnumerable<Job> GetJobs();

    /// <summary>
    /// Returns all task in the hive (only for admins)
    /// </summary>
    /// <returns></returns>
    [OperationContract]
    IEnumerable<Job> GetAllJobs();

    [OperationContract]
    Guid AddJob(Job jobDto);

    [OperationContract]
    void UpdateJob(Job jobDto);

    [OperationContract]
    void DeleteJob(Guid JobId);
    #endregion

    #region JobPermission Methods
    [OperationContract]
    void GrantPermission(Guid jobId, Guid grantedUserId, Permission permission);

    [OperationContract]
    void RevokePermission(Guid hiveExperimentId, Guid grantedUserId);

    [OperationContract]
    IEnumerable<JobPermission> GetJobPermissions(Guid jobId);

    [OperationContract]
    bool IsAllowedPrivileged(); // current user may execute privileged task
    #endregion

    #region Login Methods
    [OperationContract]
    void Hello(Slave slave);

    [OperationContract]
    void GoodBye(Guid slaveId);
    #endregion

    #region Heartbeat Methods
    [OperationContract]
    List<MessageContainer> Heartbeat(Heartbeat heartbeat);
    #endregion

    #region Plugin Methods
    [OperationContract]
    Plugin GetPlugin(Guid pluginId);

    [OperationContract]
    Plugin GetPluginByHash(byte[] hash);

    [OperationContract]
    [FaultContract(typeof(PluginAlreadyExistsFault))]
    Guid AddPlugin(Plugin plugin, List<PluginData> pluginData);

    [OperationContract]
    IEnumerable<Plugin> GetPlugins();

    [OperationContract]
    IEnumerable<PluginData> GetPluginDatas(List<Guid> pluginIds);

    [OperationContract]
    void DeletePlugin(Guid pluginId);
    #endregion

    #region ResourcePermission Methods
    [OperationContract]
    void GrantResourcePermissions(Guid resourceId, Guid[] grantedUserIds);

    [OperationContract]
    void RevokeResourcePermissions(Guid resourceId, Guid[] grantedUserIds);

    [OperationContract]
    IEnumerable<ResourcePermission> GetResourcePermissions(Guid resourceId);
    #endregion

    #region Resource Methods
    [OperationContract]
    IEnumerable<Resource> GetChildResources(Guid resourceId);
    #endregion

    #region Slave Methods
    [OperationContract]
    Guid AddSlave(Slave slave);

    [OperationContract]
    Guid AddSlaveGroup(SlaveGroup slaveGroup);

    [OperationContract]
    Slave GetSlave(Guid slaveId);

    [OperationContract]
    SlaveGroup GetSlaveGroup(Guid slaveGroupId);

    [OperationContract]
    IEnumerable<Slave> GetSlaves();

    [OperationContract]
    IEnumerable<SlaveGroup> GetSlaveGroups();

    [OperationContract]
    void UpdateSlave(Slave slave);

    [OperationContract]
    void UpdateSlaveGroup(SlaveGroup slaveGroup);

    [OperationContract]
    void DeleteSlave(Guid slaveId);

    [OperationContract]
    void DeleteSlaveGroup(Guid slaveGroupId);

    [OperationContract]
    void AddResourceToGroup(Guid slaveGroupId, Guid resourceId);

    [OperationContract]
    void RemoveResourceFromGroup(Guid slaveGroupId, Guid resourceId);

    [OperationContract]
    Guid GetResourceId(string resourceName);

    [OperationContract]
    IEnumerable<Task> GetTasksByResourceId(Guid resourceId);

    [OperationContract]
    void TriggerEventManager(bool force);

    [OperationContract]
    int GetNewHeartbeatInterval(Guid slaveId);
    #endregion

    #region Downtime Methods
    [OperationContract]
    Guid AddDowntime(Downtime downtime);

    [OperationContract]
    void DeleteDowntime(Guid downtimeId);

    [OperationContract]
    void UpdateDowntime(Downtime downtime);

    [OperationContract]
    IEnumerable<Downtime> GetDowntimesForResource(Guid resourceId);
    #endregion

    #region User Methods
    [OperationContract]
    string GetUsernameByUserId(Guid userId);

    [OperationContract]
    Guid GetUserIdByUsername(string username);
    #endregion

    #region UserPriorities Methods
    [OperationContract]
    IEnumerable<UserPriority> GetUserPriorities();
    #endregion

    #region Statistics Methods
    [OperationContract]
    IEnumerable<Statistics> GetStatistics();
    [OperationContract]
    IEnumerable<Statistics> GetStatisticsForTimePeriod(DateTime from, DateTime to);
    #endregion
  }
}