JDBCSqlLogger.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.jdbc.utils;


  23. import java.net.URI;
  24. import java.sql.Timestamp;
  25. import java.text.SimpleDateFormat;
  26. import java.util.Calendar;
  27. import java.util.Date;

  29. import org.openspcoop2.generic_project.beans.IEnumeration;
  30. import org.openspcoop2.utils.Utilities;
  31. import org.openspcoop2.utils.date.DateUtils;

  33. /**
  34.  * JDBCSqlLogger
  35.  * 
  36.  * @author Poli Andrea (apoli@link.it)
  37.  * @author $Author$
  38.  * @version $Rev$, $Date$
  39.  */
  40. public class JDBCSqlLogger {

  42.     private org.slf4j.Logger log = null;
  43.     private SimpleDateFormat dateformat = DateUtils.getDefaultDateTimeFormatter("yyyy-MM-dd HH:mm:ss.SSS");

  45.     /**
  46.      * Costruttore della classe di utilita' per gestire i log sia di debug che di errore delle query effettuate su database
  47.      * 
  48.      * @param log logger
  49.      */
  50.     public JDBCSqlLogger(org.slf4j.Logger log){
  51.         this.log = log;
  52.     }

  54.     /**
  55.      * Messaggio di debug
  56.      * 
  57.      * @param msg messaggio di debug
  58.      */
  59.     public void debug( String msg ) {
  60.         this.log.debug(msg);
  61.     }

  63.     /**
  64.      * Registrazione del comando sql eseguita con livello DEBUG
  65.      * 
  66.      * @param sql comando sql
  67.      */
  68.     public void debugSql( String sql ) {
  69.         if (this.log.isDebugEnabled()) {
  70.             this.log.debug( sqlLog( sql ));
  71.         }
  72.     }

  74.     /**
  75.      * Registrazione del comando sql eseguita con livello DEBUG
  76.      * 
  77.      * @param sql comando sql
  78.      * @param param parametro richiesto dal comando sql
  79.      */
  80.     public void debugSql( String sql, JDBCObject ... param ) {
  81.         if (this.log.isDebugEnabled()) {
  82.             this.log.debug( sqlLog( sql , param ) );
  83.         }
  84.     }
  85.     
  86.     
  87.     /**
  88.      * Messaggio di info
  89.      * 
  90.      * @param msg messaggio di info
  91.      */
  92.     public void info( String msg ) {
  93.         this.log.info(msg);
  94.     }

  96.     /**
  97.      * Registrazione del comando sql eseguita con livello INFO
  98.      * 
  99.      * @param sql comando sql
  100.      */
  101.     public void infoSql( String sql ) {
  102.         if (this.log.isInfoEnabled()) {
  103.             this.log.info( sqlLog( sql ));
  104.         }
  105.     }

  107.     /**
  108.      * Registrazione del comando sql eseguita con livello INFO
  109.      * 
  110.      * @param sql comando sql
  111.      * @param param parametro richiesto dal comando sql
  112.      */
  113.     public void infoSql( String sql, JDBCObject ... param ) {
  114.         if (this.log.isInfoEnabled()) {
  115.             this.log.info( sqlLog( sql , param ) );
  116.         }
  117.     }

  119.     /**
  120.      * Messaggio di errore
  121.      * 
  122.      * @param msg messaggio di errore
  123.      */
  124.     public void error( String msg ) {
  125.         this.log.error(msg );
  126.     }

  128.     /**
  129.      * Messaggio di errore con corrispettiva eccezione
  130.      * 
  131.      * @param msg messaggio di errore 
  132.      * @param t eccezione
  133.      */
  134.     public void error( String msg, Throwable t ) {
  135.         this.log.error(msg, t );
  136.     }

  138.     /**
  139.      * Registrazione del comando sql eseguita con livello ERROR
  140.      * 
  141.      * @param t eccezione
  142.      * @param sql comando sql
  143.      */
  144.     public void errorSql( Throwable t, String sql ) {
  145.         this.log.error( sqlLog( sql ), t );
  146.     }

  148.     /**
  149.      * Registrazione del comando sql eseguita con livello ERROR
  150.      * 
  151.      * @param t eccezione
  152.      * @param sql comando sql 
  153.      * @param param parametro richiesto dal comando
  154.      */
  155.     public void errorSql( Throwable t, String sql, JDBCObject ... param ) {
  156.         this.log.error( sqlLog( sql, param ), t );
  157.     }



  161.     /**
  162.      * Trasformazione in string 'human readable' del comando sql con i corrispettivi parametri
  163.      * 
  164.      * @param sql comando sql
  165.      * @param params parametri richiesti dal comando
  166.      * @return SQL
  167.      */
  168.     public String sqlLog( String sql, JDBCObject ... params) {
  169.         String ret = "SQL: " + sql;

  171.         if (params == null || params.length == 0) {
  172.             return ret;
  173.         }

  175.         StringBuilder sb = new StringBuilder();

  177.         for (int i = 0; i < params.length; i++) {
  178.             if (params[i] != null) {
  179.                 if (sb.length() != 0) {
  180.                     sb.append( ",\n" );
  181.                 }
  182.                                 
  183.                 Object object = params[i].getObject();
  184.                 Class<?> type = params[i].getTypeObject();
  185.                 sb.append( "\t- param("+(i+1)+") type("+type+") value(" );
  186.                 
  187.                 logParam(object, type, sb);
  188.                 
  189.                 sb.append(")");
  190.             }
  191.         }

  193.         return  ret + "; PARAMS: \n" + sb.toString();

  195.     }

  197.     private void logParam(Object object,Class<?> type,StringBuilder sb){

  199.         String typeName = object!=null ? type.getName()+"" : "";
  200.         
  201.         if (object == null){
  202.             sb.append("null");
  203.         }

  205.         else if(typeName.equals(String.class.getName())){
  206.             sb.append('\'').append( object ).append( '\'' );
  207.         }

  209.         else if(typeName.equals(Character.class.getName())){
  210.             Character valueWrapped = (Character) object;
  211.             char charPrimitiveValue = valueWrapped.charValue();
  212.             String charValue = valueWrapped.charValue()+"";
  213.             if(charPrimitiveValue==0){ // == ''
  214.                 // ERROR: invalid byte sequence for encoding "UTF8": 0x00
  215.                 // Postgresql non supporta il carattere 'vuoto'. Si deve usare un null value
  216.                 charValue = null;
  217.             }
  218.             if(charValue!=null)
  219.                 sb.append('\'').append( charValue ).append( '\'' );
  220.             else
  221.                 sb.append("null");
  222.         }
  223.         else if(typeName.equals(char.class.getName())){
  224.             Character valueWrapped = (Character) object;
  225.             char charPrimitiveValue = valueWrapped.charValue();
  226.             String charValue = valueWrapped.charValue()+"";
  227.             if(charPrimitiveValue==0){ // == ''
  228.                 // ERROR: invalid byte sequence for encoding "UTF8": 0x00
  229.                 // Postgresql non supporta il carattere 'vuoto'. Si deve usare un null value
  230.                 charValue = null;
  231.             }
  232.             if(charValue!=null)
  233.                 sb.append('\'').append( charValue ).append( '\'' );
  234.             else
  235.                 sb.append("null");
  236.         }
  237.         
  238.         else if(typeName.equals(Boolean.class.getName())){
  239.             sb.append( object.toString() );
  240.         }
  241.         else if(typeName.equals(boolean.class.getName())){
  242.             sb.append( object );
  243.         }
  244.         
  245.         else if(typeName.equals(Byte.class.getName())){
  246.             sb.append( object.toString() );
  247.         }
  248.         else if(typeName.equals(byte.class.getName())){
  249.             sb.append( object );
  250.         }
  251.         
  252.         else if(typeName.equals(Short.class.getName())){
  253.             sb.append( object.toString() );
  254.         }
  255.         else if(typeName.equals(short.class.getName())){
  256.             sb.append( object );
  257.         }
  258.         
  259.         else if(typeName.equals(Integer.class.getName())){
  260.             sb.append( object.toString() );
  261.         }
  262.         else if(typeName.equals(int.class.getName())){
  263.             sb.append( object );
  264.         }
  265.                         
  266.         else if(typeName.equals(Long.class.getName())){
  267.             sb.append( object.toString() );
  268.         }
  269.         else if(typeName.equals(long.class.getName())){
  270.             sb.append( object );
  271.         }
  272.         
  273.         else if(typeName.equals(Double.class.getName())){
  274.             sb.append( object.toString() );
  275.         }
  276.         else if(typeName.equals(double.class.getName())){
  277.             sb.append( object );
  278.         }
  279.         
  280.         else if(typeName.equals(Float.class.getName())){
  281.             sb.append( object.toString() );
  282.         }
  283.         else if(typeName.equals(float.class.getName())){
  284.             sb.append( object );
  285.         }
  286.         
  287.         else if(typeName.equals(Date.class.getName())){
  288.             sb.append('\'').append( this.dateformat.format((Date)object) ).append( '\'' );
  289.         }
  290.         else if(typeName.equals(java.sql.Date.class.getName())){
  291.             sb.append('\'').append( this.dateformat.format((java.sql.Date)object) ).append( '\'' );
  292.         }
  293.         else if(typeName.equals(Timestamp.class.getName())){
  294.             sb.append('\'').append( this.dateformat.format( new Date( ((Timestamp)object).getTime() ) )).append( '\'' );
  295.         }
  296.         else if(typeName.equals(Calendar.class.getName())){
  297.             sb.append('\'').append( this.dateformat.format( new Date( ((Calendar)object).getTime().getTime() ) )).append( '\'' );
  298.         }
  299.         
  300.         else if(typeName.equals(byte[].class.getName())){
  301.              // 1024 = 1K
  302.              // Visualizzo al massimo 5K
  303.              int max = 5 * 1024;
  304.              try{
  305.                  sb.append('\'').append(Utilities.convertToPrintableText((byte[])object, max)).append('\'');
  306.              }catch(Exception e){
  307.                  sb.append( "bytes[] not printable ("+e.getMessage()+")" );
  308.              }
  309.         }
  310.         
  311.         else if(typeName.equals(URI.class.getName())){
  312.             sb.append('\'').append( object ).append( '\'' );
  313.         }
  314.         
  315.         else if(object!=null && object instanceof IEnumeration){
  316.             IEnumeration enumObject = (IEnumeration) object;
  317.             Object value = enumObject.getValue();
  318.             Class<?> cValue = null;
  319.             if(value!=null){
  320.                 cValue = value.getClass();
  321.             }
  322.             sb.append("IEnumeration ");
  323.             this.logParam(value, cValue, sb);
  324.         }
  325.         
  326.         else {
  327.             sb.append( "!!ERROR Print not supported for this type" );
  328.         }
  329.     }
  330. }
Created with JaCoCo 0.8.8.202204050719