AccordoServizioWrapperUtilities.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.  */


  22. package org.openspcoop2.core.registry.rest;

  24. import java.io.File;
  25. import java.net.URL;
  26. import java.util.ArrayList;
  27. import java.util.HashMap;
  28. import java.util.List;
  29. import java.util.Map;

  31. import org.openspcoop2.core.registry.AccordoServizioParteComune;
  32. import org.openspcoop2.core.registry.Documento;
  33. import org.openspcoop2.core.registry.constants.FormatoSpecifica;
  34. import org.openspcoop2.core.registry.driver.DriverRegistroServiziException;
  35. import org.openspcoop2.message.OpenSPCoop2MessageFactory;
  36. import org.openspcoop2.message.xml.MessageXMLUtils;
  37. import org.openspcoop2.utils.LoggerWrapperFactory;
  38. import org.openspcoop2.utils.json.JSONUtils;
  39. import org.openspcoop2.utils.json.YAMLUtils;
  40. import org.openspcoop2.utils.resources.FileSystemUtilities;
  41. import org.openspcoop2.utils.rest.ApiFactory;
  42. import org.openspcoop2.utils.rest.ApiFormats;
  43. import org.openspcoop2.utils.rest.ApiReaderConfig;
  44. import org.openspcoop2.utils.rest.IApiReader;
  45. import org.openspcoop2.utils.rest.api.Api;
  46. import org.openspcoop2.utils.rest.api.ApiSchema;
  47. import org.openspcoop2.utils.rest.api.ApiSchemaType;
  48. import org.openspcoop2.utils.transport.http.HttpUtilities;
  49. import org.openspcoop2.utils.xml.AbstractXMLUtils;
  50. import org.openspcoop2.utils.xml.XSDUtils;
  51. import org.slf4j.Logger;


  54. /**
  55.  * Classe utilizzata per leggere/modificare i wsdl che formano un accordo di un servizio
  56.  *
  57.  *
  58.  * @author Poli Andrea (apoli@link.it)
  59.  * @author $Author$
  60.  * @version $Rev$, $Date$
  61.  */


  64. public class AccordoServizioWrapperUtilities {

  66.     private Logger logger = null;
  67.     private AbstractXMLUtils xmlUtils = null;
  68.     private XSDUtils xsdUtils = null;
  69.     private JSONUtils jsonUtils = null;
  70.     private YAMLUtils yamlUtils = null;
  71.     private OpenSPCoop2MessageFactory messageFactory;
  72.     
  73.     /** Accordo Servizio */
  74.     public AccordoServizioWrapperUtilities(OpenSPCoop2MessageFactory messageFactory, Logger log, AccordoServizioWrapper accordoServizio){
  75.         if(log!=null)
  76.             this.logger = log;
  77.         else
  78.             this.logger = LoggerWrapperFactory.getLogger(AccordoServizioWrapperUtilities.class);
  79.         this.accordoServizioWrapper = accordoServizio;
  80.         this.messageFactory = messageFactory;
  81.         this.xmlUtils = MessageXMLUtils.getInstance(this.messageFactory);
  82.         this.xsdUtils = new XSDUtils(this.xmlUtils);
  83.         this.jsonUtils = JSONUtils.getInstance();
  84.         this.yamlUtils = YAMLUtils.getInstance();
  85.     }
  86.     private AccordoServizioWrapper accordoServizioWrapper = null;
  87.     public AccordoServizioWrapper getAccordoServizioWrapper() {
  88.         return this.accordoServizioWrapper;
  89.     }
  90.     public void setAccordoServizio(AccordoServizioWrapper accordoServizio) {
  91.         this.accordoServizioWrapper = accordoServizio;
  92.     }
  93.     
  94.     
  95.     
  96.     
  97.     
  98.     public static final String API_SENZA_SPECIFICA = "L'API non contiene una specifica";
  99.     
  100.     public void buildApiFromSpecific(boolean fromBytes,boolean buildSchemi,boolean processInclude) throws DriverRegistroServiziException {
  101.         
  102.         if(this.accordoServizioWrapper==null) {
  103.             throw new DriverRegistroServiziException("AccordoWrapper non fornito");
  104.         }
  105.         if(this.accordoServizioWrapper.getAccordoServizio()==null) {
  106.             throw new DriverRegistroServiziException("API non fornita");
  107.         }
  108.         AccordoServizioParteComune as = this.accordoServizioWrapper.getAccordoServizio();
  109.         
  110.         IApiReader apiReader = null;
  111.         FormatoSpecifica formato = as.getFormatoSpecifica();
  112.         if(formato==null) {
  113.             formato = FormatoSpecifica.OPEN_API_3;
  114.         }
  115.         switch (formato) {
  116.         case WADL:
  117.             try {
  118.                 apiReader = ApiFactory.newApiReader(ApiFormats.WADL);
  119.             }catch(Exception e) {
  120.                 throw new DriverRegistroServiziException("Inizializzazione Reader Specifica ["+this.accordoServizioWrapper.getAccordoServizio().getFormatoSpecifica()+"] fallito: "+e.getMessage(),e);
  121.             }
  122.             break;
  123.         case SWAGGER_2:
  124.             try {
  125.                 apiReader = ApiFactory.newApiReader(ApiFormats.SWAGGER_2);
  126.             }catch(Exception e) {
  127.                 throw new DriverRegistroServiziException("Inizializzazione Reader Specifica ["+this.accordoServizioWrapper.getAccordoServizio().getFormatoSpecifica()+"] fallito: "+e.getMessage(),e);
  128.             }
  129.             break;
  130.         case OPEN_API_3:
  131.             try {
  132.                 apiReader = ApiFactory.newApiReader(ApiFormats.OPEN_API_3);
  133.             }catch(Exception e) {
  134.                 throw new DriverRegistroServiziException("Inizializzazione Reader Specifica ["+this.accordoServizioWrapper.getAccordoServizio().getFormatoSpecifica()+"] fallito: "+e.getMessage(),e);
  135.             }
  136.             break;
  137.         case WSDL_11:
  138.             throw new DriverRegistroServiziException("Tipo specifica ["+this.accordoServizioWrapper.getAccordoServizio().getFormatoSpecifica()+"] non supportata");
  139.         }
  140.         
  141.         if(apiReader==null) {
  142.             throw new DriverRegistroServiziException("Inizializzazione Reader Specifica ["+this.accordoServizioWrapper.getAccordoServizio().getFormatoSpecifica()+"] fallita");
  143.         }
  144.         
  145.         
  146.         byte [] specifica = null;
  147.         if(fromBytes){
  148.             if(as.getByteWsdlConcettuale()!=null){
  149.                 specifica = as.getByteWsdlConcettuale();
  150.             }
  151.         }
  152.         else{
  153.             if(as.getWsdlConcettuale()!=null){
  154.                 try{
  155.                     String location = as.getWsdlConcettuale();
  156.                     if(location.startsWith("http://") || location.startsWith("file://")){
  157.                         URL url = new URL(location);
  158.                         specifica = HttpUtilities.requestHTTPFile(url.toString());
  159.                     }
  160.                     else{
  161.                         File f = new File(location);
  162.                         specifica = FileSystemUtilities.readBytesFromFile(f);
  163.                     }
  164.                 }catch(Exception e){
  165.                     throw new DriverRegistroServiziException("L'API contiene una specifica corrotta: "+e.getMessage(),e);
  166.                 }
  167.             }
  168.         }
  169.         if(specifica==null) {
  170.             throw new DriverRegistroServiziException(API_SENZA_SPECIFICA);
  171.         }
  172.         
  173.         
  174.         
  175.         ApiSchema [] s = null;
  176.         ApiReaderConfig config = new ApiReaderConfig();
  177.         if(buildSchemi) {
  178.             config.setProcessInclude(processInclude);
  179.             config.setProcessInlineSchema(true);
  180.             s = this.buildSchemas(as, fromBytes);
  181.         }
  182.         else {
  183.             config.setProcessInclude(false);
  184.             config.setProcessInlineSchema(false);
  185.         }
  186.         try {
  187.             if(s!=null) {
  188.                 apiReader.init(this.logger, specifica, config, s);
  189.             }
  190.             else {
  191.                 apiReader.init(this.logger, specifica, config);
  192.             }
  193.             Api api = apiReader.read();
  194.             this.accordoServizioWrapper.setApi(api);
  195.         }catch(Exception e) {
  196.             throw new DriverRegistroServiziException("Inizializzazione Specifica ["+this.accordoServizioWrapper.getAccordoServizio().getFormatoSpecifica()+"] fallita: "+e.getMessage(),e);
  197.         }
  198.         
  199.         
  200.     }
  201.     
  202.     
  203.     public void buildApiFromRegistry(boolean fromBytes,boolean buildSchemi) throws DriverRegistroServiziException {
  204.             
  205.         if(this.accordoServizioWrapper==null) {
  206.             throw new DriverRegistroServiziException("AccordoWrapper non fornito");
  207.         }
  208.         if(this.accordoServizioWrapper.getAccordoServizio()==null) {
  209.             throw new DriverRegistroServiziException("API non fornita");
  210.         }
  211.         AccordoServizioParteComune as = this.accordoServizioWrapper.getAccordoServizio();
  212.         
  213.         try {
  214.             RegistryAPI api = new RegistryAPI(as, "http://TODO");
  215.             
  216.             ApiSchema [] s = null;
  217.             if(buildSchemi) {
  218.                 s = this.buildSchemas(as, fromBytes);
  219.                 if(s!=null && s.length>0) {
  220.                     for (int i = 0; i < s.length; i++) {
  221.                         api.addSchema(s[i]);
  222.                     }
  223.                 }
  224.             }
  225.             
  226.             this.accordoServizioWrapper.setApi(api);
  227.         }catch(Exception e) {
  228.             throw new DriverRegistroServiziException("Inizializzazione Specifica ["+this.accordoServizioWrapper.getAccordoServizio().getFormatoSpecifica()+"] fallita: "+e.getMessage(),e);
  229.         }
  230.     }
  231.     
  232.     
  233.     private ApiSchema [] buildSchemas(AccordoServizioParteComune as, boolean fromBytes) throws DriverRegistroServiziException{
  234.         Map<String, byte[]> resourcesXSD = new HashMap<String, byte[]>();
  235.         Map<String, byte[]> resourcesJSON = new HashMap<String, byte[]>();
  236.         Map<String, byte[]> resourcesYAML = new HashMap<String, byte[]>();
  237.         
  238.         // --------- ALLEGATI --------- 
  239.         if(as.sizeAllegatoList()>0){
  240.             for(int i=0; i<as.sizeAllegatoList();i++){

  242.                 Documento allegato = as.getAllegato(i);
  243.                 byte[] resource = null;
  244.                 String systemId = null;
  245.                 //String location = null;
  246.                 if(fromBytes){
  247.                     //location = allegato.getFile();
  248.                     systemId = allegato.getFile();
  249.                     resource = allegato.getByteContenuto();
  250.                     if(resource==null){
  251.                         throw new DriverRegistroServiziException("Allegato ["+systemId+"] non contiene i bytes che ne definiscono il contenuto");
  252.                     }
  253.                 }
  254.                 else{
  255.                     String location = allegato.getFile();
  256.                     try{
  257.                         if(location.startsWith("http://") || location.startsWith("file://")){
  258.                             URL url = new URL(location);
  259.                             resource = HttpUtilities.requestHTTPFile(url.toString());
  260.                             systemId = (new File(url.getFile())).getName();
  261.                         }
  262.                         else{
  263.                             File f = new File(location);
  264.                             resource = FileSystemUtilities.readBytesFromFile(f);
  265.                             systemId = f.getName();
  266.                         }   
  267.                     }catch(Exception e){
  268.                         throw new DriverRegistroServiziException("Allegato ["+location+"] indirizza un documento non esistente");
  269.                     }
  270.                 }

  272.                 try{
  273.                     if(this.xsdUtils.isXSDSchema(resource)){
  274.                         if(resourcesXSD.containsKey(systemId)){
  275.                             throw new Exception("Esiste più di un documento xsd, registrato tra allegati e specifiche semiformali, con nome ["+systemId+"] (La validazione di Govway richiede l'utilizzo di nomi diversi)");
  276.                         }
  277.                         resourcesXSD.put(systemId,resource); 
  278.                     }
  279.                     else if(this.yamlUtils.isYaml(resource)){
  280.                         if(resourcesYAML.containsKey(systemId)){
  281.                             throw new Exception("Esiste più di un documento yaml, registrato tra allegati e specifiche semiformali, con nome ["+systemId+"] (La validazione di Govway richiede l'utilizzo di nomi diversi)");
  282.                         }
  283.                         resourcesYAML.put(systemId,resource); 
  284.                     }
  285.                     else if(this.jsonUtils.isJson(resource)){
  286.                         if(resourcesJSON.containsKey(systemId)){
  287.                             throw new Exception("Esiste più di un documento json, registrato tra allegati e specifiche semiformali, con nome ["+systemId+"] (La validazione di Govway richiede l'utilizzo di nomi diversi)");
  288.                         }
  289.                         resourcesJSON.put(systemId,resource); 
  290.                     }
  291.                 }catch(Exception e){
  292.                     throw new DriverRegistroServiziException("La lettura dell'allegato ["+systemId+"] ha causato un errore: "+e.getMessage(),e);
  293.                 }

  295.             }
  296.         }


  299.         // --------- SPECIFICHE SEMIFORMALI --------- 
  300.         if(as.sizeSpecificaSemiformaleList()>0){
  301.             for(int i=0; i<as.sizeSpecificaSemiformaleList();i++){

  303.                 Documento specificaSemiformale = as.getSpecificaSemiformale(i);
  304.                 byte[] resource = null;
  305.                 String systemId = null;
  306.                 //String location = null;
  307.                 if(fromBytes){
  308.                     //location = specificaSemiformale.getFile();
  309.                     systemId = specificaSemiformale.getFile();
  310.                     resource = specificaSemiformale.getByteContenuto();
  311.                     if(resource==null){
  312.                         throw new DriverRegistroServiziException("Specifica Semiformale ["+systemId+"] non contiene i bytes che ne definiscono il contenuto");
  313.                     }
  314.                 }
  315.                 else{
  316.                     String location = specificaSemiformale.getFile();
  317.                     try{
  318.                         if(location.startsWith("http://") || location.startsWith("file://")){
  319.                             URL url = new URL(location);
  320.                             resource = HttpUtilities.requestHTTPFile(url.toString());
  321.                             systemId = (new File(url.getFile())).getName();
  322.                         }
  323.                         else{
  324.                             File f = new File(location);
  325.                             resource = FileSystemUtilities.readBytesFromFile(f);
  326.                             systemId = f.getName();
  327.                         }   
  328.                     }catch(Exception e){
  329.                         throw new DriverRegistroServiziException("Specifica Semiformale ["+location+"] indirizza un documento non esistente");
  330.                     }
  331.                 }

  333.                 try{
  334.                     if(this.xsdUtils.isXSDSchema(resource)){
  335.                         if(resourcesXSD.containsKey(systemId)){
  336.                             throw new Exception("Esiste più di un documento xsd, registrato tra allegati e specifiche semiformali, con nome ["+systemId+"] (La validazione di Govway richiede l'utilizzo di nomi diversi)");
  337.                         }
  338.                         resourcesXSD.put(systemId,resource); 
  339.                     }
  340.                     else if(this.yamlUtils.isYaml(resource)){
  341.                         if(resourcesYAML.containsKey(systemId)){
  342.                             throw new Exception("Esiste più di un documento yaml, registrato tra allegati e specifiche semiformali, con nome ["+systemId+"] (La validazione di Govway richiede l'utilizzo di nomi diversi)");
  343.                         }
  344.                         resourcesYAML.put(systemId,resource); 
  345.                     }
  346.                     else if(this.jsonUtils.isJson(resource)){
  347.                         if(resourcesJSON.containsKey(systemId)){
  348.                             throw new Exception("Esiste più di un documento json, registrato tra allegati e specifiche semiformali, con nome ["+systemId+"] (La validazione di Govway richiede l'utilizzo di nomi diversi)");
  349.                         }
  350.                         resourcesJSON.put(systemId,resource); 
  351.                     }
  352.                 }catch(Exception e){
  353.                     throw new DriverRegistroServiziException("La lettura della specifica semiformale ["+systemId+"] ha causato un errore: "+e.getMessage(),e);
  354.                 }

  356.             }
  357.         }

  359.         List<ApiSchema> schemas = new ArrayList<ApiSchema>();
  360.         if(resourcesXSD!=null && resourcesXSD.size()>0) {
  361.             for (String key : resourcesXSD.keySet()) {
  362.                 byte[] value = resourcesXSD.get(key);
  363.                 schemas.add(new ApiSchema(key, value, ApiSchemaType.XSD));
  364.             }
  365.         }
  366.         if(resourcesYAML!=null && resourcesYAML.size()>0) {
  367.             for (String key : resourcesYAML.keySet()) {
  368.                 byte[] value = resourcesYAML.get(key);
  369.                 schemas.add(new ApiSchema(key, value, ApiSchemaType.YAML));
  370.             }
  371.         }
  372.         if(resourcesJSON!=null && resourcesJSON.size()>0) {
  373.             for (String key : resourcesJSON.keySet()) {
  374.                 byte[] value = resourcesJSON.get(key);
  375.                 schemas.add(new ApiSchema(key, value, ApiSchemaType.JSON));
  376.             }
  377.         }
  378.         ApiSchema [] s = null;
  379.         if(schemas.size()>0) {
  380.             s = schemas.toArray(new ApiSchema[1]);
  381.         }
  382.         
  383.         return s;
  384.     }
  385. }
Created with JaCoCo 0.8.8.202204050719