AbstractErrorGenerator.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.pdd.services.error;

  22. import javax.xml.namespace.QName;

  24. import org.apache.commons.lang.StringUtils;
  25. import org.openspcoop2.core.constants.Costanti;
  26. import org.openspcoop2.core.constants.TipoPdD;
  27. import org.openspcoop2.core.id.IDServizio;
  28. import org.openspcoop2.core.id.IDSoggetto;
  29. import org.openspcoop2.message.OpenSPCoop2Message;
  30. import org.openspcoop2.message.OpenSPCoop2MessageFactory;
  31. import org.openspcoop2.message.config.ConfigurationRFC7807;
  32. import org.openspcoop2.message.config.FaultBuilderConfig;
  33. import org.openspcoop2.message.config.IntegrationErrorCollection;
  34. import org.openspcoop2.message.config.IntegrationErrorConfiguration;
  35. import org.openspcoop2.message.config.IntegrationErrorReturnConfiguration;
  36. import org.openspcoop2.message.constants.IntegrationError;
  37. import org.openspcoop2.message.constants.MessageType;
  38. import org.openspcoop2.message.constants.ServiceBinding;
  39. import org.openspcoop2.pdd.config.OpenSPCoop2Properties;
  40. import org.openspcoop2.pdd.logger.OpenSPCoop2Logger;
  41. import org.openspcoop2.protocol.sdk.Context;
  42. import org.openspcoop2.protocol.sdk.IProtocolFactory;
  43. import org.openspcoop2.protocol.sdk.ProtocolException;
  44. import org.openspcoop2.protocol.sdk.constants.IntegrationFunctionError;
  45. import org.openspcoop2.protocol.sdk.state.RequestInfo;
  46. import org.openspcoop2.protocol.utils.ErroriProperties;
  47. import org.slf4j.Logger;


  50. /**
  51.  * RequestInfo
  52.  *
  53.  * @author Poli Andrea (apoli@link.it)
  54.  * @author $Author$
  55.  * @version $Rev$, $Date$
  56.  */
  57. public abstract class AbstractErrorGenerator {

  59.     protected boolean internalErrorConfiguration;
  60.     
  61.     protected Logger log;
  62.     protected IProtocolFactory<?> protocolFactory;
  63.     public IProtocolFactory<?> getProtocolFactory() {
  64.         return this.protocolFactory;
  65.     }
  66.     protected String idModulo;
  67.     protected IDSoggetto identitaPdD;
  68.     
  69.     protected IDSoggetto mittente;
  70.     protected IDServizio idServizio;
  71.     protected String servizioApplicativo;
  72.     
  73.     protected OpenSPCoop2Properties openspcoopProperties;
  74.     protected RequestInfo requestInfo;
  75.     protected MessageType requestMessageType;
  76.     protected ServiceBinding serviceBinding;
  77.     
  78.     protected TipoPdD tipoPdD;
  79.     public void updateTipoPdD(TipoPdD tipoPdD) {
  80.         this.tipoPdD = tipoPdD;
  81.     }
  82.     
  83.     protected MessageType forceMessageTypeResponse;
  84.     public void setForceMessageTypeResponse(MessageType forceMessageTypeResponse) {
  85.         this.forceMessageTypeResponse = forceMessageTypeResponse;
  86.     }
  87.     
  88.     protected AbstractErrorGenerator(Logger log, String idModulo, RequestInfo requestInfo,
  89.             TipoPdD tipoPdD, boolean internalErrorConfiguration) throws ProtocolException{
  90.         this.log = log;
  91.         this.protocolFactory = requestInfo.getProtocolFactory();
  92.         this.idModulo = idModulo;
  93.         this.identitaPdD = requestInfo.getIdentitaPdD();
  94.         
  95.         this.openspcoopProperties = OpenSPCoop2Properties.getInstance();
  96.         
  97.         this.requestInfo = requestInfo;
  98.         
  99.         this.tipoPdD = tipoPdD;
  100.         
  101.         this.internalErrorConfiguration = internalErrorConfiguration;
  102.         
  103.         if(TipoPdD.APPLICATIVA.equals(tipoPdD)){
  104.             this.requestMessageType = requestInfo.getProtocolRequestMessageType();
  105.             this.serviceBinding = requestInfo.getProtocolServiceBinding();
  106.         }
  107.         else{
  108.             this.requestMessageType = requestInfo.getIntegrationRequestMessageType();
  109.             this.serviceBinding = requestInfo.getIntegrationServiceBinding();
  110.         }
  111.     }
  112.     
  113.     protected String getInterfaceName() {
  114.         String nomePorta = null;
  115.         if(this.requestInfo!=null && this.requestInfo.getProtocolContext()!=null) {
  116.             nomePorta = this.requestInfo.getProtocolContext().getInterfaceName();
  117.         }
  118.         return nomePorta;
  119.     }
  120.     
  121.     public void updateRequestMessageType(MessageType requestMessageType){
  122.         this.requestMessageType = requestMessageType;
  123.     }
  124.     
  125.     public void updateServiceBinding(ServiceBinding serviceBinding){
  126.         this.serviceBinding = serviceBinding;
  127.     }
  128.     
  129.     public void updateDominio(IDSoggetto identitaPdD){
  130.         this.identitaPdD = identitaPdD;
  131.     }
  132.     
  133.     public void updateInformazioniCooperazione(IDSoggetto mittente, IDServizio idServizio){
  134.         this.mittente = mittente;
  135.         this.idServizio = idServizio;
  136.     }
  137.     public void updateInformazioniCooperazione(String servizioApplicativo){
  138.         this.servizioApplicativo = servizioApplicativo;
  139.     }
  140.     
  141.     protected IntegrationErrorConfiguration getConfigurationForError(IntegrationError integrationError){
  142.         IntegrationErrorCollection errorCollection = null;
  143.         if(this.internalErrorConfiguration){
  144.             errorCollection = this.requestInfo.getBindingConfig().getInternalIntegrationErrorConfiguration(this.serviceBinding);
  145.         }else{
  146.             errorCollection = this.requestInfo.getBindingConfig().getExternalIntegrationErrorConfiguration(this.serviceBinding);
  147.         }
  148.         IntegrationErrorConfiguration config = errorCollection.getIntegrationError(integrationError);
  149.         if(config==null){
  150.             config = errorCollection.getIntegrationError(IntegrationError.DEFAULT);
  151.         }
  152.         return config;
  153.     }
  154.     protected MessageType getMessageTypeForError(IntegrationError integrationError){
  155.         IntegrationErrorConfiguration config = this.getConfigurationForError(integrationError);
  156.         return config.getMessageType(this.requestInfo.getProtocolContext(), this.serviceBinding, this.requestMessageType);
  157.     }

  159.     protected IntegrationErrorReturnConfiguration getReturnConfigForError(IntegrationError integrationError){
  160.         IntegrationErrorConfiguration config = this.getConfigurationForError(integrationError);
  161.         IntegrationErrorReturnConfiguration configR = config.getErrorReturnConfig();
  162.         boolean portaDelegata = (this instanceof RicezioneContenutiApplicativiInternalErrorGenerator);
  163.         if(portaDelegata) {
  164.             configR.setRetryAfterSeconds(this.openspcoopProperties.getServiceUnavailableRetryAfterSecondsPD());
  165.             configR.setRetryRandomBackoffSeconds(this.openspcoopProperties.getServiceUnavailableRetryAfterSecondsRandomBackoffPD());
  166.         }
  167.         else {
  168.             configR.setRetryAfterSeconds(this.openspcoopProperties.getServiceUnavailableRetryAfterSecondsPA());
  169.             configR.setRetryRandomBackoffSeconds(this.openspcoopProperties.getServiceUnavailableRetryAfterSecondsRandomBackoffPA());
  170.         }
  171.         return configR;
  172.     }
  173.     
  174.     protected boolean isUseInternalFault(IntegrationError integrationError){
  175.         IntegrationErrorConfiguration config = this.getConfigurationForError(integrationError);
  176.         return config.isUseInternalFault();
  177.     }
  178.     
  179.     protected ConfigurationRFC7807 getRfc7807ForError(IntegrationError integrationError){
  180.         IntegrationErrorConfiguration config = this.getConfigurationForError(integrationError);
  181.         return config.getRfc7807();
  182.     }

  184.     protected MessageType getMessageTypeForErrorSafeMode(IntegrationError integrationError){
  185.         MessageType msgTypeErrorResponse = null;
  186.         try{
  187.             msgTypeErrorResponse = this.requestMessageType;
  188.             if(this.forceMessageTypeResponse!=null){
  189.                 msgTypeErrorResponse = this.forceMessageTypeResponse;
  190.             }
  191.             else{
  192.                 msgTypeErrorResponse = getMessageTypeForError(integrationError);
  193.             }
  194.         }catch(Exception eError){
  195.             // non dovrebbero avvenire errori, altrimenti si utilizza il message type della richiesta 
  196.         }
  197.         return msgTypeErrorResponse;
  198.     }
  199.     
  200.     protected ConfigurationRFC7807 getRfc7807ForErrorSafeMode(IntegrationError integrationError){
  201.         ConfigurationRFC7807 rfc7807 = null;
  202.         try{
  203.             rfc7807 = getRfc7807ForError(integrationError);
  204.         }catch(Exception eError){
  205.             // non dovrebbero avvenire errori, altrimenti si utilizza il message type della richiesta 
  206.         }
  207.         return rfc7807;
  208.     }
  209.     
  210.     public static IntegrationFunctionError getIntegrationInternalError(Context context) {
  211.         IntegrationFunctionError integrationError = IntegrationFunctionError.INTERNAL_REQUEST_ERROR;
  212.         if(context!=null && context.containsKey(Costanti.RICHIESTA_INOLTRATA_BACKEND)) {
  213.             Object o = context.getObject(Costanti.RICHIESTA_INOLTRATA_BACKEND);
  214.             if(o!=null && o instanceof String) {
  215.                 String s = (String) o;
  216.                 if(Costanti.RICHIESTA_INOLTRATA_BACKEND_VALORE.equals(s)) {
  217.                     integrationError = IntegrationFunctionError.INTERNAL_RESPONSE_ERROR;
  218.                 }
  219.             }
  220.         }
  221.         return integrationError;
  222.     }
  223.     
  224.     private FaultBuilderConfig getFaultBuilderConfig(ErroriProperties erroriProperties, IntegrationFunctionError integrationFunctionError, 
  225.             MessageType msgTypeErrorResponse, boolean useProblemRFC7807, String errore) {
  226.         try {
  227.             FaultBuilderConfig config = new FaultBuilderConfig();
  228.             IntegrationError integrationError = erroriProperties.getIntegrationError(integrationFunctionError);
  229.             IntegrationErrorReturnConfiguration returnConfig = this.getReturnConfigForError(integrationError);
  230.             
  231.             config.setHttpReturnCode(returnConfig.getHttpReturnCode());
  232.             config.setGovwayReturnCode(returnConfig.getGovwayReturnCode());
  233.             
  234.             config.setRfc7807Type(erroriProperties.isTypeEnabled());
  235.             config.setRfc7807WebSite(erroriProperties.getWebSite(integrationFunctionError));
  236.             
  237.             if(MessageType.SOAP_11.equals(msgTypeErrorResponse) || MessageType.SOAP_12.equals(msgTypeErrorResponse) || !useProblemRFC7807) {
  238.                 config.setActor(this.openspcoopProperties.getProprietaGestioneErrorePD(this.protocolFactory.createProtocolManager()).getFaultActor());
  239.             }
  240.             
  241.             String codiceEccezioneGW = org.openspcoop2.protocol.basic.Costanti.getTransactionSoapFaultCode(returnConfig.getGovwayReturnCode(),erroriProperties.getErrorType(integrationFunctionError));
  242.             if(MessageType.SOAP_11.equals(msgTypeErrorResponse) || MessageType.SOAP_12.equals(msgTypeErrorResponse)) {
  243.                 if(MessageType.SOAP_11.equals(msgTypeErrorResponse)) {
  244.                     String code11 = org.openspcoop2.message.constants.Costanti.SOAP11_FAULT_CODE_SERVER;
  245.                     if(returnConfig.getGovwayReturnCode()<=499) {
  246.                         code11 = org.openspcoop2.message.constants.Costanti.SOAP11_FAULT_CODE_CLIENT;
  247.                     }
  248.                     codiceEccezioneGW = code11 +
  249.                             org.openspcoop2.message.constants.Costanti.SOAP11_FAULT_CODE_SEPARATOR+codiceEccezioneGW;
  250.                 }
  251.                 QName eccezioneNameGovway = null;
  252.                 if(MessageType.SOAP_11.equals(msgTypeErrorResponse)) {
  253.                     String prefix = "SOAP-ENV";
  254.                     eccezioneNameGovway = new QName(org.openspcoop2.message.constants.Costanti.SOAP_ENVELOPE_NAMESPACE, codiceEccezioneGW, prefix);
  255.                     config.setPrefixSoap(prefix);
  256.                 }
  257.                 else {
  258.                     eccezioneNameGovway = this.getProtocolFactory().createErroreApplicativoBuilder().getQNameEccezioneIntegrazione(this.openspcoopProperties.getProprietaGestioneErrorePD(this.protocolFactory.createProtocolManager()).getDefaultFaultCodeIntegrationNamespace(),
  259.                             codiceEccezioneGW);
  260.                 }
  261.                 config.setErrorCode(eccezioneNameGovway);
  262.             }
  263.             
  264.             boolean genericDetails = returnConfig.isGenericDetails();
  265.             if(!genericDetails && erroriProperties.isForceGenericDetails(integrationFunctionError)) {
  266.                 genericDetails = true;
  267.             }
  268.             if (org.openspcoop2.protocol.basic.Costanti.isTRANSACTION_FORCE_SPECIFIC_ERROR_DETAILS()) {
  269.                 genericDetails = false;
  270.             }
  271.             if(errore!=null && !"null".equals(errore) && !genericDetails) {
  272.                 config.setDetails(errore);
  273.             }
  274.             else {
  275.                 config.setDetails(erroriProperties.getGenericDetails(integrationFunctionError));
  276.             }
  277.             
  278.             String govwayType = erroriProperties.getErrorType(integrationFunctionError);
  279.             config.setHeaderErrorTypeName(this.openspcoopProperties.getErroriHttpHeaderGovWayType());
  280.             config.setHeaderErrorTypeValue(govwayType);
  281.             
  282.             if(org.openspcoop2.protocol.basic.Costanti.isPROBLEM_RFC7807_ENRICH_TITLE_AS_GOVWAY_TYPE()) {
  283.                 if(org.openspcoop2.protocol.basic.Costanti.isPROBLEM_RFC7807_ENRICH_TITLE_AS_GOVWAY_TYPE_CAMEL_CASE_DECODE()) {
  284.                     config.setRfc7807Title(StringUtils.join(
  285.                              StringUtils.splitByCharacterTypeCamelCase(govwayType),
  286.                              ' '));
  287.                 }
  288.                 else {
  289.                     config.setRfc7807Title(govwayType);
  290.                 }
  291.                 
  292.                 if(org.openspcoop2.protocol.basic.Costanti.isPROBLEM_RFC7807_ENRICH_TITLE_AS_GOVWAY_TYPE_CUSTOM_CLAIM()) {
  293.                     config.setRfc7807GovWayTypeHeaderErrorTypeName(org.openspcoop2.protocol.basic.Costanti.getPROBLEM_RFC7807_GOVWAY_TYPE());
  294.                     config.setRfc7807GovWayTypeHeaderErrorTypeValue(govwayType);
  295.                 }
  296.             }
  297.             else {
  298.                 config.setRfc7807GovWayTypeHeaderErrorTypeName(org.openspcoop2.protocol.basic.Costanti.getPROBLEM_RFC7807_GOVWAY_TYPE());
  299.                 config.setRfc7807GovWayTypeHeaderErrorTypeValue(govwayType);
  300.             }
  301.             
  302.             return config;
  303.         }catch(Throwable t) {
  304.             OpenSPCoop2Logger.getLoggerOpenSPCoopCore().error("FaultBuilderConfig non costruibile: "+t.getMessage(),t);
  305.             return null;
  306.         }
  307.     }
  308.     
  309.     protected IntegrationError convertToIntegrationError(IntegrationFunctionError integrationFunctionError) {
  310.         ErroriProperties erroriProperties = null;
  311.         IntegrationError integrationError = null;
  312.         try {
  313.             erroriProperties = ErroriProperties.getInstance(this.log);
  314.             integrationError = erroriProperties.getIntegrationError(integrationFunctionError);
  315.         }catch(Throwable t) {
  316.             integrationError = IntegrationError.INTERNAL_REQUEST_ERROR;
  317.         }
  318.         return integrationError;
  319.     }
  320.     
  321.     public OpenSPCoop2Message buildFault(Throwable e, Context context){
  322.         IntegrationFunctionError integrationFunctionError = getIntegrationInternalError(context);
  323.         return _buildFault(e, context, integrationFunctionError);
  324.     }
  325.     public OpenSPCoop2Message buildFault(Throwable e, Context context, IntegrationFunctionError integrationFunctionError){
  326.         return _buildFault(e, context, integrationFunctionError);
  327.     }
  328.     public OpenSPCoop2Message _buildFault(Throwable e, Context context, IntegrationFunctionError integrationFunctionError){
  329.         //this.log.error(e.getMessage(),e);
  330.         ErroriProperties erroriProperties = null;
  331.         IntegrationError integrationError = null;
  332.         try {
  333.             erroriProperties = ErroriProperties.getInstance(this.log);
  334.             integrationError = erroriProperties.getIntegrationError(integrationFunctionError);
  335.         }catch(Throwable t) {
  336.             integrationError = IntegrationError.INTERNAL_REQUEST_ERROR;
  337.         }
  338.         boolean useProblemRFC7807 = this.getRfc7807ForErrorSafeMode(integrationError)!=null;
  339.         MessageType msgTypeErrorResponse = this.getMessageTypeForErrorSafeMode(integrationError);
  340.         FaultBuilderConfig config = null;
  341.         if(erroriProperties!=null) {
  342.             config = getFaultBuilderConfig(erroriProperties, integrationFunctionError, msgTypeErrorResponse, useProblemRFC7807, e!=null ? e.getMessage() : null);
  343.         }
  344.         OpenSPCoop2Message msgFault = OpenSPCoop2MessageFactory.getDefaultMessageFactory().createFaultMessage(msgTypeErrorResponse, useProblemRFC7807, config, e);
  345.         return msgFault;
  346.     }
  347.     

  349.     public OpenSPCoop2Message buildFault(String errore, Context context){
  350.         IntegrationFunctionError integrationFunctionError = getIntegrationInternalError(context);
  351.         return _buildFault(errore, context, integrationFunctionError);
  352.     }
  353.     public OpenSPCoop2Message buildFault(String errore, Context context, IntegrationFunctionError integrationFunctionError){
  354.         return _buildFault(errore, context, integrationFunctionError);
  355.     }
  356.     
  357.     private OpenSPCoop2Message _buildFault(String errore, Context context, IntegrationFunctionError integrationFunctionError){
  358.         //this.log.error(errore);
  359.         ErroriProperties erroriProperties = null;
  360.         IntegrationError integrationError = null;
  361.         try {
  362.             erroriProperties = ErroriProperties.getInstance(this.log);
  363.             integrationError = erroriProperties.getIntegrationError(integrationFunctionError);
  364.         }catch(Throwable t) {
  365.             integrationError = IntegrationError.INTERNAL_REQUEST_ERROR;
  366.             integrationFunctionError = IntegrationFunctionError.INTERNAL_REQUEST_ERROR;
  367.         }
  368.         boolean useProblemRFC7807 = this.getRfc7807ForErrorSafeMode(integrationError)!=null;
  369.         MessageType msgTypeErrorResponse = this.getMessageTypeForErrorSafeMode(integrationError);
  370.         FaultBuilderConfig config = null;
  371.         if(erroriProperties!=null) {
  372.             config = getFaultBuilderConfig(erroriProperties, integrationFunctionError, msgTypeErrorResponse, useProblemRFC7807, errore);
  373.         }
  374.         OpenSPCoop2Message msgFault = OpenSPCoop2MessageFactory.getDefaultMessageFactory().createFaultMessage(msgTypeErrorResponse, useProblemRFC7807, config, errore);
  375.         return msgFault;
  376.     }
  377. }
Created with JaCoCo 0.8.8.202204050719