Histórico da Página

Índice

maxLevel	2

01. Apresentação

Este documento técnico tem por objetivo auxiliar os desenvolvedores dos segmentos na criação de classes que "publicam" e/ou "consomem" mensagens no SmartLink através da plataforma TotvsAppsTotvs SmartLink.

02. Responsabilidades

O desenvolvimento e manutenção dos publicadores e consumidores de mensagens são de responsabilidade das equipes de segmentos. Os artefatos genéricos que controlam a fila de execução das mensagens são de responsabilidade da equipe de Framework.

03. Implementando um publicador de mensagens

Para que uma classe seja um publicador de mensagens, deve-se atender aos pré-requisitos listados abaixo:

Pré-requisitos

Criar um projeto (classLibrary .NET) na solution do segmento em questão, com o seguinte padrão de nome: RM.[Segmento].XXX.SmartLink.Service.
1. Exemplo: RM.Glb.SGDP.SmartLink.Service.dll
Adicionar referência para a dll "RM.Lib.SmartLink.dll";

Criar uma classe que receba em seu construtor instâncias para as das seguintes interfaces:

"IRMSSmartLinkPublisherService": objeto interface de serviço responsável em incluir a mensagem na fila do RM.SmartLink.Client.
InformaçõesFoi criada na Lib uma classe de "factory" responsável em fornecer uma instância para interface "IRMSSmartLinkPublisherService"
.
Trata-se da classe "RMSSmartLinkPublisherFactory". Basta chamar seu método público "NewSmartLinkPublisher".
"IRMSLogger": objeto serviço usado para incluir logs relacionados à regra de negócio em questão.
Informações
Esses Todos os logs adicionados nesse serviço serão persistidos gravados automaticamente na tabela "GTotvsLinkLog"

Para publicar uma mensagem na fila do RM.SmartLink.Client, basta chamar o método "AddMessage" da instância de interface "IRMSSmartLinkPublisherService". Os seguinte dados devem ser enviados através de uma classe de parâmetros do tipo "SmartLinkPublisherAddMessageParams":

Propriedade	Descrição
Command	Nome do comando a ser incluído na fila do SmartLink. Ex: SGDPUpdateTenantMetada
CorrelatedId	deve Pode ser ser enviado nessa propriedade um identificador (guid) que correlacionam mensagens de request envio e response;resposta.
Data	Dados da mensagem contendo dados do informações relacionadas ao negócio. Pode ser em qualquer formato (json, xml, etc) desde que o consumidor consiga interpretá-lalo.
RouterMessage	rota Rota de envio da mensagem. Será concatenada ao endpoint do serviço do Totvs SmartLink.Server. ex: /api/v1/link/send/SGDPMaskResponse/SGDP

Diagrama de classes contendo um publicador de mensagem de exemplo:

Image Removed

5. Diagrama de sequência contendo um exemplo do ciclo de vida da inclusão da mensagem "SGDPTenantMetada"

Image Removed

5. Código fonte de exemplo (extraído da classe "GlbSGDPPublisherMessageService" localizada na solution de Globais, projeto "RM.Glb.SGDP.SmartLink.Service"

...

language	c#
firstline	1
linenumbers	true

...

Na versão 12.1.2402, que utiliza api REST para envio de mensagem, o valor do Audience é definido no final do RouterMessage. No caso desse exemplo o Audience é o SGDP.
A partir da versão 12.1.2406 não é necessário passar o RouterMessage como parâmetro pois utiliza o protocolo gRPC para envio de mensagem.

Audience

Código do TOTVS App específico que irá receber a mensagem.

Para versões 12.1.2406 e acima, que já utiliza o gRPC para envio de mensagem, o Audience deve ser passado por esse parâmetro.

Diagrama de classes contendo um publicador de mensagem de exemplo:

Image Added

5. Diagrama de sequência contendo um exemplo do ciclo de vida da inclusão da mensagem "SGDPTenantMetada"

Image Added

6. Código fonte de exemplo (extraído da classe "GlbSGDPPublisherMessageService" localizada na solution de Globais, projeto "RM.Glb.SGDP.SmartLink.Service". Esse exemplo é para versões a partir da 12.1.2406 que já utiliza o protocolo gRPC.

Bloco de código

language	c#
firstline	1
linenumbers	true

using RM.Glb.SGDP.SmartLink.Service.Domain.Domain.Interfaces;
using RM.Lib.Data;
using RM.Lib.LogGlb.SGDP.SmartLink.Service.Domain.Interfaces;
using RM.Lib.SmartLink.Domain.DataModelLog;
using RM.Lib.SmartLink.Domain.Interfaces;
using RM.Lib.SmartLink.Domain.PublisherInterfaces;
using System;
using System.Collections.Generic;
using System.Linq;

namespace RM.Glb.SGDP.SmartLink.Service
{
  /// <summary>
  /// SGDP Publisher Message Service class
  /// </summary>
  public class GlbSGDPPublisherMessageService : IGlbSGDPPublisherMessageService
  {
    private readonly IGlbSGDPResolverService _SGDPResolverServicesgdpResolverService;
    private readonly IRMSSmartLinkPublisherService _SmartLinkPublisherServicesmartLinkPublisherService;
    private readonly IRMSLogger _LogServicelogService;

    private const string ctSGDPMaskResponseEndPointctSGDPAudience = "SGDP"; /api/v1/link/send/SGDPMaskResponse/SGDP";
    private const string ctSGDPDataResponseEndPoint = "/api/v1/link/send/SGDPDataResponse/SGDP";/ <-- SEU CÓDIGO DE AUDIENCE DEVE VIR AQUI. NO CASO DESSE EXEMPLO É SGDP. OBTER O CÓDIGO COM A EQUIPE DE TOTVS APPS.

    private const string ctSGDPUpdateTenantMetadataEndPointctSGDPUpdateTenantMetadata = "/api/v1/link/send/SGDPUpdateTenantMetadata/SGDP";

    private const string ctSGDPUpdateTenantMetadatactSGDPDataCommand = "SGDPUpdateTenantMetadataSGDPDataCommand";
    private const string ctSGDPDataCommandctSGDPResponseDataCommand = "SGDPDataCommandSGDPDataResponse";

    private const string ctSGDPMaskCommand = "SGDPMaskCommand";
    private const string ctSGDPResponseDataCommandctSGDPResponseMaskCommand = "SGDPResponseDataCommandSGDPMaskResponse";

    private const string ctSGDPResponseMaskCommandctSGDPLogsCommand = "SGDPResponseMaskCommandSGDPLogsCommand";
    private const string ctSmartLinkSetupCommandctSGDPResponseLogCommand = "SetupSGDPLogsResponse";

    private const string ctSmartLinkUnSetupCommandctSmartLinkSetupCommand = "UnSetupsetup";


    private const publicstring GlbSGDPPublisherMessageService(IRMSSmartLinkPublisherService smartLinkPublisherService, 
ctSmartLinkUnSetupCommand = "unSetup";

    /// <summary>
 IGlbSGDPResolverService sgdpResolverService, 
 /// Constructor
    IRMSLogger logService)/// </summary>
    {
///      _SmartLinkPublisherService = smartLinkPublisherService;<param name="smartLinkPublisherService"></param>
    /// <param _SGDPResolverService name= sgdpResolverService;"sgdpResolverService"></param>
    /// <param _LogService name= logService;"logService"></param>
    }

    /// <summary>
public GlbSGDPPublisherMessageService(IRMSSmartLinkPublisherService smartLinkPublisherService,
       /// Adiciona uma mensagem de reposta para o comando "SGDPResponseDataCommand".IGlbSGDPResolverService sgdpResolverService,
      IRMSLogger logService)
    /// </summary>
{
     /// <param_smartLinkPublisherService name="parms"></param>= smartLinkPublisherService;
    public  void AddResponseDataCommand(AddResponseDataCommandParms parms)_sgdpResolverService = sgdpResolverService;
    {
  _logService = logService;
  SmartLinkPublisherAddMessageParams parPublisher = new SmartLinkPublisherAddMessageParams(); }

    /// <summary>
    ///  parPublisher.Command = ctSGDPResponseDataCommand;
      parPublisher.CorrelatedId = parms.CorrelatedId; ;Adiciona uma mensagem de reposta para o comando "SGDPResponseDataCommand".
    /// </summary>
    /// <param parPublisher.Data = parms.Message;name="parms"></param>
    public  parPublisher.RouterMessage = ctSGDPDataResponseEndPoint;void AddResponseDataCommand(AddResponseDataCommandParms parms)
    {
  _LogService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPResponseDataCommandGravadoNaFila);
     SmartLinkPublisherAddMessageParams _SmartLinkPublisherService.AddMessage(parPublisher);
 = new SmartLinkPublisherAddMessageParams
 }

    /// <summary>{
    /// Adiciona uma mensagem deCommand reposta= paractSGDPResponseDataCommand,
 o comando "SGDPResponseMaskCommand".
    /// </summary>
    /// <param name="parms"></param>
 CorrelatedId = parms.CorrelatedId,
        public void AddResponseMaskCommand(AddResponseMaskCommandParmsData = parms).Message,
    {
      SmartLinkPublisherAddMessageParams parPublisherAudience = new SmartLinkPublisherAddMessageParams();ctSGDPAudience
      parPublisher.Command = ctSGDPResponseMaskCommand};

      parPublisher.CorrelatedId = parms.CorrelatedId_logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPResponseDataCommandGravadoNaFila);
      parPublisher.Data = parms.Message;
      parPublisher.RouterMessage = ctSGDPMaskResponseEndPoint;
      _LogService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPResponseMaskCommandGravadoNaFila);
      _SmartLinkPublisherService._smartLinkPublisherService.AddMessage(parPublisher);
    }

    /// <summary>
    /// Adiciona uma mensagem parade envioreposta depara umo comando de sgldpdateapplicationmetada"SGDPResponseMaskCommand".
    /// </summary>
    public/// void AddMessageUpdateTenantMetadata(AddMessageUpdateTenantMetadataParms<param name="parms"></param>
    public void AddResponseMaskCommand(AddResponseMaskCommandParms parms)
    {
      if (CanAddTenantMetadataMessage())SmartLinkPublisherAddMessageParams parPublisher = new SmartLinkPublisherAddMessageParams
      {
        Command = tryctSGDPResponseMaskCommand,
        {
CorrelatedId = parms.CorrelatedId,
        List<string>Data jsons = GetUpdateTenandMetadata(parms.TenantId);Message,
        Audience = foreachctSGDPAudience
 (string json in jsons)
  };
        {_logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPResponseMaskCommandGravadoNaFila);
      _smartLinkPublisherService.AddMessage(parPublisher);
    }
  SmartLinkPublisherAddMessageParams smartLinkParms = new SmartLinkPublisherAddMessageParams();
/// <summary>
    /// Adiciona uma mensagem de reposta para o comando smartLinkParms.Command = ctSGDPUpdateTenantMetadata;"SGDPResponseLogCommand".
    /// </summary>
    /// <param  smartLinkParms.CorrelatedId name= "parms";>Parms</param>
    public void AddResponseLogCommand(AddResponseLogCommandParms parms)
    {
      SmartLinkPublisherAddMessageParams smartLinkParms.DataparPublisher = json;new SmartLinkPublisherAddMessageParams
      {
        smartLinkParms.RouterMessageCommand = ctSGDPUpdateTenantMetadataEndPoint;ctSGDPResponseLogCommand,
        CorrelatedId =   _LogService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPTenantMetadaGravadoNaFila);parms.CorrelatedId,
        Data    _SmartLinkPublisherService.AddMessage(smartLinkParms);= parms.Message,
        Audience = }ctSGDPAudience
        };
        catch (Exception ex)
        {_logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPResponseLogCommandGravadoNaFila);
          _LogServicesmartLinkPublisherService.NotifyLogWarning(ex, Properties.Resources.sconTotvsAppErroAoEnviarSGDPUpdateTenantMetadataAddMessage(parPublisher);
        }

    ///  }<summary>
    }

    private bool CanAddTenantMetadataMessage()
    {/// Adiciona uma mensagem para envio de um comando de sgldpdateapplicationmetada.
      ///Se existir</summary>
 alguma mensagem de sgdp/// para ser processada, então não envia atualizaçaõ de medatdos pois esse processo é caro.<param name="parms"></param>
    public void AddMessageUpdateTenantMetadata(AddMessageUpdateTenantMetadataParms parms)
    {
      vartry
    pendingMessages = _SmartLinkPublisherService.GetPendingMessages(); {
      List<SmartLinkMessageDataModel> messageUpstream =if pendingMessages?.Messages?.Where((string.IsNullOrEmpty(parms.TenantId))
        y{
 => y.TypeEvent == ctSGDPUpdateTenantMetadata ||
     _logService.NotifyLogWarning(Properties.Resources.sSGDPTenantMetadataInvalidSGDPUpdateTenantMetadata);
        y.TypeEvent == ctSGDPDataCommand ||return;
        }
     y.TypeEvent == ctSGDPMaskCommand ||
   List<string> jsons = GetUpdateTenandMetadata(parms.TenantId);
        foreach (string json in jsons)
   y.TypeEvent == ctSGDPResponseDataCommand ||
  {
          SmartLinkPublisherAddMessageParams y.TypeEventsmartLinkParms == ctSGDPResponseMaskCommand).ToList(); new SmartLinkPublisherAddMessageParams
      if (messageUpstream?.Count > 0)//Se existir alguma não inclua na fila...
 {
            Command return= false;ctSGDPUpdateTenantMetadata,
      return true;
    }

 CorrelatedId = "",
 private List<string> GetUpdateTenandMetadata(string tenantId)
    {
     Data return _SGDPResolverService.GetSGDPTenantMetadata(= json,
        new  MetadataTenantParms() { TenantIdAudience = tenantIdctSGDPAudience
  }
        )?.JsonsResult};
    }

    public void AddMessageUnSetup()_logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPTenantMetadaGravadoNaFila);
    {
      var pendingMessages = _SmartLinkPublisherService.GetPendingMessages(_smartLinkPublisherService.AddMessage(smartLinkParms);
      List<SmartLinkMessageDataModel> messagesSGDP =}
 
     }
   pendingMessages?.Messages?.Where(y => y.TypeEvent.ToUpper() == ctSGDPUpdateTenantMetadata.ToUpper() && catch (Exception ex)
      {
           _logService.NotifyLogWarning(ex, Properties.Resources.sconTotvsAppErroAoEnviarSGDPUpdateTenantMetadata);
      }
    }
    private List<string> GetUpdateTenandMetadata(string tenantId)
    {
      return  y.TypeEvent.ToUpper() == ctSGDPDataCommand.ToUpper() &&_sgdpResolverService.GetSGDPTenantMetadata(
        new MetadataTenantParms() { TenantId = tenantId }
        )?.JsonsResult;
    }

    /// <summary>
    /// Adiciona mensagem UnSetup
    /// </summary>
    y.TypeEvent.ToUpper() == ctSGDPMaskCommand.ToUpper() &&public void AddMessageUnSetup()
    {
      var pendingMessages = _smartLinkPublisherService.GetPendingMessages();
      var messagesSGDP =
        pendingMessages?.Where(y                 => y.TypeEvent.ToUpper() == ctSGDPResponseDataCommandctSGDPUpdateTenantMetadata.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPResponseMaskCommandctSGDPDataCommand.ToUpper()).ToList(); &&
      foreach (SmartLinkMessageDataModel model in messagesSGDP)
        _SmartLinkPublisherService.RemoveMessageById(model.Id);

      SmartLinkPublisherAddMessageParams parms = new SmartLinkPublisherAddMessageParams();
      parms.Command = ctSmartLinkUnSetupCommand;
      parms.CorrelatedId = "";
      parms.Datay.TypeEvent.ToUpper() == _SGDPResolverServicectSGDPMaskCommand.GetSGDPSetupToUpper().JsonResult;
 &&
       _LogService.NotifyLogInfo(Properties.Resources.sconTotvsAppUnSetupGravadoNaFila);
         _SmartLinkPublisherService.AddMessage(parms);
    }

    public void AddMessageSetup()
    {
      SmartLinkPublisherAddMessageParams parms = new SmartLinkPublisherAddMessageParams();
      parms.Commandy.TypeEvent.ToUpper() = ctSmartLinkSetupCommand;= ctSGDPLogsCommand.ToUpper() &&
      parms.CorrelatedId = "";
      parms.Data = _SGDPResolverService.GetSGDPSetup().JsonResult;
                                _LogService.NotifyLogInfo(Properties.Resources.sconTotvsAppSetupGravadoNaFila);y.TypeEvent.ToUpper() == ctSGDPResponseDataCommand.ToUpper() &&
      _SmartLinkPublisherService.AddMessage(parms);
       }
  }
}

04. Implementando um consumidor de mensagens

Para que uma classe seja um provedor de proteção de dados, , deve-se atender aos pré-requisitos listados abaixo:

Pré-requisitos

Criar um projeto (classLibrary .NET) na solution do segmento em questão, com o seguinte padrão de nome: RM.[Segmento].DataProtection.Provider.
1. Exemplo: RM.RHU.DataProtection.Provider.dll
Adicionar referência para a dll "RM.Glb.DataProtection.Service.dll";
Criar uma classe herdando da ancestral "GlbDataProtectionProviderBase". O tipo genérico "Identifier" deve ser usado conforme descrito abaixo.
A classe "GlbDataProtectionProviderBase" herda da classe RMSObject da Lib. Consequentemente, as classes de "providers" poderão chamar os métodos "CreateFacade" e "CreateModule" dentro de suas estruturas.
Carimbar a classe com o atributo "GlbDataProtectionRoleAttr". Nesse atributo, devem ser informados os dados abaixo:
1. Identificador único do provedor (novo guid);
2. Nome do papel (essa informação será mostrada para o usuário no sistema LGDP que está sendo criado pela Totvs);
3. Linha do Produto (RM,TREPORTS, etc)
4. Aplicação (Folha de Pagament, Educacional, Globais, etc)
5. ClassName (Nome do Menu Controller do segmento) - Pode ser localizado na tabela GDICDATAPROTECTION coluna CLASSNAME.
6. CodSistema (Código Sistema do segmento) -Pode ser localizado na tabela GDICDATAPROTECTION coluna CODSISTEMA.

Exemplo:

Bloco de código

language	c#
firstline	1
linenumbers	true

namespace RM.Glb.TesteUnitario
{
  [GlbDataProtectionRoleAttr("7b886d91-86b1-4953-ad93-7da732d40515", "Funcionários", "RM", "Fop","FopFolhaActionModuleController", "P")]
  public class RHUDataProtectionProviderFuncionarios<FuncID> :
    GlbDataProtectionProviderBase<FuncionarioIDModel>
    where FuncID : FuncionarioIDModel, new()
  {
  }
}

05. Diagrama de classes

Image Removed

06. DER

Image Removed

05. Endpoint de teste para um provedor de proteção de dados

Foi criado o endpoint para teste (http://localhost:8051/api/framework/v1/dataprotection/person) para buscar dados de uma pessoa com base no nome do identificador específico do provedor.

Foi criado o endpoint para teste (http://localhost:8051/api/framework/v1/dataprotection/cananonimize) para recuperar se os dados de uma pessoa com base no nome do identificador específico do provedor podem ser anonimizados.

Está sendo criado o endpoint http://localhost:8051/api/framework/v1/dataprotection/anonimize para anonimizar os dados de uma pessoa (está em construção).

Ambos endpoints devem ser enviados por GET, com a seguinte estrutura no body:

{
  "role": "Funcionários",
  "identifiers": [
      {
          "IdentifiedName": "CPF",
          "Value": "00251149641"
      }
  ]
}

Onde:

roles = nome do provedor dado pela implementação do produto;
IdentifiedName = nome do identificador do provedor de proteção de dados
Value = valor do identificador

Exemplo de resposta para a API dataprotection/person:

Image Removed

São retornados os dados da pessoa, de acordo com o provedor informado.

Exemplo de retorno para a APIdataprotection/cananonimize:

Image Removed

...

                                 y.TypeEvent.ToUpper() == ctSGDPResponseMaskCommand.ToUpper()).ToList();

      if (messagesSGDP != null)
      {
        foreach (SmartLinkMessageEntity model in messagesSGDP)
        {
          _smartLinkPublisherService.RemoveMessageById(model.Id);
        }
      }

      SmartLinkPublisherAddMessageParams parms = new SmartLinkPublisherAddMessageParams
      {
        Command = ctSmartLinkUnSetupCommand,
        CorrelatedId = "",
        Audience = ctSGDPAudience,
        Data = _sgdpResolverService.GetSGDPSetup().JsonResult
      };
      _logService.NotifyLogInfo(Properties.Resources.sconTotvsAppUnSetupGravadoNaFila);
      _smartLinkPublisherService.AddMessage(parms);
    }

    /// <summary>
    /// Adiciona messagem setup
    /// </summary>
    public void AddMessageSetup()
    {
      SmartLinkPublisherAddMessageParams parms = new SmartLinkPublisherAddMessageParams
      {
        Command = ctSmartLinkSetupCommand,
        CorrelatedId = "",
        Audience = ctSGDPAudience,
        Data = _sgdpResolverService.GetSGDPSetup().JsonResult
      };
      _logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSetupGravadoNaFila);
      _smartLinkPublisherService.AddMessage(parms);
    }
  }
}

7. Código fonte de exemplo (extraído da classe "GlbSGDPPublisherMessageService" localizada na solution de Globais, projeto "RM.Glb.SGDP.SmartLink.Service". Esse exemplo é para a versão 12.1.2402 que ainda utiliza api REST para envio de mensagem. Nesse caso o Audience é definido no final do endpoint passado como parâmetro para o RouterMessage.

Bloco de código

language	c#
firstline	1
linenumbers	true

using RM.Glb.SGDP.SmartLink.Service.Domain;
using RM.Glb.SGDP.SmartLink.Service.Domain.Interfaces;
using RM.Lib.Log;
using RM.Lib.SmartLink.Domain;
using RM.Lib.SmartLink.Domain.Interfaces;
using System;
using System.Collections.Generic;
using System.Linq;

namespace RM.Glb.SGDP.SmartLink.Service
{
  public class GlbSGDPPublisherMessageService : IGlbSGDPPublisherMessageService
  {
    private readonly IGlbSGDPResolverService _sgdpResolverService;
    private readonly IRMSSmartLinkPublisherService _smartLinkPublisherService;
    private readonly IRMSLogger _logService;

    private const string ctSGDPUpdateTenantMetadataEndPoint = "/api/v1/link/send/SGDPUpdateTenantMetadata/SGDP";
    private const string ctSGDPDataResponseEndPoint = "/api/v1/link/send/SGDPDataResponse/SGDP";

    private const string ctSGDPUpdateTenantMetadata = "SGDPUpdateTenantMetadata";

    private const string ctSGDPDataCommand = "SGDPDataCommand";
    private const string ctSGDPResponseDataCommand = "SGDPDataResponse";

    private const string ctSGDPMaskResponseEndPoint = "/api/v1/link/send/SGDPMaskResponse/SGDP";
    private const string ctSGDPMaskCommand = "SGDPMaskCommand";
    private const string ctSGDPResponseMaskCommand = "SGDPMaskResponse";

    private const string ctSGDPLogResponseEndPoint = "/api/v1/link/send/SGDPLogsResponse/SGDP";
    private const string ctSGDPLogsCommand = "SGDPLogsCommand";
    private const string ctSGDPResponseLogCommand = "SGDPLogsResponse";

    private const string ctSmartLinkSetupCommand = "setup";
    private const string ctSmartLinkUnSetupCommand = "unSetup";


    public GlbSGDPPublisherMessageService(IRMSSmartLinkPublisherService smartLinkPublisherService,
      IGlbSGDPResolverService sgdpResolverService,
      IRMSLogger logService)
    {
      _smartLinkPublisherService = smartLinkPublisherService;
      _sgdpResolverService = sgdpResolverService;
      _logService = logService;
    }

    /// <summary>
    /// Adiciona uma mensagem de reposta para o comando "SGDPResponseDataCommand".
    /// </summary>
    /// <param name="parms"></param>
    public void AddResponseDataCommand(AddResponseDataCommandParms parms)
    {
      SmartLinkPublisherAddMessageParams parPublisher = new SmartLinkPublisherAddMessageParams
      {
        Command = ctSGDPResponseDataCommand,
        CorrelatedId = parms.CorrelatedId,
        Data = parms.Message,
        RouterMessage = ctSGDPDataResponseEndPoint
      };

      _logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPResponseDataCommandGravadoNaFila);
      _smartLinkPublisherService.AddMessage(parPublisher);
    }

    /// <summary>
    /// Adiciona uma mensagem de reposta para o comando "SGDPResponseMaskCommand".
    /// </summary>
    /// <param name="parms"></param>
    public void AddResponseMaskCommand(AddResponseMaskCommandParms parms)
    {
      SmartLinkPublisherAddMessageParams parPublisher = new SmartLinkPublisherAddMessageParams
      {
        Command = ctSGDPResponseMaskCommand,
        CorrelatedId = parms.CorrelatedId,
        Data = parms.Message,
        RouterMessage = ctSGDPMaskResponseEndPoint
      };
      _logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPResponseMaskCommandGravadoNaFila);
      _smartLinkPublisherService.AddMessage(parPublisher);
    }
    /// <summary>
    /// Adiciona uma mensagem de reposta para o comando "SGDPResponseLogCommand".
    /// </summary>
    /// <param name="parms">Parms</param>
    public void AddResponseLogCommand(AddResponseLogCommandParms parms)
    {
      SmartLinkPublisherAddMessageParams parPublisher = new SmartLinkPublisherAddMessageParams
      {
        Command = ctSGDPResponseLogCommand,
        CorrelatedId = parms.CorrelatedId,
        Data = parms.Message,
        RouterMessage = ctSGDPLogResponseEndPoint
      };
      _logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPResponseLogCommandGravadoNaFila);
      _smartLinkPublisherService.AddMessage(parPublisher);
    }

    /// <summary>
    /// Adiciona uma mensagem para envio de um comando de sgldpdateapplicationmetada.
    /// </summary>
    public void AddMessageUpdateTenantMetadata(AddMessageUpdateTenantMetadataParms parms)
    {
      try
      {
        if(string.IsNullOrEmpty(parms.TenantId))
        {
          _logService.NotifyLogWarning(Properties.Resources.sSGDPTenantMetadataInvalidSGDPUpdateTenantMetadata);
          return;
        }
        List<string> jsons = GetUpdateTenandMetadata(parms.TenantId);
        foreach (string json in jsons)
        {
          SmartLinkPublisherAddMessageParams smartLinkParms = new SmartLinkPublisherAddMessageParams
          {
            Command = ctSGDPUpdateTenantMetadata,
            CorrelatedId = "",
            Data = json,
            RouterMessage = ctSGDPUpdateTenantMetadataEndPoint
          };
          _logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPTenantMetadaGravadoNaFila);
          _smartLinkPublisherService.AddMessage(smartLinkParms);
        }
      }
      catch (Exception ex)
      {
        _logService.NotifyLogWarning(ex, Properties.Resources.sconTotvsAppErroAoEnviarSGDPUpdateTenantMetadata);
      }
    }
    private List<string> GetUpdateTenandMetadata(string tenantId)
    {
      return _sgdpResolverService.GetSGDPTenantMetadata(
        new MetadataTenantParms() { TenantId = tenantId }
        )?.JsonsResult;
    }

    public void AddMessageUnSetup()
    {
      var pendingMessages = _smartLinkPublisherService.GetPendingMessages();
      var messagesSGDP =
        pendingMessages?.Where(y => y.TypeEvent.ToUpper() == ctSGDPUpdateTenantMetadata.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPDataCommand.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPMaskCommand.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPLogsCommand.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPResponseDataCommand.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPResponseMaskCommand.ToUpper()).ToList();

      if (messagesSGDP != null)
      {
        foreach (SmartLinkMessageEntity model in messagesSGDP)
        {
          _smartLinkPublisherService.RemoveMessageById(model.Id);
        }
      }

      SmartLinkPublisherAddMessageParams parms = new SmartLinkPublisherAddMessageParams
      {
        Command = ctSmartLinkUnSetupCommand,
        CorrelatedId = "",
        Data = _sgdpResolverService.GetSGDPSetup().JsonResult
      };
      _logService.NotifyLogInfo(Properties.Resources.sconTotvsAppUnSetupGravadoNaFila);
      _smartLinkPublisherService.AddMessage(parms);
    }

    public void AddMessageSetup()
    {
      SmartLinkPublisherAddMessageParams parms = new SmartLinkPublisherAddMessageParams
      {
        Command = ctSmartLinkSetupCommand,
        CorrelatedId = "",
        Data = _sgdpResolverService.GetSGDPSetup().JsonResult
      };
      _logService.NotifyLogInfo(Properties.Resources.sconTotvsAppSetupGravadoNaFila);
      _smartLinkPublisherService.AddMessage(parms);
    }
  }
}

04. Implementando um consumidor de mensagens

Para que uma classe seja um consumidor de mensagens no SmartLink, deve-se atender aos pré-requisitos listados abaixo:

Pré-requisitos

Criar um projeto (classLibrary .NET) na solution do segmento em questão, com o seguinte padrão de nome: RM.[Segmento].XXX.SmartLink.Service.
1. Exemplo: RM.Glb.SGDP.SmartLink.Service.dll
Adicionar referência para a dll "RM.Lib.SmartLink.dll";
Criar uma classe herdando da ancestral "RMSSmartLinkConsumerMessageBase".
A classe "RMSSmartLinkConsumerMessageBase" herda da classe RMSObject da Lib. Consequentemente, as classes de "consumers" poderão chamar os métodos "CreateFacade" e "CreateModule" dentro de suas estruturas.
Carimbar a classe com o atributo "RMSSmartLinkConsumerMessageAttr". Nesse atributo, devem ser informados os dados abaixo:
Propriedade Descrição
Cod.Sistema Identificador da aplicação
Comando Nome do Comando da mensagem
Para realização de tratamento de exceções no caso de ocorrer erro no processamento da mensagem
Quando for considerado um erro e um nova tentativa de processamento deve ser realizada:
A classe RMSSmartLinkConsumerMessageException ou outra, pode ser utilizada.
Neste caso a mensagem será reenfileirada e novas tentativas de processamento serão realizadas.

Sendo considerado que a mensagem deve ser descartada, ou seja, esta mensagem não deve ser processada neste momento ou apenas sob intervenção manual:
A classe RMSSmartLinkConsumerFatalException, deverá ser utilizada e informado o motivo.
Neste caso a mensagem será colocada em um fila de espera (DLQ) e somente será reprocessada por uma intervenção manual ou será descartada.

Código fonte de exemplo (extraído da classe "GlbSGDPConsumerDataCommandMessage" localizada na solution de Globais, projeto "RM.Glb.SGDP.SmartLink.Service":

Bloco de código

language	c#
firstline	1
linenumbers	true

using RM.Glb.SGDP.SmartLink.Service.Domain.Interfaces;
using RM.Lib;
using RM.Lib.SmartLink.Domain;
using RM.Lib.SmartLink.Domain.Consumer;
using RM.Lib.SmartLink.Domain.Interfaces;
using RM.Lib.SmartLink.Domain.Publisher;
using System;
using System.Runtime.Serialization;

namespace RM.Glb.SGDP.SmartLink.Service.Domain
{
  /// <summary>
  /// Regras de implementação do mecanismo de processamento da mensagem SGDDataCommand do SGDP
  /// </summary>
  [RMSSmartLinkConsumerMessageAttr(CodSistema.Glb, "SGDPDataCommand")]
  public class GlbSGDPConsumerDataCommandMessage : RMSSmartLinkConsumerMessageBase
  {
    protected override ConsumerMessageExecuteResult DoExecute(string message)
    {
      logService.NotifyLogInfo(Properties.Resources.sconTotvsAppInicioExecucaoDoConsumerSGDPDataCommandConsumer);
      ConsumerMessageExecuteResult result = new ConsumerMessageExecuteResult();
      IGlbSGDPResolverService resolver = GlbSGDPResolveFactory.NewSGDPResolve(this.DBS, this.logService);
      IGlbSGDPPublisherMessageService publisher = new GlbSGDPPublisherMessageService(this.SmartLinkPublisherService, resolver, logService);

      ExecuteDataCommandParms par = new ExecuteDataCommandParms();
      par.Message = message;
      try
      {
        var execDataResult = resolver.ExecuteSGDPDataCommand(par);
        logService.NotifyLogInfo(Properties.Resources.sconTotvsAppJSonSGDPDataResponseCommandForamGerados, 
          Properties.Resources.sconTotvsAppQuantidadeDeJSonsGerados, execDataResult?.JsonResults?.Count);
        result.CorrelatedID = execDataResult.RequestId;
        if (execDataResult?.JsonResults != null)
        {
          foreach (var jsonResult in execDataResult.JsonResults)
          {
            AddResponseDataCommandParms parResponse = new AddResponseDataCommandParms();
            parResponse.Message = jsonResult;
            parResponse.CorrelatedId = execDataResult.RequestId;
            publisher.AddResponseDataCommand(parResponse);
          }
        }
      }
      catch(Exception ex)
      {
        logService.NotifyLogError(new GlbSGDPConsumerDataCommandMessageException(
          Properties.Resources.sconTotvsAppErroAoProcessarSGDDataCommand, ex));
      }
      logService.NotifyLogInfo(Properties.Resources.sconTotvsAppFimExecucaoDoConsumerSGDPDataCommandConsumer);
      return result;
    }
  }

  [Serializable]
  public class GlbSGDPConsumerDataCommandMessageException : RMSApplicationException
  {
    public GlbSGDPConsumerDataCommandMessageException() : base()
    {
    }

    public GlbSGDPConsumerDataCommandMessageException(string message) : base(message)
    {
    }

    public GlbSGDPConsumerDataCommandMessageException(string message, Exception ex) : base(message, ex, string.Empty)
    {
    }

    public GlbSGDPConsumerDataCommandMessageException(SerializationInfo info, StreamingContext context)
  : base(info, context)
    {
    }
  }
}

05. Diagrama de classes

Image Added

06. DER

Image Added

Tabela

GTOTVSLINKMESSAGE

Tabela utilizada para armazenar todos as mensagens geradas e enviadas para execução pelo SmartLink.

Sempre que uma mensagem é executa com sucesso, a linha referente a mensagem é excluída

dessa tabela , deixando essa tabela sempre leve. Esse procedimento melhora a performance do processo,

visto que vários "updates" são realizados nessa tabela.Quando menor o volume de uma tabela, mais rápido

será a operação do update.

GTOTVSLINKMESSAGEEXEC

Tabela contendo todos os dados de execução de uma determinada mensagem.

GTOTVSLINKLOG

Tabela contendo todos os logs de execução de uma mensagem.

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 21

Nova versão Atual

Chave

01. Apresentação

02. Responsabilidades

03. Implementando um publicador de mensagens

Pré-requisitos

04. Implementando um consumidor de mensagens

Pré-requisitos

05. Diagrama de classes

06. DER

05. Endpoint de teste para um provedor de proteção de dados

04. Implementando um consumidor de mensagens

Pré-requisitos

05. Diagrama de classes

06. DER

Propriedade	Descrição
Cod.Sistema	Identificador da aplicação
Comando	Nome do Comando da mensagem