AbstractXMLServiceManager.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.  */
  20. package org.openspcoop2.generic_project.dao.xml;

  22. import java.io.File;
  23. import java.io.FileInputStream;
  24. import java.io.InputStream;
  25. import java.net.HttpURLConnection;
  26. import java.net.URL;
  27. import java.net.URLConnection;

  29. import org.openspcoop2.generic_project.beans.IProjectInfo;
  30. import org.openspcoop2.generic_project.exception.ServiceException;
  31. import org.openspcoop2.generic_project.serializer.AbstractDeserializerBase;
  32. import org.openspcoop2.utils.LoggerWrapperFactory;
  33. import org.openspcoop2.utils.xml.ValidatoreXSD;
  34. import org.slf4j.Logger;

  36. /**
  37.  * AbstractXMLServiceManager
  38.  * 
  39.  * @author Poli Andrea (apoli@link.it)
  40.  * @author $Author$
  41.  * @version $Rev$, $Date$
  42.  */
  43. public abstract class AbstractXMLServiceManager<XML> {

  45.     /** Contesto di Unmarshall. */
  46.     private AbstractDeserializerBase deserializer;
  47.     private Class<XML> cXmlRoot;
  48.     /** XML Path */
  49.     protected String xmlPath;
  50.     /** 'Root' XML */
  51.     protected XML rootXml;
  52.     /** XSD Validator */
  53.     private ValidatoreXSD xsdValidator = null;
  54.     /** LastModified */
  55.     private long lastModified = 0;
  56.     /** Logger */
  57.     private Logger log = null;
  58.     /** Refresh Timeout */
  59.     private static final int timeoutRefresh = 30;
  60.     
  61.     
  62.     /** ************* parsing XML ************** */
  63.     private void parsingXML() throws ServiceException{

  65.         /* --- XSD -- */
  66.         FileInputStream fXML = null;
  67.         try{
  68.             if(this.xmlPath.startsWith("http://") || this.xmlPath.startsWith("file://")){
  69.                 this.xsdValidator.valida(this.xmlPath);  
  70.             }else{
  71.                 fXML = new FileInputStream(this.xmlPath);
  72.                 this.xsdValidator.valida(fXML);
  73.             }
  74.         }catch (Exception e) {
  75.             throw new ServiceException("Xsd validation failure: "+e.getMessage(),e);
  76.         }finally{
  77.             if(fXML!=null){
  78.                 try{
  79.                     fXML.close();
  80.                 }catch(Exception e){}
  81.             }
  82.         }

  84.         /* ---- InputStream ---- */
  85.         InputStream iStream = null;
  86.         HttpURLConnection httpConn = null;
  87.         if(this.xmlPath.startsWith("http://") || this.xmlPath.startsWith("file://")){
  88.             try{ 
  89.                 URL url = new URL(this.xmlPath);
  90.                 URLConnection connection = url.openConnection();
  91.                 httpConn = (HttpURLConnection) connection;
  92.                 httpConn.setRequestMethod("GET");
  93.                 httpConn.setDoOutput(true);
  94.                 httpConn.setDoInput(true);
  95.                 iStream = httpConn.getInputStream();
  96.             }catch(Exception e) {
  97.                 try{  
  98. //                  if(iStream!=null)
  99. //                      iStream.close();
  100.                     if(httpConn !=null)
  101.                         httpConn.disconnect();
  102.                 } catch(Exception ef) {}
  103.                 throw new ServiceException("Creating InputStream (HTTP) failure: "+e.getMessage(),e);
  104.             }
  105.             this.lastModified = System.currentTimeMillis();
  106.         }else{
  107.             try{  
  108.                 iStream = new FileInputStream(this.xmlPath);
  109.             }catch(java.io.FileNotFoundException e) {
  110.                 throw new ServiceException("Creating InputStream (FILE) failure"+e.getMessage(),e);
  111.             }
  112.             try{
  113.                 this.lastModified = (new File(this.xmlPath)).lastModified();
  114.             }catch(Exception e){
  115.                 try{  
  116.                     if(iStream!=null)
  117.                         iStream.close();
  118.                 } catch(java.io.IOException ef) {}
  119.                 throw new ServiceException("Reading xml ["+this.xmlPath+"] failure: "+e.getMessage(),e);
  120.             }
  121.         }

  123.         /* ---- Unmarshall ---- */
  124.         try{  
  125.             this.rootXml = (XML) this.deserializer.xmlToObj(iStream, this.cXmlRoot);
  126.         } catch(Exception e) {
  127.             try{  
  128.                 if(iStream!=null)
  129.                     iStream.close();
  130.                 if(httpConn !=null)
  131.                     httpConn.disconnect();
  132.             } catch(Exception ef) {}
  133.             throw new ServiceException("Unmarshall document xml failure: "+e.getMessage(),e);
  134.         }

  136.         /* ---- Close ---- */
  137.         try{  
  138.             if(iStream!=null)
  139.                 iStream.close();
  140.             if(httpConn !=null)
  141.                 httpConn.disconnect();
  142.         } catch(Exception e) {
  143.             throw new ServiceException("Close InputStream failure: "+e.getMessage(),e);
  144.         }
  145.     }




  150.     /* ********  COSTRUTTORI e METODI DI RELOAD  ******** */
  151.     protected AbstractXMLServiceManager(Class<XML> cXmlRoot, AbstractDeserializerBase deserializer, String xsdPath, File xmlPath) throws ServiceException{
  152.         this(cXmlRoot, deserializer, xsdPath, xmlPath,null);
  153.     }
  154.     protected AbstractXMLServiceManager(Class<XML> cXmlRoot, AbstractDeserializerBase deserializer, String xsdPath, File xmlPath,Logger alog) throws ServiceException{
  155.         this(cXmlRoot,deserializer, xsdPath, xmlPath.getAbsolutePath(),alog);
  156.     }
  157.     protected AbstractXMLServiceManager(Class<XML> cXmlRoot, AbstractDeserializerBase deserializer, String xsdPath, String xmlPath) throws ServiceException{
  158.         this(cXmlRoot, deserializer, xsdPath,  xmlPath,null);
  159.     }
  160.     protected AbstractXMLServiceManager(Class<XML> cXmlRoot, AbstractDeserializerBase deserializer, String xsdPath, String xmlPath,Logger alog) throws ServiceException{

  162.         if(alog==null){
  163.             this.log = LoggerWrapperFactory.getLogger(AbstractXMLServiceManager.class);
  164.         }else
  165.             this.log = alog;

  167.         if(xmlPath == null){
  168.             this.log.error("New Instance failure: url/xmlPath is null");
  169.             throw new ServiceException("New Instance failure: url/xmlPath is null");
  170.         }
  171.         this.xmlPath = xmlPath;
  172.         
  173.         /* --- XSD Validator -- */
  174.         if(xsdPath == null){
  175.             this.log.error("New Instance failure: xsdPath is null");
  176.             throw new ServiceException("New Instance failure: xsdPath is null");
  177.         }
  178.         InputStream is = null;
  179.         try{
  180.             File f = new File(xsdPath);
  181.             if(f.exists()){
  182.                 is = new FileInputStream(f);
  183.             }else{
  184.                 is = cXmlRoot.getResourceAsStream(xsdPath);
  185.                 if(is==null){
  186.                     is = cXmlRoot.getResourceAsStream("/"+xsdPath);
  187.                 }
  188.             }
  189.             if(is==null){
  190.                 throw new Exception("Creating InputStream from xsdPath["+xsdPath+"] failure");
  191.             }
  192.             this.xsdValidator = new ValidatoreXSD(null,is);
  193.         }catch (Exception e) {
  194.             this.log.error("Init xsd schema failure: "+e.getMessage(),e);
  195.             throw new ServiceException("Init xsd schema failure: "+e.getMessage(),e);
  196.         }finally{
  197.             try{
  198.                 if(is!=null){
  199.                     is.close();
  200.                 }
  201.             }catch(Exception eClose){
  202.                 // close
  203.             }
  204.         }

  206.         /* ---- Uunmarshall  ---- */
  207.         this.cXmlRoot = cXmlRoot;
  208.         this.deserializer = deserializer;

  210.         this.parsingXML();
  211.     }
  212.     
  213.     public void refreshXML() throws ServiceException{
  214.         refreshXML_engine(false);
  215.     }
  216.     public void refreshXML(boolean forcedWithoutCheckModified) throws ServiceException{
  217.         refreshXML_engine(forcedWithoutCheckModified);
  218.     }
  219.     
  220.     private synchronized void refreshXML_engine(boolean forcedWithoutCheckModified) throws ServiceException{

  222.         File fTest = null;
  223.         boolean refresh = forcedWithoutCheckModified;
  224.         if(forcedWithoutCheckModified==false){
  225.             if(this.xmlPath.startsWith("http://") || this.xmlPath.startsWith("file://")){
  226.                 long now = System.currentTimeMillis();
  227.                 if( (now-this.lastModified) > (AbstractXMLServiceManager.timeoutRefresh*1000) ){
  228.                     refresh=true;
  229.                 }
  230.             }else{
  231.                 fTest = new File(this.xmlPath);
  232.                 if(this.lastModified != fTest.lastModified()){
  233.                     refresh = true;
  234.                 }
  235.             }
  236.         }
  237.         if(refresh){

  239.             try{
  240.                 this.parsingXML();
  241.             }catch(Exception e){
  242.                 this.log.error("Refresh failure: "+e.getMessage(),e);
  243.                 throw new ServiceException("Refresh failure: "+e.getMessage(),e);
  244.             }
  245.             if(this.xmlPath.startsWith("http://")==false && this.xmlPath.startsWith("file://")==false){
  246.                 this.log.warn("Reloaded context.");
  247.             }
  248.             
  249.         }

  251.         if(this.rootXml == null){
  252.             this.log.error("Refresh failure: rootXml is null after the refresh");
  253.             throw new ServiceException("Refresh failure: rootXml is null after the refresh");
  254.         }

  256.     }
  257.     
  258.     public void checkRemoteXML() throws ServiceException{
  259.         if(this.xmlPath.startsWith("http://")){
  260.             throw new ServiceException("You can not use the CRUD service with a remote XML");
  261.         }
  262.     }

  264.     public Logger getLog() {
  265.         return this.log;
  266.     }

  268.     public XML getRootXml() {
  269.         return this.rootXml;
  270.     }

  272.     /* Logger */
  273.     public static void configureDefaultLog4jProperties(IProjectInfo project) throws ServiceException{
  274.         XMLLoggerProperties loggerProperties = new XMLLoggerProperties(project);
  275.         loggerProperties.configureLog4j();
  276.     }
  277.     public static void configureLog4jProperties(File log4jProperties) throws ServiceException{
  278.         XMLLoggerProperties loggerProperties = new XMLLoggerProperties(null,log4jProperties);
  279.         loggerProperties.configureLog4j();
  280.     }
  281. }
Created with JaCoCo 0.8.8.202204050719