TracciaSerializer.java

  1. /*
  2.  * GovWay - A customizable API Gateway 
  3.  * https://govway.org
  4.  * 
  5.  * Copyright (c) 2005-2025 Link.it srl (https://link.it). 
  6.  * 
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 3, as published by
  9.  * the Free Software Foundation.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  *
  19.  */



  23. package org.openspcoop2.protocol.basic.tracciamento;

  25. import java.io.ByteArrayOutputStream;
  26. import java.util.ArrayList;
  27. import java.util.List;

  29. import org.openspcoop2.core.tracciamento.Eccezione;
  30. import org.openspcoop2.core.tracciamento.Proprieta;
  31. import org.openspcoop2.core.tracciamento.Riscontro;
  32. import org.openspcoop2.core.tracciamento.Trasmissione;
  33. import org.openspcoop2.core.tracciamento.constants.TipoCodificaEccezione;
  34. import org.openspcoop2.core.tracciamento.constants.TipoInoltro;
  35. import org.openspcoop2.core.tracciamento.constants.TipoProfiloCollaborazione;
  36. import org.openspcoop2.core.tracciamento.constants.TipoRilevanzaEccezione;
  37. import org.openspcoop2.core.tracciamento.constants.TipoTempo;
  38. import org.openspcoop2.message.constants.ServiceBinding;
  39. import org.openspcoop2.protocol.basic.BasicComponentFactory;
  40. import org.openspcoop2.protocol.sdk.Busta;
  41. import org.openspcoop2.protocol.sdk.IProtocolFactory;
  42. import org.openspcoop2.protocol.sdk.ProtocolException;
  43. import org.openspcoop2.protocol.sdk.XMLRootElement;
  44. import org.openspcoop2.protocol.sdk.config.ITraduttore;
  45. import org.openspcoop2.protocol.sdk.constants.CodiceErroreCooperazione;
  46. import org.openspcoop2.protocol.sdk.constants.Inoltro;
  47. import org.openspcoop2.protocol.sdk.constants.ProfiloDiCollaborazione;
  48. import org.openspcoop2.protocol.sdk.constants.SubCodiceErrore;
  49. import org.openspcoop2.protocol.sdk.constants.TipoOraRegistrazione;
  50. import org.openspcoop2.protocol.sdk.constants.TipoSerializzazione;
  51. import org.openspcoop2.protocol.sdk.tracciamento.Traccia;
  52. import org.openspcoop2.protocol.sdk.tracciamento.TracciaExtInfo;
  53. import org.openspcoop2.protocol.sdk.tracciamento.TracciaExtInfoDefinition;
  54. import org.openspcoop2.utils.xml.AbstractXMLUtils;
  55. import org.w3c.dom.Element;

  57. /**
  58.  * TracciaSerializer
  59.  *
  60.  * @author Andrea Poli (apoli@link.it)
  61.  * @author $Author$
  62.  * @version $Rev$, $Date$
  63.  */
  64. public class TracciaSerializer extends BasicComponentFactory implements org.openspcoop2.protocol.sdk.tracciamento.ITracciaSerializer {
  65.     
  66.     protected AbstractXMLUtils xmlUtils;
  67.     
  68.     private boolean prettyDocument = false;
  69.     private boolean omitXmlDeclaration = false;

  71.     public TracciaSerializer(IProtocolFactory<?> factory) throws ProtocolException {
  72.         super(factory);
  73.         this.xmlUtils = org.openspcoop2.message.xml.MessageXMLUtils.DEFAULT;
  74.     }

  76.     
  77.     @Override
  78.     public void setPrettyDocument(boolean v) {
  79.         this.prettyDocument = v;
  80.     }
  81.     @Override
  82.     public boolean isPrettyDocument() {
  83.         return this.prettyDocument;
  84.     }
  85.     @Override
  86.     public void setOmitXmlDeclaration(boolean v) {
  87.         this.omitXmlDeclaration = v;
  88.     }
  89.     @Override
  90.     public boolean isOmitXmlDeclaration() {
  91.         return this.omitXmlDeclaration;
  92.     }

  94.     
  95.     private org.openspcoop2.core.tracciamento.Traccia toTraccia(Traccia tracciaObject)
  96.             throws ProtocolException {
  97.         String tmpId = null;
  98.         org.openspcoop2.core.tracciamento.Traccia tracciaBase = null;
  99.         try{
  100.                         
  101.             if(tracciaObject.sizeProperties()>0){
  102.                 tmpId = tracciaObject.removeProperty(TracciaDriver.IDTRACCIA); // non deve essere serializzato
  103.             }       
  104.             tracciaBase = tracciaObject.getTraccia();
  105.             
  106.             // xml
  107.             if(tracciaBase!=null &&
  108.                 tracciaBase.getBustaRaw()==null){
  109.                 if(tracciaObject.getBustaAsByteArray()!=null)
  110.                     tracciaBase.setBustaRaw(new String(tracciaObject.getBustaAsByteArray()));
  111.                 else if(tracciaObject.getBustaAsRawContent()!=null){            
  112.                     try{
  113.                         tracciaBase.setBustaRaw(tracciaObject.getBustaAsRawContent().toString(TipoSerializzazione.DEFAULT));
  114.                     }catch(Exception e){
  115.                         throw new ProtocolException("Serializzazione RawContent non riuscita: "+e.getMessage(),e);
  116.                     }
  117.                 }
  118.             }
  119.             
  120.             // Traduzioni da factory
  121.             ITraduttore protocolTraduttore = this.protocolFactory.createTraduttore();
  122.             if(tracciaBase!=null &&
  123.                 tracciaBase.getBusta()!=null){
  124.                 if(tracciaBase.getBusta().getProfiloCollaborazione()!=null &&
  125.                         tracciaBase.getBusta().getProfiloCollaborazione().getBase()==null && 
  126.                         tracciaBase.getBusta().getProfiloCollaborazione().getTipo()!=null){
  127.                     tracciaBase.getBusta().getProfiloCollaborazione().setBase(this.getBaseValueProfiloCollaborazione(protocolTraduttore,tracciaBase.getBusta().getProfiloCollaborazione().getTipo()));
  128.                 }
  129.                 if(tracciaBase.getBusta().getProfiloTrasmissione()!=null &&
  130.                         tracciaBase.getBusta().getProfiloTrasmissione().getInoltro()!=null &&
  131.                         tracciaBase.getBusta().getProfiloTrasmissione().getInoltro().getBase()==null && 
  132.                         tracciaBase.getBusta().getProfiloTrasmissione().getInoltro().getTipo()!=null){
  133.                     tracciaBase.getBusta().getProfiloTrasmissione().getInoltro().setBase(this.getBaseValueInoltro(protocolTraduttore,tracciaBase.getBusta().getProfiloTrasmissione().getInoltro().getTipo()));
  134.                 }
  135.                 if(tracciaBase.getBusta().getOraRegistrazione()!=null &&
  136.                         tracciaBase.getBusta().getOraRegistrazione().getSorgente()!=null &&
  137.                         tracciaBase.getBusta().getOraRegistrazione().getSorgente().getBase()==null && 
  138.                         tracciaBase.getBusta().getOraRegistrazione().getSorgente().getTipo()!=null){
  139.                     tracciaBase.getBusta().getOraRegistrazione().getSorgente().setBase(this.getBaseValueTipoTempo(protocolTraduttore,tracciaBase.getBusta().getOraRegistrazione().getSorgente().getTipo()));
  140.                 }
  141.                 if(tracciaBase.getBusta().getTrasmissioni()!=null && tracciaBase.getBusta().getTrasmissioni().sizeTrasmissioneList()>0){
  142.                     for (Trasmissione trasmissione : tracciaBase.getBusta().getTrasmissioni().getTrasmissioneList()) {
  143.                         if(trasmissione.getOraRegistrazione()!=null &&
  144.                                 trasmissione.getOraRegistrazione().getSorgente()!=null &&
  145.                                 trasmissione.getOraRegistrazione().getSorgente().getBase()==null &&
  146.                                 trasmissione.getOraRegistrazione().getSorgente().getTipo()!=null){
  147.                             trasmissione.getOraRegistrazione().getSorgente().setBase(this.getBaseValueTipoTempo(protocolTraduttore,trasmissione.getOraRegistrazione().getSorgente().getTipo()));
  148.                         }
  149.                     }
  150.                 }
  151.                 if(tracciaBase.getBusta().getRiscontri()!=null && tracciaBase.getBusta().getRiscontri().sizeRiscontroList()>0){
  152.                     for (Riscontro riscontro : tracciaBase.getBusta().getRiscontri().getRiscontroList()) {
  153.                         if(riscontro.getOraRegistrazione()!=null &&
  154.                             riscontro.getOraRegistrazione().getSorgente()!=null &&
  155.                             riscontro.getOraRegistrazione().getSorgente().getBase()==null &&
  156.                             riscontro.getOraRegistrazione().getSorgente().getTipo()!=null){
  157.                             riscontro.getOraRegistrazione().getSorgente().setBase(this.getBaseValueTipoTempo(protocolTraduttore,riscontro.getOraRegistrazione().getSorgente().getTipo()));
  158.                         }
  159.                     }
  160.                 }
  161.                 if(tracciaBase.getBusta().getEccezioni()!=null && tracciaBase.getBusta().getEccezioni().sizeEccezioneList()>0){
  162.                     for (Eccezione eccezione : tracciaBase.getBusta().getEccezioni().getEccezioneList()) {
  163.                         if(eccezione.getCodice()!=null &&
  164.                             eccezione.getCodice().getBase()==null && eccezione.getCodice().getTipo()!=null){
  165.                             eccezione.getCodice().setBase(this.getBaseValueCodiceEccezione(protocolTraduttore,eccezione.getCodice().getTipo(), eccezione.getCodice().getSottotipo()));
  166.                         }
  167.                         if(eccezione.getContestoCodifica()!=null &&
  168.                             eccezione.getContestoCodifica().getBase()==null && 
  169.                             eccezione.getContestoCodifica().getTipo()!=null){
  170.                             eccezione.getContestoCodifica().setBase(this.getBaseValueContestoCodifica(protocolTraduttore,eccezione.getContestoCodifica().getTipo()));
  171.                         }
  172.                         if(eccezione.getRilevanza()!=null &&
  173.                             eccezione.getRilevanza().getBase()==null &&
  174.                             eccezione.getRilevanza().getTipo()!=null){
  175.                             eccezione.getRilevanza().setBase(this.getBaseValueRilevanzaEccezione(protocolTraduttore,eccezione.getRilevanza().getTipo()));
  176.                         }
  177.                     }
  178.                 }
  179.             }
  180.                             
  181.         } catch(Exception e) {
  182.             logAndThrowError(e, "XMLBuilder.buildElement_Tracciamento error");
  183.         }
  184.         finally{
  185.             if(tmpId!=null && tracciaObject!=null){
  186.                 tracciaObject.addProperty(TracciaDriver.IDTRACCIA, tmpId);
  187.             }
  188.         }
  189.         
  190.         return tracciaBase;
  191.     }
  192.     
  193.     private void logAndThrowError(Exception e, String msg) throws ProtocolException {
  194.         String er = msg+": "+e.getMessage();
  195.         this.log.error(er,e);
  196.         throw new ProtocolException(er,e);
  197.     }

  199.     @Override
  200.     public Element toElement(Traccia tracciaObject)
  201.             throws ProtocolException {
  202.         byte[] traccia = this.toByteArray(tracciaObject,TipoSerializzazione.XML);
  203.         Element el = null;
  204.         try{
  205.             el = this.xmlUtils.newElement(traccia);
  206.         } catch(Exception e) {
  207.             logAndThrowError(e, "TracciaSerializer.toElement error");
  208.         }
  209.         return el;
  210.     }

  212.     @Override
  213.     public String toString(Traccia traccia, TipoSerializzazione tipoSerializzazione) throws ProtocolException {
  214.         return this.toByteArrayOutputStream(traccia, tipoSerializzazione).toString();
  215.     }

  217.     @Override
  218.     public byte[] toByteArray(Traccia traccia, TipoSerializzazione tipoSerializzazione) throws ProtocolException {
  219.         return this.toByteArrayOutputStream(traccia, tipoSerializzazione).toByteArray();
  220.     }
  221.     
  222.     protected ByteArrayOutputStream toByteArrayOutputStream(Traccia traccia, TipoSerializzazione tipoSerializzazione) throws ProtocolException {
  223.         
  224.         ByteArrayOutputStream ret = null;
  225.         try{
  226.         
  227.             org.openspcoop2.core.tracciamento.Traccia tracciaBase = this.toTraccia(traccia);
  228.             
  229.             switch (tipoSerializzazione) {
  230.                 case XML:
  231.                 case DEFAULT:
  232.                     
  233.                     ByteArrayOutputStream bout = new ByteArrayOutputStream();
  234.                     org.openspcoop2.core.tracciamento.utils.XMLUtils.generateTraccia(tracciaBase,bout,this.prettyDocument,this.omitXmlDeclaration);
  235.                     bout.flush();
  236.                     bout.close();
  237.                     ret =  bout;
  238.                     break;
  239.     
  240.                 case JSON:
  241.                     
  242.                     bout = new ByteArrayOutputStream();
  243.                     String s = org.openspcoop2.core.tracciamento.utils.XMLUtils.generateTracciaAsJson(tracciaBase,this.prettyDocument);
  244.                     bout.write(s.getBytes());
  245.                     bout.flush();
  246.                     bout.close();
  247.                     ret =  bout;
  248.                     break;
  249.             }
  250.             
  251.             if(ret==null) {
  252.                 throw new ProtocolException("Tipo ["+tipoSerializzazione+"] Non gestito");
  253.             }
  254.             
  255.         } catch(Exception e) {
  256.             logAndThrowError(e, "TracciaSerializer.toString error");
  257.         }
  258.         
  259.         return ret;
  260.     }

  262.     
  263.     
  264.     // UTILITIES 
  265.     
  266.     private String getBaseValueProfiloCollaborazione(ITraduttore protocolTraduttore,TipoProfiloCollaborazione tipoProfiloCollaborazione){
  267.         switch (tipoProfiloCollaborazione) {
  268.         case ONEWAY:
  269.             return protocolTraduttore.toString(ProfiloDiCollaborazione.ONEWAY);
  270.         case SINCRONO:
  271.             return protocolTraduttore.toString(ProfiloDiCollaborazione.SINCRONO);
  272.         case ASINCRONO_ASIMMETRICO:
  273.             return protocolTraduttore.toString(ProfiloDiCollaborazione.ASINCRONO_ASIMMETRICO);
  274.         case ASINCRONO_SIMMETRICO:
  275.             return protocolTraduttore.toString(ProfiloDiCollaborazione.ASINCRONO_SIMMETRICO);
  276.         case SCONOSCIUTO:
  277.             return protocolTraduttore.toString(ProfiloDiCollaborazione.UNKNOWN);
  278.         }
  279.         return null;
  280.     }
  281.     
  282.     private String getBaseValueInoltro(ITraduttore protocolTraduttore,TipoInoltro tipoInoltro){
  283.         switch (tipoInoltro) {
  284.         case INOLTRO_CON_DUPLICATI:
  285.             return protocolTraduttore.toString(Inoltro.CON_DUPLICATI);
  286.         case INOLTRO_SENZA_DUPLICATI:
  287.             return protocolTraduttore.toString(Inoltro.SENZA_DUPLICATI);
  288.         case SCONOSCIUTO:
  289.             return protocolTraduttore.toString(Inoltro.UNKNOWN);
  290.         }
  291.         return null;
  292.     }
  293.     
  294.     private String getBaseValueTipoTempo(ITraduttore protocolTraduttore,TipoTempo tipoTempo){
  295.         switch (tipoTempo) {
  296.         case LOCALE:
  297.             return protocolTraduttore.toString(TipoOraRegistrazione.LOCALE);
  298.         case SCONOSCIUTO:
  299.             return protocolTraduttore.toString(TipoOraRegistrazione.UNKNOWN);
  300.         case SINCRONIZZATO:
  301.             return protocolTraduttore.toString(TipoOraRegistrazione.SINCRONIZZATO);
  302.         }
  303.         return null;
  304.     }
  305.     
  306.     private String getBaseValueCodiceEccezione(ITraduttore protocolTraduttore,Integer codice, Integer subCodice){
  307.         CodiceErroreCooperazione errore = CodiceErroreCooperazione.toCodiceErroreCooperazione(codice);
  308.         if(subCodice==null){
  309.             return protocolTraduttore.toString(errore);
  310.         }
  311.         else{
  312.             SubCodiceErrore sub = new SubCodiceErrore();
  313.             sub.setSubCodice(subCodice);
  314.             return protocolTraduttore.toString(errore,sub);
  315.         }
  316.     }
  317.     
  318.     private String getBaseValueContestoCodifica(ITraduttore protocolTraduttore,TipoCodificaEccezione codifica){
  319.         switch (codifica) {
  320.         case ECCEZIONE_PROCESSAMENTO:
  321.             return protocolTraduttore.toString(org.openspcoop2.protocol.sdk.constants.ContestoCodificaEccezione.PROCESSAMENTO);
  322.         case ECCEZIONE_VALIDAZIONE_PROTOCOLLO:
  323.             return protocolTraduttore.toString(org.openspcoop2.protocol.sdk.constants.ContestoCodificaEccezione.INTESTAZIONE);
  324.         case SCONOSCIUTO:
  325.             return null;
  326.         }
  327.         return null;
  328.     }
  329.     
  330.     private String getBaseValueRilevanzaEccezione(ITraduttore protocolTraduttore,TipoRilevanzaEccezione codifica){
  331.         switch (codifica) {
  332.         case DEBUG:
  333.             return protocolTraduttore.toString(org.openspcoop2.protocol.sdk.constants.LivelloRilevanza.DEBUG);
  334.         case ERROR:
  335.             return protocolTraduttore.toString(org.openspcoop2.protocol.sdk.constants.LivelloRilevanza.ERROR);
  336.         case FATAL:
  337.             return protocolTraduttore.toString(org.openspcoop2.protocol.sdk.constants.LivelloRilevanza.FATAL);
  338.         case INFO:
  339.             return protocolTraduttore.toString(org.openspcoop2.protocol.sdk.constants.LivelloRilevanza.INFO);
  340.         case WARN:
  341.             return protocolTraduttore.toString(org.openspcoop2.protocol.sdk.constants.LivelloRilevanza.WARN);
  342.         case SCONOSCIUTO:
  343.             return protocolTraduttore.toString(org.openspcoop2.protocol.sdk.constants.LivelloRilevanza.UNKNOWN);
  344.         }
  345.         return null;
  346.     }



  350.     @Override
  351.     public XMLRootElement getXMLRootElement() throws ProtocolException {
  352.         return new TracciaXMLRootElement();
  353.     }
  354.     
  355.     
  356.     @Override
  357.     public List<TracciaExtInfoDefinition> getExtInfoDefinition(){
  358.         return null;
  359.     }
  360.     @Override
  361.     public List<TracciaExtInfo> extractExtInfo(Busta busta, ServiceBinding tipoApi){
  362.         List<TracciaExtInfoDefinition> extInfoDefinitionList = this.getExtInfoDefinition();
  363.         List<TracciaExtInfo> list = null;
  364.         if(extInfoDefinitionList!=null && !extInfoDefinitionList.isEmpty()) {
  365.             
  366.             list = new ArrayList<>();
  367.             TracciaExtInfo extInfoNoPrefix = new TracciaExtInfo();
  368.             extInfoNoPrefix.setEmpty(true);
  369.             list.add(extInfoNoPrefix);
  370.             
  371.             List<String> propertyNamesEsistentiNellaBusta = new ArrayList<>();
  372.             for (String pName : busta.getPropertiesNames()) {
  373.                 propertyNamesEsistentiNellaBusta.add(pName);
  374.             }
  375.             
  376.             for (TracciaExtInfoDefinition tracciaExtInfoDefinition : extInfoDefinitionList) {
  377.                 
  378.                 TracciaExtInfo extInfo = new TracciaExtInfo();
  379.                 extInfo.setLabel(tracciaExtInfoDefinition.getLabel());
  380.                 
  381.                 List<String> proprietaDaRimuovere = new ArrayList<>();
  382.                 
  383.                 if(!propertyNamesEsistentiNellaBusta.isEmpty()) {
  384.                     for (String pName : propertyNamesEsistentiNellaBusta) {
  385.                         if(pName.startsWith(tracciaExtInfoDefinition.getPrefixId())) {
  386.                             String pValue = busta.getProperty(pName);
  387.                             String pNameWithoutPrefix = pName.substring(tracciaExtInfoDefinition.getPrefixId().length());
  388.                             Proprieta proprieta = new Proprieta();
  389.                             proprieta.setNome(pNameWithoutPrefix);
  390.                             proprieta.setValore(pValue);
  391.                             extInfo.getProprieta().add(proprieta);
  392.                             
  393.                             proprietaDaRimuovere.add(pName);
  394.                         }
  395.                     }
  396.                     
  397.                 }
  398.                 
  399.                 if(!proprietaDaRimuovere.isEmpty()) {
  400.                     for (String pName : proprietaDaRimuovere) {
  401.                         propertyNamesEsistentiNellaBusta.remove(pName);
  402.                     }
  403.                 }
  404.                 
  405.                 if(!extInfo.getProprieta().isEmpty()) {
  406.                     
  407.                     if(tracciaExtInfoDefinition.isOrder()) {
  408.                         
  409.                         java.util.ArrayList<String> listKeys = new ArrayList<>(); 
  410.                         for (Proprieta proprieta : extInfo.getProprieta()) {
  411.                             listKeys.add(proprieta.getNome());
  412.                         }
  413.                         java.util.Collections.sort(listKeys);
  414.                         List<Proprieta> proprietaOrdinate = new ArrayList<>();
  415.                         for (String key : listKeys) {   
  416.                             Proprieta p = extInfo.getProprieta(key);
  417.                             proprietaOrdinate.add(p);
  418.                         }
  419.                         extInfo.setProprieta(proprietaOrdinate);
  420.                         
  421.                     }
  422.                     
  423.                     list.add(extInfo);
  424.                 }
  425.                 
  426.             }
  427.             
  428.             if(!propertyNamesEsistentiNellaBusta.isEmpty()) {
  429.                 for (String pName : propertyNamesEsistentiNellaBusta) {
  430.                     Proprieta proprieta = new Proprieta();
  431.                     proprieta.setNome(pName);
  432.                     proprieta.setValore(busta.getProperty(pName));
  433.                     extInfoNoPrefix.getProprieta().add(proprieta);
  434.                 }
  435.             }
  436.             
  437.             if(list.get(0).getProprieta().isEmpty()) {
  438.                 list.remove(0); // noPrefix
  439.             }
  440.         
  441.         }
  442.         return list;
  443.     }
  444. }
Created with JaCoCo 0.8.8.202204050719