WFS-468 Callback API Sample

WorkflowServer.CallbackApi/Controllers/ApiController.cs

@@ -1,15 +1,165 @@
+using System.Text;
+using System.Xml;
 using Microsoft.AspNetCore.Mvc;
+using WorkflowServer.CallbackApi.Models;
+using WorkflowServer.CallbackApi.Workflow;
 
 namespace WorkflowServer.CallbackApi.Controllers;
 
+/// <summary>
+/// This controller implements all possible requests from Callback API of WFS 3.0.0.
+/// Callback API allows hosting your code of Actions, Conditions or Rules on third-party servers.
+/// Callback server should be connected in the admin panel on the Callback API page.
+/// More details on the  <see href="https://workflowserver.io/documentation/callback-api">workflowserver.io</see>
+/// </summary>
 [ApiController]
 [Route("[controller]/[action]")]
 public class ApiController : ControllerBase
 {
     public ApiController(ILogger<ApiController> logger)
     {
         _logger = logger;
+
+        _actionProvider = new ActionProvider();
+        _conditionProvider = new ConditionProvider();
+        _identityProvider = new IdentityProvider();
+        _parameterProvider = new ParameterProvider();
+    }
+
+    #region Actions & Conditions Execution
+
+    [HttpGet]
+    public Task<IActionResult> GetActions(string schemeCode, string token)
+    {
+        return Task.FromResult<IActionResult>(Ok(ApiResponse.Ok(_actionProvider.ActionNames)));
+    }
+
+    [HttpPost]
+    public async Task<IActionResult> ExecuteAction(InstanceRequest request)
+    {
+        await _actionProvider.ExecuteAction(request.Name, request.Parameter, request.ProcessInstance);
+
+        return Ok();
+    }
+
+    [HttpGet]
+    public Task<IActionResult> GetConditions(string schemeCode, string token)
+    {
+        return Task.FromResult<IActionResult>(Ok(ApiResponse.Ok(_conditionProvider.ConditionNames)));
+    }
+
+    [HttpPost]
+    public async Task<IActionResult> ExecuteCondition(InstanceRequest request)
+    {
+        var result = await _conditionProvider.ExecuteCondition(request.Name, request.Parameter, request.ProcessInstance);
+
+        return Ok(ApiResponse.Ok(result));
+    }
+
+    private readonly ActionProvider _actionProvider;
+    private readonly ConditionProvider _conditionProvider;
+
+    #endregion
+
+    #region Authorization Rules Execution
+
+    [HttpGet]
+    public Task<IActionResult> GetRules(string schemeCode, string token)
+    {
+        return Task.FromResult<IActionResult>(Ok(_identityProvider.RuleNames));
+    }
+
+    [HttpPost]
+    public async Task<IActionResult> CheckRule(CheckRuleRequest request)
+    {
+        var result = await _identityProvider.RuleCheck(request.Name, request.IdentityId, request.Parameter, request.ProcessInstance);
+        return Ok(ApiResponse.Ok(result));
+    }
+
+    [HttpPost]
+    public async Task<IActionResult> GetIdentities(InstanceRequest request)
+    {
+        var result = await _identityProvider.RuleGet(request.Name, request.Parameter, request.ProcessInstance);
+        return Ok(ApiResponse.Ok(result));
     }
 
+    private readonly IdentityProvider _identityProvider;
+
+    #endregion
+
+    #region Remote Scheme Generation
+
+    [HttpPost]
+    public Task<IActionResult> Generate(GenerateRequest request)
+    {
+        XmlDocument xml = new XmlDocument();
+
+        //Your code
+
+        return Task.FromResult<IActionResult>(Ok(xml.OuterXml));
+    }
+
+    #endregion
+
+    #region Event Handlers
+
+    [HttpPost]
+    public Task<IActionResult> ProcessStatusChanged(StatusChangedRequest request)
+    {
+        _logger.LogInformation("Process status changed from {OldStatus} to {NewStatus}", 
+            request.OldStatus, request.NewStatus);
+
+        //Your event actions
+
+        return Task.FromResult<IActionResult>(Ok(ApiResponse.Ok()));
+    }
+
+    [HttpPost]
+    public Task<IActionResult> ProcessActivityChanged(ActivityChangedRequest request)
+    {
+        _logger.LogInformation("Process activity changed from {PreviousActivityName} to {CurrentActivityName}", 
+            request.PreviousActivityName, request.CurrentActivityName);
+
+        //Your event actions
+
+        return Task.FromResult<IActionResult>(Ok(ApiResponse.Ok()));
+    }
+
+    [HttpPost]
+    public Task<IActionResult> ProcessLog(LogRequest request)
+    {
+        //Your event actions
+
+        return Task.FromResult<IActionResult>(Ok(ApiResponse.Ok()));
+    }
+
+    #endregion
+
+    #region Parameters Providing 
+
+    [HttpGet]
+    public Task<IActionResult> GetParameterNames(string schemeCode, string token)
+    {
+        return Task.FromResult<IActionResult>(Ok(ApiResponse.Ok(_parameterProvider.GetNames)));
+    }
+
+    [HttpPost]
+    public Task<IActionResult> GetParameter(ParameterRequest request)
+    {
+        var result = _parameterProvider.GetParameter(request.Name);
+        return Task.FromResult<IActionResult>(Ok(ApiResponse.Ok(result)));
+    }
+
+    [HttpPost]
+    public Task<IActionResult> SetParameter(ParameterRequest request)
+    {
+        _parameterProvider.SetParameter(request.Name, request.Value);
+        return Task.FromResult<IActionResult>(Ok(ApiResponse.Ok()));
+    }
+
+    private readonly ParameterProvider _parameterProvider;
+
+    #endregion
+
     private readonly ILogger<ApiController> _logger;
 }

WorkflowServer.CallbackApi/Models/ActivityChangedRequest.cs

@@ -0,0 +1,15 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class ActivityChangedRequest : ProcessRequest
+{
+    public ActivityChangedRequest(Guid processId, string schemeCode, ProcessInstance processInstance, string previousActivityName, 
+        string currentActivityName, string token) 
+        : base(processId, schemeCode, processInstance, token)
+    {
+        PreviousActivityName = previousActivityName;
+        CurrentActivityName = currentActivityName;
+    }
+
+    public string PreviousActivityName { get; }
+    public string CurrentActivityName { get; }
+}

WorkflowServer.CallbackApi/Models/ApiResponse.cs

@@ -0,0 +1,19 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class ApiResponse
+{
+    public static ApiResponse Ok(object? data = null) => new ApiResponse(true, data);
+    public static ApiResponse Failure(string? error = null, string? message = null) => new ApiResponse(false, null, error, message);
+
+    public ApiResponse(bool success, object? data = null, string? error = null, string? message = null)
+    {
+        Success = success;
+        Data = data;
+        Error = error;
+    }
+
+    public string? Error { get; set; }
+    public string? Message { get; set; }
+    public bool Success { get; set; }
+    public object? Data { get; set; }
+}

WorkflowServer.CallbackApi/Models/CheckRuleRequest.cs

@@ -0,0 +1,12 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class CheckRuleRequest : InstanceRequest
+{
+    public CheckRuleRequest(string name, string parameter, string token, ProcessInstance processInstance, string identityId) : 
+        base(name, parameter, token, processInstance)
+    {
+        IdentityId = identityId;
+    }
+
+    public string IdentityId { get; }
+}

WorkflowServer.CallbackApi/Models/GenerateRequest.cs

@@ -0,0 +1,19 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class GenerateRequest
+{
+    public GenerateRequest(string schemeCode, Guid schemeId, object parameters, string scheme, string token)
+    {
+        SchemeCode = schemeCode;
+        SchemeId = schemeId;
+        Parameters = parameters;
+        Scheme = scheme;
+        Token = token;
+    }
+
+    public string SchemeCode { get; }
+    public Guid SchemeId { get; }
+    public object Parameters { get; }
+    public string Scheme { get; }
+    public string Token { get; }
+}

WorkflowServer.CallbackApi/Models/InstanceRequest.cs

@@ -0,0 +1,17 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class InstanceRequest
+{
+    public InstanceRequest(string name, string parameter, string token, ProcessInstance processInstance)
+    {
+        Name = name;
+        Parameter = parameter;
+        Token = token;
+        ProcessInstance = processInstance;
+    }
+
+    public string Name { get; }
+    public string Parameter { get; }
+    public ProcessInstance ProcessInstance { get; }
+    public string Token { get; }
+}

WorkflowServer.CallbackApi/Models/LogRequest.cs

@@ -0,0 +1,13 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class LogRequest
+{
+    public LogRequest(List<object> processLogs, string token)
+    {
+        ProcessLogs = processLogs;
+        Token = token;
+    }
+
+    public List<object> ProcessLogs { get; }
+    public string Token { get; }
+}

WorkflowServer.CallbackApi/Models/ParameterRequest.cs

@@ -0,0 +1,15 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class ParameterRequest : ProcessRequest
+{
+    public ParameterRequest(Guid processId, string schemeCode, ProcessInstance processInstance, string token, string name, 
+        object? value = null) 
+        : base(processId, schemeCode, processInstance, token)
+    {
+        Name = name;
+        Value = value;
+    }
+
+    public string Name { get; }
+    public object? Value { get; }
+}

WorkflowServer.CallbackApi/Models/ProcessInstance.cs

@@ -0,0 +1,27 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class ProcessInstance
+{
+    public Guid Id  { get; set; }
+    public string? StateName { get; set; }
+    public string? ActivityName { get; set; }
+    public Guid? SchemeId { get; set; }
+    public string? SchemeCode { get; set; }
+    public string? PreviousState { get; set; }
+    public string? PreviousStateForDirect { get; set; }
+    public string? PreviousStateForReverse { get; set; }
+    public string? PreviousActivity { get; set; }
+    public string? PreviousActivityForDirect { get; set; }
+    public string? PreviousActivityForReverse { get; set; }
+    public Guid? ParentProcessId { get; set; }
+    public Guid? RootProcessId { get; set; }
+    public bool IsDeterminingParametersChanged { get; set; }
+    public byte InstanceStatus { get; set; }
+    public bool IsSubProcess { get; set; }
+    public string? TenantId { get; set; }
+
+    public List<TransitionItem>? Transitions { get; set; }
+    public List<WorkflowServerProcessHistoryItem>? History { get; set; }
+    public Dictionary<string, object>? ProcessParameters { get; set; }
+    public List<Guid>? SubProcessIds { get; set; }
+}

WorkflowServer.CallbackApi/Models/ProcessRequest.cs

@@ -0,0 +1,17 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class ProcessRequest
+{
+    public ProcessRequest(Guid processId, string schemeCode, ProcessInstance processInstance, string token)
+    {
+        ProcessId = processId;
+        SchemeCode = schemeCode;
+        ProcessInstance = processInstance;
+        Token = token;
+    }
+
+    public Guid ProcessId { get; }
+    public string SchemeCode { get; }
+    public ProcessInstance ProcessInstance { get; }
+    public string Token { get; }
+}

WorkflowServer.CallbackApi/Models/StatusChangedRequest.cs

@@ -0,0 +1,15 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class StatusChangedRequest : ProcessRequest
+{
+    public StatusChangedRequest(Guid processId, string schemeCode, ProcessInstance processInstance, string oldStatus, string newStatus, 
+        string token) 
+        : base(processId, schemeCode, processInstance, token)
+    {
+        OldStatus = oldStatus;
+        NewStatus = newStatus;
+    }
+
+    public string OldStatus { get; }
+    public string NewStatus { get; }
+}

WorkflowServer.CallbackApi/Models/TransitionItem.cs

@@ -0,0 +1,16 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class TransitionItem
+{
+    public Guid ProcessId { get; set; }
+    public string? ActorIdentityId{ get; set; }
+    public string? ExecutorIdentityId { get; set; }
+    public string? FromActivityName { get; set; }
+    public string? FromStateName { get; set; }
+    public bool IsFinalised { get; set; }
+    public string? ToActivityName{ get; set; }
+    public string? ToStateName { get; set; }
+    public string? TransitionClassifier { get; set; }
+    public DateTime TransitionTime { get; set; }
+    public string? TriggerName { get; set; }
+}

WorkflowServer.CallbackApi/Models/WorkflowServerProcessHistoryItem.cs

@@ -0,0 +1,14 @@
+namespace WorkflowServer.CallbackApi.Models;
+
+public class WorkflowServerProcessHistoryItem
+{
+    public Guid Id { get; set; }
+    public Guid ProcessId { get; set; }
+    public string? IdentityId { get; set; }
+    public string? AllowedToEmployeeNames { get; set; }
+    public DateTime? TransitionTime { get; set; }
+    public long Order { get; set; }
+    public string? InitialState { get; set; }
+    public string? DestinationState { get; set; }
+    public string? Command { get; set; }
+}