DiagnosticManager.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.utils.logger;

  22. import java.lang.reflect.Method;
  23. import java.text.SimpleDateFormat;
  24. import java.util.ArrayList;
  25. import java.util.Date;
  26. import java.util.List;
  27. import java.util.Map;
  28. import java.util.Properties;

  30. import org.openspcoop2.utils.UtilsException;
  31. import org.openspcoop2.utils.date.DateUtils;
  32. import org.openspcoop2.utils.logger.constants.LowSeverity;
  33. import org.openspcoop2.utils.logger.constants.Severity;

  35. /**
  36.  * DiagnosticManager
  37.  *
  38.  * @author Poli Andrea (apoli@link.it)
  39.  * @author $Author$
  40.  * @version $Rev$, $Date$
  41.  */
  42. public class DiagnosticManager {
  43.         
  44.     private static final String CONTEXT = "context.";
  45.     private static final String DYNAMIC_OBJECT = "object.";
  46.     
  47.     private DiagnosticProperties diagnosticProperties;
  48.     
  49.     private IContext context;
  50.     
  51.     private ILogger loggerForCallback;
  52.     
  53.     protected DiagnosticManager(Properties diagnosticProperties, IContext context, boolean throwExceptionPlaceholderFailedResolution, ILogger loggerForCallback) throws UtilsException{
  54.         this.diagnosticProperties = DiagnosticProperties.getInstance(diagnosticProperties, throwExceptionPlaceholderFailedResolution);
  55.         this.context = context;
  56.         
  57.         this.loggerForCallback = loggerForCallback;

  59.     }
  60.     private DiagnosticManager(){} // for clone
  61.     
  62.     public DiagnosticManager clone(IContext newContext){
  63.         
  64.         DiagnosticManager dmNew = new DiagnosticManager();
  65.         
  66.         dmNew.context = newContext;
  67.         
  68.         dmNew.diagnosticProperties = this.diagnosticProperties.clone();
  69.                 
  70.         dmNew.loggerForCallback = this.loggerForCallback;
  71.         
  72.         return dmNew;
  73.     }
  74.     
  75.     public List<String> getFunctions(){
  76.         List<String> keys = null;
  77.         if(!this.diagnosticProperties.getMappingFunctionToCode().isEmpty()) {
  78.             keys = new ArrayList<>();
  79.             for (String key : this.diagnosticProperties.getMappingFunctionToCode().keySet()) {
  80.                 keys.add(key);
  81.             }
  82.         }
  83.         return keys;
  84.     }
  85.     
  86.     public String getDefaultFunction() {
  87.         return this.diagnosticProperties.getDefaultFunction();
  88.     }
  89.     
  90.     public String getDefaultCode(String function, LowSeverity severity) throws UtilsException{
  91.         if(this.diagnosticProperties.getMappingFunctionToCode().containsKey(function)==false){
  92.             throw new UtilsException("Function ["+function+"] undefined");
  93.         }
  94.         return this.diagnosticProperties.getMappingFunctionToCode().get(function)  + this.diagnosticProperties.getMappingSeverityToCode().get(severity);
  95.     }
  96.     
  97.     public String getCode(String code) throws UtilsException{
  98.         if(this.diagnosticProperties.getMappingFullCodeToFullString().containsKey(code)){
  99.             // è già il codice
  100.             return code;
  101.         }
  102.         if(this.diagnosticProperties.getMappingStringCodeToDiagnostic().containsKey(code)){
  103.             // è un codice stringa, ritorno il codice numerico
  104.             return this.diagnosticProperties.getMappingStringCodeToDiagnostic().get(code).functionCode+this.diagnosticProperties.getMappingStringCodeToDiagnostic().get(code).code;
  105.         }
  106.         throw new UtilsException("Diagnostic with code ["+code+"] undefined");
  107.     }
  108.     
  109.     public String getHumanCode(String code) throws UtilsException{
  110.         if(this.diagnosticProperties.getMappingStringCodeToDiagnostic().containsKey(code)){
  111.             // è già il codice human
  112.             return code;
  113.         }
  114.         if(this.diagnosticProperties.getMappingFullCodeToFullString().containsKey(code)){
  115.             return this.diagnosticProperties.getMappingFullCodeToFullString().get(code);
  116.         }
  117.         throw new UtilsException("Diagnostic with code ["+code+"] undefined");
  118.     }
  119.     
  120.     public Severity getSeverity(String code) throws UtilsException{
  121.         String codeString = null;
  122.         if(this.diagnosticProperties.getMappingFullCodeToFullString().containsKey(code)){
  123.             codeString = this.diagnosticProperties.getMappingFullCodeToFullString().get(code);
  124.         }
  125.         if(codeString==null){
  126.             if(this.diagnosticProperties.getMappingStringCodeToDiagnostic().containsKey(code)){
  127.                 // è gia codice stringa
  128.                 codeString = code;
  129.             }
  130.         }
  131.         if(codeString==null)
  132.             throw new UtilsException("Diagnostic with code ["+code+"] undefined");
  133.         return this.diagnosticProperties.getMappingStringCodeToDiagnostic().get(codeString).severity;
  134.     }
  135.     
  136.     public String getMessage(String code, String ... params) throws UtilsException{
  137.         String codeString = null;
  138.         if(this.diagnosticProperties.getMappingFullCodeToFullString().containsKey(code)){
  139.             codeString = this.diagnosticProperties.getMappingFullCodeToFullString().get(code);
  140.         }
  141.         if(codeString==null){
  142.             if(this.diagnosticProperties.getMappingStringCodeToDiagnostic().containsKey(code)){
  143.                 // è gia codice stringa
  144.                 codeString = code;
  145.             }
  146.         }
  147.         if(codeString==null)
  148.             throw new UtilsException("Diagnostic with code ["+code+"] undefined");
  149.         return this.replacePlaceholders(code, this.diagnosticProperties.getMappingStringCodeToDiagnostic().get(codeString).message,null,params);
  150.     }
  151.     
  152.     public String getMessage(String code, Object o) throws UtilsException{
  153.         String codeString = null;
  154.         if(this.diagnosticProperties.getMappingFullCodeToFullString().containsKey(code)){
  155.             codeString = this.diagnosticProperties.getMappingFullCodeToFullString().get(code);
  156.         }
  157.         if(codeString==null){
  158.             if(this.diagnosticProperties.getMappingStringCodeToDiagnostic().containsKey(code)){
  159.                 // è gia codice stringa
  160.                 codeString = code;
  161.             }
  162.         }
  163.         if(codeString==null)
  164.             throw new UtilsException("Diagnostic with code ["+code+"] undefined");
  165.         return this.replacePlaceholders(code, this.diagnosticProperties.getMappingStringCodeToDiagnostic().get(codeString).message,o);
  166.     }
  167.     
  168.     public String getFunction(String code) throws UtilsException{
  169.         String codeString = null;
  170.         if(this.diagnosticProperties.getMappingFullCodeToFullString().containsKey(code)){
  171.             codeString = this.diagnosticProperties.getMappingFullCodeToFullString().get(code);
  172.         }
  173.         if(codeString==null){
  174.             if(this.diagnosticProperties.getMappingStringCodeToDiagnostic().containsKey(code)){
  175.                 // è gia codice stringa
  176.                 codeString = code;
  177.             }
  178.         }
  179.         if(codeString==null)
  180.             throw new UtilsException("Diagnostic with code ["+code+"] undefined");
  181.         return this.diagnosticProperties.getMappingStringCodeToDiagnostic().get(codeString).functionString;
  182.         
  183.     }
  184.     
  185.     
  186.     private String replacePlaceholders(String diagnostic, String msg, Object dinamycObject, String ... params) throws UtilsException{
  187.         
  188.         /* Potenzialmente N^2   
  189.         String tmp = msg;
  190.         Enumeration<String> keys = this.keywordLogPersonalizzati.keys();
  191.         while(keys.hasMoreElements()){
  192.             String key = keys.nextElement();
  193.             tmp = tmp.replace(key, this.keywordLogPersonalizzati.get(key));
  194.         }
  195.         return tmp;
  196.         */
  197.         
  198.         // Check di esistenza di almeno 2 '${' e }
  199.         if(msg!=null && msg.length()>2){
  200.             int index1 = msg.indexOf("{");
  201.             int index2 = msg.indexOf("}",index1+1);
  202.             if(index1<0 || index2<0){
  203.                 return msg; // non serve il replace
  204.             }
  205.         }
  206.         
  207.         if(msg==null) {
  208.             return msg;
  209.         }
  210.         
  211.         StringBuilder bf = new StringBuilder();
  212.         StringBuilder keyword = new StringBuilder();
  213.         boolean separator = false;
  214.         for(int i=0; i<msg.length(); i++){
  215.             char ch = msg.charAt(i);
  216.             if( ('{' == ch) || ('}' == ch) ){
  217.                 //char separatorChar = ch;
  218.                 if(separator==false){
  219.                     // inizio keyword
  220.                     //keyword.append(separatorChar);
  221.                     separator = true;
  222.                 }
  223.                 else{
  224.                     // fine keyword
  225.                     //keyword.append(separatorChar);
  226.                     String valoreRimpiazzato = this.getValue(diagnostic, keyword.toString(), dinamycObject, params);
  227.                     if(valoreRimpiazzato==null){
  228.                         // keyword non esistente, devo utilizzare l'originale
  229.                         if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  230.                             throw new UtilsException("Placeholder [{"+keyword.toString()+"}] resolution failed");
  231.                         }
  232.                         else{
  233.                             //bf.append("{"+keyword.toString()+"}");
  234.                             bf.append("(???Placeholder ["+"{"+keyword.toString()+"] return null value)");
  235.                         }
  236.                     }else{
  237.                         bf.append(valoreRimpiazzato);
  238.                     }
  239.                     keyword.delete(0, keyword.length());
  240.                     separator=false;
  241.                 }
  242.             }else{
  243.                 if(separator){
  244.                     // sto scrivendo la keyword
  245.                     keyword.append(ch);
  246.                 }else{
  247.                     bf.append(ch);
  248.                 }
  249.             }
  250.         }
  251.         return bf.toString();
  252.     }
  253.     
  254.     private String getValue(String diagnostic, String key, Object dinamycObject, String ... params) throws UtilsException{
  255.         if(key.startsWith(CONTEXT)){
  256.             if(this.context==null){
  257.                 if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  258.                     throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+key+"] required context");
  259.                 }
  260.                 else{
  261.                     return "(???Placeholder ["+key+"] required context)";
  262.                 }
  263.             }
  264.             return this.readValueInObject(diagnostic, this.context, key.substring(CONTEXT.length(), key.length()), key);
  265.         }
  266.         else if(key.startsWith(DYNAMIC_OBJECT)){
  267.             if(dinamycObject==null){
  268.                 if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  269.                     throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+key+"] required dynamic parameter");
  270.                 }
  271.                 else{
  272.                     return "(???Placeholder ["+key+"] required dynamic parameter)";
  273.                 }
  274.             }
  275.             return this.readValueInObject(diagnostic, dinamycObject, key.substring(DYNAMIC_OBJECT.length(), key.length()), key);
  276.         }
  277.         else{
  278.             try{
  279.                 int intValue = Integer.parseInt(key);
  280.                 if(intValue<0){
  281.                     if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  282.                         throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+key+"] unsupported");
  283.                     }
  284.                     else{
  285.                         return "(???Placeholder ["+key+"] unsupported)";
  286.                     }
  287.                 }
  288.                 if(params==null || params.length<=0){
  289.                     if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  290.                         throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+key+"] required parameters");
  291.                     }
  292.                     else{
  293.                         return "(???Placeholder ["+key+"] required parameters)";
  294.                     }
  295.                 }
  296.                 if(intValue>=params.length){
  297.                     if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  298.                         throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+key+"] grather then parameters size:"+params.length);
  299.                     }
  300.                     else{
  301.                         return "(???Placeholder ["+key+"] grather then parameters size:"+params.length+")";
  302.                     }
  303.                 }
  304.                 return params[intValue];
  305.             }catch(Exception e){
  306.                 if(e instanceof UtilsException){
  307.                     throw (UtilsException) e;
  308.                 }
  309.                 else{
  310.                     
  311.                     // provo a chiamare callback
  312.                     try{
  313.                         if(this.loggerForCallback!=null){
  314.                             String value = this.loggerForCallback.getLogParam(key);
  315.                             if(value!=null){
  316.                                 return value;
  317.                             }
  318.                         }
  319.                     }catch(Exception eCallback){
  320.                         if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  321.                             throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+key+"] callback resolution failed: "+eCallback.getMessage(),eCallback);
  322.                         }
  323.                         else{
  324.                             return "(???Placeholder ["+key+"] callback resolution failed: "+eCallback.getMessage()+")";
  325.                         }
  326.                     }
  327.                     
  328.                     if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  329.                         throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+key+"] unsupported: "+e.getMessage(),e);
  330.                     }
  331.                     else{
  332.                         return "(???Placeholder ["+key+"] unsupported: "+e.getMessage()+")";
  333.                     }
  334.                 }
  335.             }
  336.         }
  337.     }
  338.     private String readValueInObject(String diagnostic, Object o,String name, String placeholderOriginale) throws UtilsException{
  339.         //System.out.println("Invocato con oggetto["+o.getClass().getName()+"] nome["+name+"]");
  340.         String fieldName = name;
  341.         String position = null;
  342.         if(name.contains(".")){
  343.             fieldName = name.substring(0, name.indexOf("."));
  344.         }
  345.         String methodName = new String(fieldName);
  346.         if(fieldName.endsWith("]") && fieldName.contains("[")){
  347.             try{
  348.                 position = fieldName.substring(fieldName.indexOf("[")+1,fieldName.length()-1);
  349.                 methodName = fieldName.substring(0, fieldName.indexOf("["));
  350.             }catch(Exception e){
  351.                 if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  352.                     throw new UtilsException("Errore durante l'identificazione del parametro di posizionamento ["+fieldName+"]: "+e.getMessage(),e);
  353.                 }
  354.                 else{
  355.                     return "(???Placeholder ["+placeholderOriginale+"] uncorrect, errore durante l'identificazione del parametro di posizionamento ["+fieldName+"]: "+e.getMessage()+")";
  356.                 }
  357.             }
  358.         }
  359.         //System.out.println("NAME ["+fieldName+"] position["+position+"]");
  360.         String getMethod = "get"+((methodName.charAt(0)+"").toUpperCase());
  361.         if(methodName.length()>1){
  362.             getMethod = getMethod + methodName.substring(1);
  363.         }
  364.         Method m = null;
  365.         try{
  366.             m = o.getClass().getMethod(getMethod);
  367.         }catch(Throwable e){
  368.             if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  369.                 throw new UtilsException("(diagnostic:"+diagnostic+") Method ["+o.getClass().getName()+"."+getMethod+"()] not found: "+e.getMessage(),e);
  370.             }
  371.             else{
  372.                 return "(???Placeholder ["+placeholderOriginale+"] Method ["+o.getClass().getName()+"."+getMethod+"()] not found: "+e.getMessage()+")";
  373.             }
  374.         }
  375.         Object ret = null;
  376.         try{
  377.             ret = m.invoke(o);
  378.         }catch(Throwable e){
  379.             if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  380.                 throw new UtilsException("(diagnostic:"+diagnostic+") Invocation method ["+o.getClass().getName()+"."+getMethod+"()] failed: "+e.getMessage(),e);
  381.             }
  382.             else{
  383.                 return "(???Placeholder ["+placeholderOriginale+"] Invocation method ["+o.getClass().getName()+"."+getMethod+"()] failed: "+e.getMessage()+")";
  384.             }
  385.         }
  386.         if(ret!=null){
  387.             if(ret instanceof List<?> || ret instanceof Map<?,?> || ret instanceof Object[]){
  388.                 if(position==null){
  389.                     if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  390.                         throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object without position");
  391.                     }
  392.                     else{
  393.                         return "(???Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object without position)";
  394.                     }
  395.                 }
  396.                 //System.out.println("ARRAY ["+ret.getClass().getName()+"]");
  397.                 if(ret instanceof List<?> || ret instanceof Object[]){
  398.                     int index = -1;
  399.                     try{
  400.                         index = Integer.parseInt(position);
  401.                     }catch(Exception e){
  402.                         if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  403.                             throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object, wrong position value (not integer?): "+e.getMessage()+" )");
  404.                         }
  405.                         else{
  406.                             return "(???Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object, wrong position value (not integer?): "+e.getMessage()+" )";
  407.                         }
  408.                     }
  409.                     if(ret instanceof List<?>){
  410.                         List<?> list = (List<?>) ret;
  411.                         if(list.size()<=index){
  412.                             if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  413.                                 throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object, wrong position value "+index+" (list size:"+list.size()+") )");
  414.                             }
  415.                             else{
  416.                                 return "(???Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object, wrong position value "+index+" (list size:"+list.size()+") )";
  417.                             }
  418.                         }
  419.                         ret = list.get(index);
  420.                     }
  421.                     else if(ret instanceof Object[]){
  422.                         Object[] arrayObj = (Object[]) ret;
  423.                         if(arrayObj.length<=index){
  424.                             if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  425.                                 throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object, wrong position value "+index+" (array size:"+arrayObj.length+") )");
  426.                             }
  427.                             else{
  428.                                 return "(???Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object, wrong position value "+index+" (array size:"+arrayObj.length+") )";
  429.                             }
  430.                         }
  431.                         ret = arrayObj[index];
  432.                     }
  433.                 }
  434.                 else if(ret instanceof Map<?,?>){
  435.                     Map<?,?> map = (Map<?,?>) ret;
  436.                     if(map.containsKey(position)==false){
  437.                         if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  438.                             throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object, wrong position ["+position+"] not exists as key in map )");
  439.                         }
  440.                         else{
  441.                             return "(???Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return "+ret.getClass().getName()+" object, wrong position ["+position+"] not exists as key in map )";
  442.                         }
  443.                     }
  444.                     ret = map.get(position);
  445.                 }
  446.                 
  447.                 
  448.             }
  449.         }
  450.         if(name.contains(".")){
  451.             if(ret==null){
  452.                 if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  453.                     throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return null object");
  454.                 }
  455.                 else{
  456.                     return "(???Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return null object)";
  457.                 }
  458.             }
  459.             else{
  460.                 return this.readValueInObject(diagnostic, ret, name.substring((fieldName+".").length(), name.length()), placeholderOriginale);
  461.             }
  462.         }
  463.         else{
  464.             // finale
  465.             String finalValue = null;
  466.             if(ret!=null){
  467.                 if(ret instanceof Date){
  468.                     SimpleDateFormat dateformat = DateUtils.getSimpleDateFormatMs();
  469.                     finalValue = dateformat.format((Date)ret);
  470.                 }
  471.                 else if(ret instanceof byte[]){
  472.                     // 1024 = 1K
  473.                      // Visualizzo al massimo 5K
  474.                      int max = 5 * 1024;
  475.                      return org.openspcoop2.utils.Utilities.convertToPrintableText((byte[])ret, max);
  476.                 }
  477.                 else{
  478.                     finalValue = ret.toString();
  479.                 }
  480.             }
  481.             else{
  482.                 if(this.diagnosticProperties.isThrowExceptionPlaceholderFailedResolution()){
  483.                     throw new UtilsException("(diagnostic:"+diagnostic+") Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return null object");
  484.                 }
  485.                 else{
  486.                     return "(???Placeholder ["+placeholderOriginale+"] uncorrect, method ["+o.getClass().getName()+"."+getMethod+"()] return null object)";
  487.                 }
  488.             }
  489.             return finalValue;
  490.         }
  491.     }
  492.     
  493. }

  495. class DiagnosticInfo {
  496.     
  497.     String functionString;
  498.     String functionCode;
  499.     String code;
  500.     Severity severity;
  501.     String message;
  502.     
  503. }
Created with JaCoCo 0.8.8.202204050719