Histórico da Página

...

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 seguintes interfaces:

"IRMSSmartLinkPublisherService": objeto responsável em incluir a mensagem na fila do RM.SmartLink.Client.

Informações
Foi 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 usado para incluir logs relacionados à regra de negócio em questão.
Informações
Esses logs serão persistidos 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 ser enviado nessa propriedade um identificador (guid) que correlacionam mensagens de request e response;
Data	mensagem contendo dados do negócio. Pode ser em qualquer formato (json, xml, etc) desde que o consumidor consiga interpretá-la.
RouterMessage	rota de envio da mensagem. Será concatenada ao endpoint do serviço do SmartLink.Server. ex: /api/v1/link/send/SGDPMaskResponse/SGDP

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

Bloco de código

language	c#
firstline	1
linenumbers	true

using Newtonsoft.Json.Linq;
using RM.Glb.SGDP.SmartLink.Service.Domain.Interfaces;
using RM.Lib.Data;
using RM.Lib.Log;
using RM.Lib.SmartLink.Domain.DataModel;
using RM.Lib.SmartLink.Domain.Interfaces;
using RM.Lib.SmartLink.Domain.Publisher;
using System;
using System.Collections.Generic;
using System.Linq;

namespace RM.Glb.SGDP.SmartLink.Service
{
  public class GlbSGDPPublisherMessageService : IGlbSGDPPublisherMessageService
  {
    private IGlbSGDPResolverService _SGDPResolverService;
    private IRMSSmartLinkPublisherService _SmartLinkPublisherService;
    private IRMSLogger _LogService;

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

    private const string ctSGDPUpdateTenantMetadata = "SGDPUpdateTenantMetadata";
    private const string ctSGDPDataCommand = "SGDPDataCommand";
    private const string ctSGDPMaskCommand = "SGDPMaskCommand";
    private const string ctSGDPResponseDataCommand = "SGDPResponseDataCommand";
    private const string ctSGDPResponseMaskCommand = "SGDPResponseMaskCommand";
    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();
      parPublisher.Command = ctSGDPResponseDataCommand;
      parPublisher.CorrelatedId = parms.CorrelatedId; ;
      parPublisher.Data = parms.Message;
      parPublisher.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();
      parPublisher.Command = ctSGDPResponseMaskCommand;
      parPublisher.CorrelatedId = parms.CorrelatedId;
      parPublisher.Data = parms.Message;
      parPublisher.RouterMessage = ctSGDPMaskResponseEndPoint;
      _LogService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPResponseMaskCommandGravadoNaFila);
      _SmartLinkPublisherService.AddMessage(parPublisher);
    }

    /// <summary>
    /// Adiciona uma mensagem para envio de um comando de sgldpdateapplicationmetada.
    /// </summary>
    public void AddMessageUpdateTenantMetadata(AddMessageUpdateTenantMetadataParms parms)
    {
      if (CanAddTenantMetadataMessage())
      {
        try
        {
          List<string> jsons = GetUpdateTenandMetadata(parms.TenantId);
          foreach (string json in jsons)
          {
            SmartLinkPublisherAddMessageParams smartLinkParms = new SmartLinkPublisherAddMessageParams();
            smartLinkParms.Command = ctSGDPUpdateTenantMetadata;
            smartLinkParms.CorrelatedId = "";
            smartLinkParms.Data = json;
            smartLinkParms.RouterMessage = ctSGDPUpdateTenantMetadataEndPoint;
            _LogService.NotifyLogInfo(Properties.Resources.sconTotvsAppSGDPTenantMetadaGravadoNaFila);
            _SmartLinkPublisherService.AddMessage(smartLinkParms);
          }
        }
        catch (Exception ex)
        {
          _LogService.NotifyLogWarning(ex, Properties.Resources.sconTotvsAppErroAoEnviarSGDPUpdateTenantMetadata);
        }
      }
    }

    private bool CanAddTenantMetadataMessage()
    {
      //Se existir alguma mensagem de sgdp para ser processada, então não envia atualizaçaõ de medatdos pois esse processo é caro.
      var pendingMessages = _SmartLinkPublisherService.GetPendingMessages();
      List<SmartLinkMessageDataModel> messageUpstream = pendingMessages?.Messages?.Where(
        y => y.TypeEvent == ctSGDPUpdateTenantMetadata ||
             y.TypeEvent == ctSGDPDataCommand ||
             y.TypeEvent == ctSGDPMaskCommand ||
             y.TypeEvent == ctSGDPResponseDataCommand ||
             y.TypeEvent == ctSGDPResponseMaskCommand).ToList();
      if (messageUpstream?.Count > 0)//Se existir alguma não inclua na fila...
        return false;
      return true;
    }

    private List<string> GetUpdateTenandMetadata(string tenantId)
    {
      return _SGDPResolverService.GetSGDPTenantMetadata(
        new MetadataTenantParms() { TenantId = tenantId }
        )?.JsonsResult;
    }

    public void AddMessageUnSetup()
    {
      var pendingMessages = _SmartLinkPublisherService.GetPendingMessages();
      List<SmartLinkMessageDataModel> messagesSGDP = 
        pendingMessages?.Messages?.Where(y => y.TypeEvent.ToUpper() == ctSGDPUpdateTenantMetadata.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPDataCommand.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPMaskCommand.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPResponseDataCommand.ToUpper() &&
                                              y.TypeEvent.ToUpper() == ctSGDPResponseMaskCommand.ToUpper()).ToList();
      foreach (SmartLinkMessageDataModel model in messagesSGDP)
        _SmartLinkPublisherService.RemoveMessageById(model.Id);

      SmartLinkPublisherAddMessageParams parms = new SmartLinkPublisherAddMessageParams();
      parms.Command = ctSmartLinkUnSetupCommand;
      parms.CorrelatedId = "";
      parms.Data = _SGDPResolverService.GetSGDPSetup().JsonResult;
      _LogService.NotifyLogInfo(Properties.Resources.sconTotvsAppUnSetupGravadoNaFila);
      _SmartLinkPublisherService.AddMessage(parms);
    }

    public void AddMessageSetup()
    {
      SmartLinkPublisherAddMessageParams parms = new SmartLinkPublisherAddMessageParams();
      parms.Command = ctSmartLinkSetupCommand;
      parms.CorrelatedId = "";
      parms.Data = _SGDPResolverService.GetSGDPSetup().JsonResult;
      _LogService.NotifyLogInfo(Properties.Resources.sconTotvsAppSetupGravadoNaFila);
      _SmartLinkPublisherService.AddMessage(parms);
    }
  }
}

Criar uma classe herdando de "IdentifierModelBase". Trata-se de uma estrutura contendo propriedades de pesquisa de um determinada pessoa. Esse objeto será usado para localizar uma pessoa na base de dados. As propriedades dessa classe devem ser marcadas com o atributo "GlbDataProtectionIdentificationAttr". Nesse atributo, devem ser informados os seguintes campos:
1. IdentificationName: Nome do campo físico a ser pesquisado;
2. TableName: Nome da tabela física no DB referente ao campo;
3. Description: Descrição do identificador que aparecerá no SGDP;(Consultar na planilha https://docs.google.com/spreadsheets/d/1uPcsaDQlYOE-x1vAsTAtgpEeLTphI31yXq3Z84QZQ80/edit#gid=0 os tipos que devem ser informados)
4. RelationTag: Marcação de relacionamento entre os campos. Exemplo: Se a pesquisa for feita pelo campo "CodColigada" + "Chapa" do funcionário, nesse caso, essas duas propriedades devem ser marcadas com a mesma tag.

Exemplo:

Bloco de código

language	c#
firstline	1
linenumbers	true

namespace RM.Glb.TesteUnitario
{
  public class FuncionarioIDModel: IdentifierModelBase
  { 
    [GlbDataProtectionIdentifierAttr("CPF", "PPESSOA", "CPF")]
    public string CPF { get; set; }
   
    [GlbDataProtectionIdentifierAttr("CARTIDENTIDADE", "PPESSOA", "RG")]
    public string Rg { get; set; }
   
    [GlbDataProtectionIdentifierAttr("EMAIL", "PPESSOA", "E-MAIL")]
    public string Email { get; set; }

    [GlbDataProtectionIdentifierAttr("CARTMOTORISTA", "PPESSOA", "CNH")]
    public string CNH { get; set; }
  }
}

Métodos que podem ser sobrescritos no provedor:

DoInitialize: método executado logo após a criação do objeto pelo gerenciador. Ele pode ser usado para inicializar dados de instancia da classe de provedor;
DoCanAnonimize: método usado para verificar se uma determinada pessoa pode ou não ser anonimizada.
DoAfterAnonimize: método usado para executar regras de negócio que serão executadas imediatamente após a execução de todos os "updates" de anonimização realizados pela frame.
DoFillIdentifier: método usado para para preenchimento de todas as propriedades do objeto "Identifier" repassado como parâmetro. Esse mecanismo será usado no processo de correlação entre os provedores. Nesse caso, todas as propriedades da classe de "IdentifierModel" do respectivo provider devem ser preenchidas.
DoConfigAnonimize: método usado para repassar as configurações de tabelas necessárias para a camada de "manager". Através desse metado, a camada core tera condições de gerar automaticamente os updates a serem disparados pelo processo de anonimização. Os campos anonimizados serão
justamente os campos marcados na tabela GDicDataProtection por tabela.

Informações

Explicando melhor o método "DoFillIdentifier" que deve ser implementado pelos provedores.

***********************************************************************************************************

Esse método deve ser utilizado para preenchimento das propriedades do objeto de Identifier.

Esse método receberá como parametro uma instancia de um objeto do tipo "IdentifierModelBase"

Se por exemplo, digamos que essa classe tenha as propriedades: [CPF, E-MAIL, RG].

Se chegar uma instancia dessa classe com a propridade "CPF" preenchida: ex: CPF = "0154518548".

Nesse caso, terá que existir um codigo para preenchimento das propriedades: [E-MAIL, RG]..

Se chegar o "E-MAIL" preenchido, terá que existir um código para preenchimento: [CPF, RG]

Esse ajuste é necessário para realização correta dos correlacimentos entre os provedores..

Sem isso, o processo de anonimizçaão nao funcionará.

Esse método deve ser utilizado para preenchimento das propriedades do objeto de Identifier.

Esse método receberá como parametro uma instancia de um objeto do tipo "IdentifierModelBase"

Se por exemplo, digamos que essa classe tenha as propriedades: [CPF, E-MAIL, RG].

Se chegar uma instancia dessa classe com a propridade "CPF" preenchida: ex: CPF = "0154518548".

Nesse caso, terá que existir um codigo para preenchimento das propriedades: [E-MAIL, RG]..

Se chegar o "E-MAIL" preenchido, terá que existir um código para preenchimento: [CPF, RG]

Exemplo:

Bloco de código

language	c#
firstline	1
linenumbers	true

using RM.Glb.DataProtection.Service.Domain;

namespace RM.Glb.TesteUnitario
{
  [GlbDataProtectionRoleAttr("7b886d91-86b1-4953-ad93-7da732d40515", "Funcionários", "RM", "Fop","FopFolhaActionModuleController", "P")]
  public class RHUDataProtectionProviderFuncionario<FuncID> :
  GlbDataProtectionProviderBase<FuncionarioIDModel>
    where FuncID : FuncionarioIDModel, new()
  {
    protected override void DoAfterAnonimize(FuncionarioIDModel identification)
    {
        //regras de negocio logo após a execuão dos updates de anonimização.
    }

    protected override CanAnonimizeResult DoCanAnonimize(FuncionarioIDModel identification)
    {
      CanAnonimizeResult result = new CanAnonimizeResult();

      if (!string.IsNullOrWhiteSpace(identification.Cpf))
      {
        result.CanAnonimize = false;
        RuleModel rule = new RuleModel();
        rule.Classificacao = "151/15";
        rule.Justificativa = "Não autorizada";
        result.Rules.Add(rule);
      }
      else if (!string.IsNullOrWhiteSpace(identification.Chapa))
      {
        result.CanAnonimize = true;
      }
      return result;
    }

    protected override void DoFillIdentifier(FuncionarioIDModel identifier)
    {
      identifier.Chapa = "00001";
      identifier.CodColigada = 1;
      identifier.Rg = "M71545";
      identifier.Nome = "Teste ok";
    }

    protected override void DoConfigAnonimize(AnonimizeMapperBuilder config)
    {
       config.AddTable(builder => builder
                        .WithTableName("PPESSOA")
                        .WithExcludedColumns("ESTADOCIVIL")
                        .WithPrimaryKey("CODIGO")
                        .WithDefaultValues("SEXO", "#")
            )
           .AddTable(builder => builder 
                        .WithTableName("PFUNC")
                        .WithPrimaryKey("CODCOLIGADA", "CHAPA")
                        .WithExcludedColumns("CODSECAO")
                        .WithDefaultValues("SITUACAOFGTS", "#")
            )
            .AddTable(builder => builder
                        .WithTableName("PFDEPEND")
                        .WithPrimaryKey("CODCOLIGADA", "CHAPA", "NRODEPENDENTE")
                        .WithExcludedColumns("CARTORIO")
                        .WithDefaultValues("LOCALNASCIMENTO", "ITAGUARA")
            )
            .AddRelation(builder => builder
                        .WithParentTable("PPESSOA")
                        .WithChildTable("PFUNC")
                        .WithParentColumns("CODCOLIGADA", "CODIGO")
                        .WithChildColumns("CODCOLIGADA", "CODPESSOA")
            )
            .AddRelation(builder => builder
                        .WithParentTable("PFUNC")
                        .WithChildTable("PFDEPEND")
                        .WithParentColumns("CODCOLIGADA", "CHAPA")
                        .WithChildColumns("CODCOLIGADA", "CHAPA")
            );

      //Para esse caso em especifico, serão gerados as seguinte sentenças sql.
      //Como exemplo, foram marcados os seguintes campos na GDicDataProtection.
      //PESSOA = DTNASCIMENTO, SEXTO, NACIONALIDADE
      //PFUNC = NOME, CODSECAO
      //PFDEPEND = NOME, DTDANSCIMENTO, ESTADOCIVIL

      //UPDATE PPESSOA SET DTNASCIMENTO = 01/01/1900, SEXO = '#', NACIONALIDADE = "X"
      //WHERE PPESSOA.CPF = '015454515'

      //UPDATE PFUNC SET NOME = 'XXX'
      //FROM PPESSOA
      //WHERE PPESSOA.CODIGO = PFUNC.CODPESSOA
      //AND PPESSOA.CPF = '015454515'

      //UPDATE PFDEPEND SET NOME = 'XXX', DTNASCIMENTO = '1999/01/01', ESTADOCIVIL = 'X'
      //FROM PFUNC INNER JOIN PPESSOA
      //  ON PFUNC.CODPESSOA = PPESSOA.CODIGO
      //WHERE PPESSOA.CPF = '015454515'


    }
  }
}

Informações

No exemplo acima, o provider "RHUDataProtectionProviderFuncionario" usa a tabela "PPESSOA" porque no método "DoConfigAnonimize" está sendo usado o config.AddTable(builder => builder .WithTableName("PPESSOA"). Nesse caso, a tabela PPESSOA será anonimizada por ele porque as sentenças "updates" serão geradas para a tabela PPESSOA.

Para desligar esse comportamento de geração automática da sentenças "UPDATE" basta usar o .WithExcludeUpdateClausule(). Sendo assim, usando o "WithExcludeUpdateClausule" esse provider funcionaria como "ponte" para correlacionamento com outros providers que usa a "PPESSOA".

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()
  {
  }
}

04. Diagrama de classes

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 11

Nova versão 12

Chave

04. Implementando um consumidor de mensagens

Pré-requisitos

04. Diagrama de classes