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

  21. package org.openspcoop2.pdd.services.connector;

  23. import java.io.IOException;
  24. import java.util.Enumeration;

  26. import javax.servlet.http.HttpServletRequest;
  27. import javax.servlet.http.HttpServletResponse;

  29. import org.apache.commons.lang.StringEscapeUtils;
  30. import org.openspcoop2.message.config.ServiceBindingConfiguration;
  31. import org.openspcoop2.message.constants.MessageType;
  32. import org.openspcoop2.message.constants.ServiceBinding;
  33. import org.openspcoop2.message.exception.MessageException;
  34. import org.openspcoop2.pdd.config.OpenSPCoop2Properties;
  35. import org.openspcoop2.pdd.core.CostantiPdD;
  36. import org.openspcoop2.pdd.logger.OpenSPCoop2Logger;
  37. import org.openspcoop2.protocol.engine.ProtocolFactoryManager;
  38. import org.openspcoop2.protocol.engine.URLProtocolContextImpl;
  39. import org.openspcoop2.protocol.manifest.Context;
  40. import org.openspcoop2.protocol.sdk.IProtocolFactory;
  41. import org.openspcoop2.protocol.sdk.ProtocolException;
  42. import org.openspcoop2.protocol.sdk.config.IProtocolConfiguration;
  43. import org.openspcoop2.protocol.sdk.constants.IDService;
  44. import org.openspcoop2.protocol.sdk.state.RequestInfo;
  45. import org.openspcoop2.protocol.sdk.state.URLProtocolContext;
  46. import org.openspcoop2.utils.LoggerWrapperFactory;
  47. import org.openspcoop2.utils.resources.MapReader;
  48. import org.openspcoop2.utils.transport.http.ContentTypeUtilities;
  49. import org.openspcoop2.utils.transport.http.HttpConstants;
  50. import org.openspcoop2.utils.transport.http.HttpRequestMethod;
  51. import org.slf4j.Logger;

  53. /**
  54.  * ConnectorUtils
  55.  *
  56.  * @author Poli Andrea (apoli@link.it)
  57.  * @author $Author$
  58.  * @version $Rev$, $Date$
  59.  */
  60. public class ConnectorUtils {

  62.     public static Logger getErrorLog(){
  63.         Logger log = OpenSPCoop2Logger.getLoggerOpenSPCoopCore();
  64.         if(log == null){
  65.             log = LoggerWrapperFactory.getLogger(ConnectorUtils.class);
  66.         }
  67.         return log;
  68.     }
  69.     
  70.     public static RequestInfo getRequestInfo(IProtocolFactory<?> pf,URLProtocolContext protocolContext) throws ProtocolException, MessageException{
  71.         
  72.         OpenSPCoop2Properties op2Properties = OpenSPCoop2Properties.getInstance();
  73.         IProtocolConfiguration pc = pf.createProtocolConfiguration();
  74.         
  75.         ServiceBindingConfiguration bindingConfig = pc.getDefaultServiceBindingConfiguration(protocolContext);
  76.         ServiceBinding integrationServiceBinding = bindingConfig.getDefaultBinding();
  77.         
  78.         ServiceBinding protocolServiceBinding = pc.getProtocolServiceBinding(integrationServiceBinding, protocolContext);
  79.                 
  80.         ServiceBinding serviceBindingDaUtilizzare = integrationServiceBinding;
  81.         boolean pa = false;
  82.         if(protocolContext.isPortaApplicativaService()) {
  83.             serviceBindingDaUtilizzare = protocolServiceBinding;
  84.             pa = true;
  85.         }
  86.         
  87.         String ct = null;
  88.         try {
  89.             ct = protocolContext.getContentType();
  90.             if(ct!=null && !"".equals(ct)) {
  91.                 //(new ContentType(ct)).getBaseType();
  92.                 ContentTypeUtilities.validateContentType(ct);
  93.             }
  94.         }catch(Throwable e) {
  95.             // valido content type ricevuto; eventuale tipo non correto verrà segnalato in seguito
  96.             ct = null;
  97.         }
  98.         
  99.         MessageType requestMessageType = bindingConfig.getRequestMessageType(serviceBindingDaUtilizzare, 
  100.                 protocolContext, ct);
  101.         
  102.         RequestInfo requestInfo = new RequestInfo();
  103.         requestInfo.setProtocolContext(protocolContext);
  104.         requestInfo.setProtocolFactory(pf);
  105.         if(pa){
  106.             requestInfo.setProtocolRequestMessageType(requestMessageType);
  107.         }
  108.         else{
  109.             requestInfo.setIntegrationRequestMessageType(requestMessageType);
  110.         }
  111.         requestInfo.setProtocolServiceBinding(protocolServiceBinding);
  112.         requestInfo.setIntegrationServiceBinding(integrationServiceBinding);
  113.         requestInfo.setBindingConfig(bindingConfig);
  114.         requestInfo.setIdentitaPdD(op2Properties!=null ? op2Properties.getIdentitaPortaDefault(pf.getProtocol(), requestInfo) : null );
  115.         
  116.         return requestInfo;
  117.     }
  118.     
  119.     public static String getMessageHttpMethodNotSupported(HttpRequestMethod method){
  120.         return ConnectorCostanti.MESSAGE_METHOD_HTTP_NOT_SUPPORTED.replace(ConnectorCostanti.KEYWORD_METHOD_HTTP, method.name());
  121.     }
  122.     
  123.     public static String getMessageServiceBindingNotSupported(ServiceBinding serviceBinding){
  124.         return ConnectorCostanti.MESSAGE_SERVICE_BINDING_NOT_SUPPORTED.replace(ConnectorCostanti.KEYWORD_SERVICE_BINDING, serviceBinding.name());
  125.     }
  126.     
  127.     private static StringBuilder getPrefixCode(IDService idService) {
  128.         
  129.         Logger log = OpenSPCoop2Logger.getLoggerOpenSPCoopCore();
  130.         if(log==null){
  131.             log = OpenSPCoop2Logger.getLoggerOpenSPCoopConsole();
  132.         }
  133.         if(log==null){
  134.             log = LoggerWrapperFactory.getLogger(ConnectorUtils.class);
  135.         }
  136.         
  137.         StringBuilder bf = new StringBuilder();
  138.         try{
  139.             bf.append(idService.getCode()).append(ConnectorCostanti.SEPARATOR_CODE);
  140.         }catch(Exception e){
  141.             log.error(e.getMessage(),e);
  142.             bf = new StringBuilder();
  143.             bf.append(ConnectorCostanti.ID_ERRORE_GENERICO);
  144.         }
  145.         return bf;
  146.     }
  147.     
  148.     public static String getFullCodeGovWayNotInitialized(IDService idService) {
  149.         StringBuilder bf = getPrefixCode(idService);
  150.         bf.append(ConnectorCostanti.GOVWAY_NOT_INITIALIZED);
  151.         return bf.toString();
  152.     }
  153.     
  154.     public static String getFullCodeProtocolUnsupported(IDService idService) {
  155.         StringBuilder bf = getPrefixCode(idService);
  156.         bf.append(ConnectorCostanti.CODE_PROTOCOL_NOT_SUPPORTED);
  157.         return bf.toString();
  158.     }
  159.     
  160.     public static String getFullCodeWsdlUnsupported(IDService idService) {
  161.         StringBuilder bf = getPrefixCode(idService);
  162.         bf.append(ConnectorCostanti.CODE_WSDL_UNSUPPORTED);
  163.         return bf.toString();
  164.     }
  165.     public static String getFullCodeWsdlNotDefined(IDService idService) {
  166.         StringBuilder bf = getPrefixCode(idService);
  167.         bf.append(ConnectorCostanti.CODE_WSDL_NOT_DEFINED);
  168.         return bf.toString();
  169.     }
  170.     
  171.     public static String getFullCodeEngineFilter(IDService idService) {
  172.         StringBuilder bf = getPrefixCode(idService);
  173.         bf.append(ConnectorCostanti.CODE_ENGINE_FILTER);
  174.         return bf.toString();
  175.     }
  176.     
  177.     public static String getFullCodeFunctionUnsupported(IDService idService) {
  178.         StringBuilder bf = getPrefixCode(idService);
  179.         bf.append(ConnectorCostanti.CODE_FUNCTION_UNSUPPORTED);
  180.         return bf.toString();
  181.     }
  182.     
  183.     public static String getFullCodeHttpMethodNotSupported(IDService idService, HttpRequestMethod method) {
  184.         StringBuilder bf = getPrefixCode(idService);
  185.         switch (method) {
  186.         case GET:
  187.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_GET_UNSUPPORTED);
  188.             break;
  189.         case POST:
  190.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_POST_UNSUPPORTED);
  191.             break;
  192.         case PUT:
  193.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_PUT_UNSUPPORTED);
  194.             break;
  195.         case HEAD:
  196.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_HEAD_UNSUPPORTED);
  197.             break;
  198.         case DELETE:
  199.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_DELETE_UNSUPPORTED);
  200.             break;
  201.         case OPTIONS:
  202.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_OPTIONS_UNSUPPORTED);
  203.             break;
  204.         case TRACE:
  205.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_TRACE_UNSUPPORTED);
  206.             break;
  207.         case PATCH:
  208.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_PATCH_UNSUPPORTED);
  209.             break;
  210.         case LINK:
  211.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_LINK_UNSUPPORTED);
  212.             break;
  213.         case UNLINK:
  214.             bf.append(ConnectorCostanti.CODE_HTTP_METHOD_UNLINK_UNSUPPORTED);
  215.             break;
  216.         }
  217.         return bf.toString();
  218.     }
  219.     
  220.     public static String getFullCodeServiceBindingNotSupported(IDService idService, ServiceBinding serviceBinding) {
  221.         StringBuilder bf = getPrefixCode(idService);
  222.         switch (serviceBinding) {
  223.         case SOAP:
  224.             bf.append(ConnectorCostanti.CODE_SERVICE_BINDING_SOAP_UNSUPPORTED);
  225.             break;
  226.         case REST:
  227.             bf.append(ConnectorCostanti.CODE_SERVICE_BINDING_REST_UNSUPPORTED);
  228.             break;
  229.         }
  230.         return bf.toString();
  231.     }
  232.     
  233.     
  234.     public static String generateError404Message(String code){
  235.         return "GovWay-"+code;
  236.     }
  237.     
  238.     public static void generateErrorMessage(IDService idService, HttpRequestMethod httpMethod,
  239.             HttpServletRequest req, HttpServletResponse res, String msgErrore, boolean erroreGenerale, boolean htmlMessage) throws IOException{
  240.         generateErrorMessage(idService, httpMethod, req, res, msgErrore, erroreGenerale, htmlMessage, null);
  241.     }
  242.     public static void generateErrorMessage(IDService idService, HttpRequestMethod httpMethod,
  243.             HttpServletRequest req, StringBuilder log, String msgErrore, boolean erroreGenerale, boolean htmlMessage) throws IOException{
  244.         generateErrorMessage(idService, httpMethod, req, null, msgErrore, erroreGenerale, htmlMessage, log);
  245.     }
  246.     private static void generateErrorMessage(IDService idService, HttpRequestMethod httpMethod,
  247.             HttpServletRequest req, HttpServletResponse response, String msgErrore, boolean erroreGenerale, boolean htmlMessage, StringBuilder log) throws IOException{
  248.         
  249.         Logger logCore = OpenSPCoop2Logger.getLoggerOpenSPCoopCore();
  250.         OpenSPCoop2Properties op2Properties = OpenSPCoop2Properties.getInstance();
  251.         
  252.         
  253.         
  254.         // versione
  255.         String versione = CostantiPdD.OPENSPCOOP2_PRODUCT_VERSION;
  256.         if(op2Properties!=null){
  257.             versione = op2Properties.getPddDetailsForServices();
  258.         }
  259.         if(htmlMessage){
  260.             versione = StringEscapeUtils.escapeHtml(versione);
  261.             if(response!=null)
  262.                 response.setContentType(HttpConstants.CONTENT_TYPE_HTML);
  263.         }
  264.         else{
  265.             if(response!=null)
  266.                 response.setContentType(HttpConstants.CONTENT_TYPE_PLAIN);
  267.         }

  269.         
  270.         // produzione Body
  271.         boolean doBody = !HttpRequestMethod.HEAD.equals(httpMethod);
  272.         if(!doBody){
  273.             if(log!=null){
  274.                 log.append(CostantiPdD.HEADER_HTTP_X_PDD).append("=").append(versione);
  275.                 log.append(CostantiPdD.HEADER_HTTP_X_PDD_DETAILS).append("=").append(msgErrore);
  276.             }
  277.             else{
  278.                 response.setHeader(CostantiPdD.HEADER_HTTP_X_PDD, versione);
  279.                 response.setHeader(CostantiPdD.HEADER_HTTP_X_PDD_DETAILS, msgErrore);
  280.                 response.setContentLength(0);
  281.             }
  282.             return;
  283.         }
  284.         
  285.         StringBuilder risposta = new StringBuilder();
  286.         risposta.append("<html>\n");
  287.         risposta.append("<head>\n");
  288.         risposta.append("<title>"+versione+"</title>\n");
  289.         risposta.append("</head>\n");
  290.         risposta.append("<body>\n");
  291.         
  292.         risposta.append("<h1>"+versione+"</h1>\n");
  293.             
  294.         // url
  295.         String function = null;
  296.         String parameters = null;
  297.         try{
  298.             URLProtocolContext protocolContext = new URLProtocolContextImpl(req, logCore, true, (op2Properties!=null ? op2Properties.getCustomContexts() : null));
  299.             String url = protocolContext.getUrlInvocazione_formBased();
  300.             if(url.endsWith("?wsdl=")){
  301.                 // richiesta di un wsdl
  302.                 url = url.substring(0, url.length()-"=".length());
  303.             }
  304.             if(htmlMessage){
  305.                 url = StringEscapeUtils.escapeHtml( url );
  306.             }
  307.             risposta.append("<p>" +url+"</p>\n");
  308.             function = protocolContext.getFunction();
  309.             parameters = protocolContext.getFunctionParameters();
  310.         }catch(Exception e){
  311.             if(logCore==null){
  312.                 LoggerWrapperFactory.getLogger(ConnectorUtils.class).error(e.getMessage(),e);
  313.             }else{
  314.                 logCore.error(e.getMessage(),e);
  315.             }
  316.             String context = req.getContextPath();
  317.             if(htmlMessage){
  318.                 context = StringEscapeUtils.escapeHtml( context );
  319.             }
  320.             risposta.append("<p>" +context+"</p>\n");
  321.         }

  323.         // errore
  324.         String errore = msgErrore;
  325.         if(htmlMessage){
  326.             errore = StringEscapeUtils.escapeHtml(errore);
  327.         }
  328.         risposta.append("<p>"+errore+"</p>\n"); 
  329.         
  330.         
  331.         // other infos
  332.         switch (idService) {
  333.         case PORTA_DELEGATA:
  334.             risposta.append("<i>Servizio utilizzabile per l'invocazione delle fruizioni esposte dall'API Gateway GovWay</i><br/><br/>\n");
  335.             break;
  336.         case PORTA_APPLICATIVA:
  337.             risposta.append("<i>Servizio utilizzabile per l'invocazione delle erogazioni esposte dall'API Gateway GovWay</i><br/><br/>\n");
  338.             break;
  339.         case PORTA_DELEGATA_XML_TO_SOAP:
  340.             risposta.append("<i>Servizio utilizzabile per l'invocazione delle fruizioni esposte dall'API Gateway GovWay, con messaggi xml non imbustati nel protocollo SOAP</i><br/><br/>\n");
  341.             break;
  342.         case INTEGRATION_MANAGER_SOAP:
  343.             if(parameters==null){
  344.                 risposta.append("<i>Servizio IntegrationManager</i><br/><br/>\n");
  345.             }
  346.             else if( (function+"/"+parameters).equals(URLProtocolContext.IntegrationManager_FUNCTION_PD) ){
  347.                 risposta.append("<i>Servizio utilizzabile per l'invocazione delle fruizioni esposte dall'API Gateway GovWay</i><br/><br/>\n");
  348.             }
  349.             else if( (function+"/"+parameters).startsWith(URLProtocolContext.IntegrationManager_FUNCTION_PD+"/") ){
  350.                 risposta.append("<i>Servizio utilizzabile per l'invocazione delle fruizioni esposte dall'API Gateway GovWay</i><br/><br/>\n");
  351.             }
  352.             else if( (function+"/"+parameters).equals(URLProtocolContext.IntegrationManager_FUNCTION_MessageBox) ){
  353.                 risposta.append("<i>Servizio utilizzabile per accedere alla MessageBox esposta dall'API Gateway GovWay</i><br/><br/>\n");
  354.             }
  355.             else if( (function+"/"+parameters).startsWith(URLProtocolContext.IntegrationManager_FUNCTION_MessageBox+"/") ){
  356.                 risposta.append("<i>Servizio utilizzabile per accedere alla MessageBox esposta dall'API Gateway GovWay</i><br/><br/>\n");
  357.             }
  358.             else{
  359.                 risposta.append("<i>Servizio IntegrationManager dell'API Gateway GovWay</i><br/><br/>\n");
  360.             }
  361.             break;
  362.         case CHECK_PDD:
  363.             risposta.append("<i>Servizio utilizzabile per comprendere lo stato di funzionamento dell'API Gateway GovWay</i><br/><br/>\n");
  364.             break;
  365.         case PROXY:
  366.             risposta.append("<i>Servizio utilizzato in installazioni container dell'API Gateway GovWay</i><br/><br/>\n");
  367.             break;
  368.         default:
  369.             if(htmlMessage){
  370.                 // use as
  371.                 String useAs = "Use as http[s]://<server>"+ req.getContextPath()+"/<protocol-context>/<service>[/...]";
  372.                 useAs = StringEscapeUtils.escapeHtml(useAs);
  373.                 risposta.append("<i>"+useAs+"</i><br/>\n");
  374.             }
  375.                 
  376.             // protocolli
  377.             try{
  378.                 MapReader<String, IProtocolFactory<?>> prots = ProtocolFactoryManager.getInstance().getProtocolFactories();
  379.                 if(prots.size()<=0){
  380.                     risposta.append("<i>ERROR: No protocol installed</i><br/>\n");
  381.                 }
  382.                 else{
  383.                     StringBuilder bfProtocols = new StringBuilder();
  384.                     Enumeration<String> keys = prots.keys();
  385.                     while (keys.hasMoreElements()) {
  386.                         String key = (String) keys.nextElement();
  387.                         IProtocolFactory<?> pf = prots.get(key);
  388.                         if(pf.getManifest().getWeb().getEmptyContext()!=null && pf.getManifest().getWeb().getEmptyContext().isEnabled()){
  389.                             if(bfProtocols.length()>0){
  390.                                 bfProtocols.append(", ");
  391.                             }
  392.                             bfProtocols.append("\"\" (protocol:"+key+")");
  393.                         }
  394.                         if(pf.getManifest().getWeb().sizeContextList()>0){
  395.                             for (Context context : pf.getManifest().getWeb().getContextList()) {
  396.                                 if(bfProtocols.length()>0){
  397.                                     bfProtocols.append(", ");
  398.                                 }
  399.                                 bfProtocols.append(context.getName()+" (protocol:"+key+")");
  400.                             }
  401.                         }
  402.                     }
  403.                     String enabledProtocols = "Enabled protocol-contexts: "+bfProtocols.toString();
  404.                     if(htmlMessage){
  405.                         enabledProtocols = StringEscapeUtils.escapeHtml(enabledProtocols);
  406.                     }
  407.                     risposta.append("<i>"+enabledProtocols+"</i><br/>\n");
  408.                 }
  409.             }catch(Exception e){
  410.                 if(logCore==null){
  411.                     LoggerWrapperFactory.getLogger(ConnectorUtils.class).error(e.getMessage(),e);
  412.                 }else{
  413.                     logCore.error(e.getMessage(),e);
  414.                 }
  415.                 risposta.append("<i>ERROR: No protocol installed</i><br/>\n");
  416.             }
  417.             
  418.             if(htmlMessage){
  419.                 // servizi
  420.                 risposta.append("<i>Enabled services: in, out, out/xml2soap, check, IntegrationManager</i><br/><br/>\n");
  421.             
  422.                 // web site
  423.                 risposta.append("<i>Official website: https://govway.org</i><br/><br/>\n");
  424.             }
  425.             break;
  426.         }

  428.             
  429.         risposta.append("</body>\n");
  430.         risposta.append("</html>\n");
  431.         if(log!=null){
  432.             log.append(risposta.toString());
  433.         }else{
  434.             response.getOutputStream().write(risposta.toString().getBytes());
  435.         }
  436.     }
  437.     
  438.     
  439. }
Created with JaCoCo 0.8.8.202204050719