AbstractLog4JLoggerWithContext.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.log4j;

  22. import java.text.SimpleDateFormat;
  23. import java.util.List;

  25. import org.openspcoop2.utils.UtilsException;
  26. import org.openspcoop2.utils.date.DateUtils;
  27. import org.openspcoop2.utils.logger.IContext;
  28. import org.openspcoop2.utils.logger.beans.Property;
  29. import org.openspcoop2.utils.logger.beans.context.core.AbstractContext;
  30. import org.openspcoop2.utils.logger.beans.context.core.AbstractContextWithClient;
  31. import org.openspcoop2.utils.logger.beans.context.core.AbstractTransactionWithClient;
  32. import org.openspcoop2.utils.logger.beans.context.core.BaseClient;
  33. import org.openspcoop2.utils.logger.beans.context.core.BaseServer;
  34. import org.openspcoop2.utils.logger.beans.context.core.ConnectionMessage;
  35. import org.openspcoop2.utils.logger.beans.context.core.HttpClient;
  36. import org.openspcoop2.utils.logger.beans.context.core.HttpServer;
  37. import org.openspcoop2.utils.logger.config.DiagnosticConfig;
  38. import org.openspcoop2.utils.logger.config.Log4jConfig;
  39. import org.openspcoop2.utils.logger.config.MultiLoggerConfig;

  41. /**
  42.  * AbstractLog4JLoggerWithContext
  43.  *
  44.  * @author Poli Andrea (apoli@link.it)
  45.  * @author $Author$
  46.  * @version $Rev$, $Date$
  47.  */
  48. public abstract class AbstractLog4JLoggerWithContext extends AbstractLog4JLogger  {

  50.     public AbstractLog4JLoggerWithContext(MultiLoggerConfig config) throws UtilsException {
  51.         super(config.getDiagnosticConfig(),config.getLog4jConfig());
  52.         if(config.isLog4jLoggerEnabled()){
  53.             if(config.getDiagnosticSeverityFilter()!=null){
  54.                 AbstractLog4JLogger.setDiagnosticSeverity(config.getDiagnosticSeverityFilter());
  55.             }
  56.             if(config.getEventSeverityFilter()!=null){
  57.                 AbstractLog4JLogger.setEventSeverity(config.getEventSeverityFilter());
  58.             }
  59.         }
  60.     }

  62.     public AbstractLog4JLoggerWithContext(DiagnosticConfig diagnosticConfig, Log4jConfig logConfig) throws UtilsException {
  63.         super(diagnosticConfig, logConfig);
  64.     }
  65.     
  66.     protected AbstractContext context;
  67.     protected abstract AbstractContext newContext();
  68.     protected abstract BaseClient getClient();
  69.     protected abstract List<BaseServer> getServers();
  70.     
  71.     @Override
  72.     public void initLogger() throws UtilsException{
  73.         this.initLogger(this.newContext());
  74.     }
  75.     @Override
  76.     public void initLogger(String idTransazione) throws UtilsException{
  77.         this.initLogger(idTransazione, this.newContext());
  78.     }
  79.     @Override
  80.     public void initLogger(IContext contextParam) throws UtilsException{
  81.         this.initLogger(null,contextParam);
  82.     }
  83.     @Override
  84.     public void initLogger(String idTransazione, IContext contextParam) throws UtilsException{
  85.         this.context = (AbstractContext) contextParam;
  86.         super.initLogger(idTransazione);
  87.         this.context.setIdTransaction(this.idTransaction);
  88.     }
  89.     
  90.     @Override
  91.     public IContext getContext() throws UtilsException {
  92.         return this.context;
  93.     }
  94.     
  95.     @Override
  96.     protected void logContext(IContext contextParam, StringBuilder showContext){
  97.         
  98.         SimpleDateFormat dateformat = DateUtils.getSimpleDateFormatMs();
  99.         
  100.         AbstractContext context = (AbstractContext) contextParam;
  101.         
  102.         if( context.getTransaction().getProtocol()!=null){
  103.             showContext.append("Protocol="+context.getTransaction().getProtocol()+"\n");
  104.         }
  105.         if( context.getTransaction().getDomain()!=null){
  106.             showContext.append("Domain="+context.getTransaction().getDomain()+"\n");
  107.         } 
  108.         if( context.getTransaction().getRole()!=null){
  109.             showContext.append("Role="+context.getTransaction().getRole().name()+"\n");
  110.         } 
  111.         if( context.getTransaction().getResult()!=null){
  112.             showContext.append("Result="+context.getTransaction().getResult().name()+"\n");
  113.         }
  114.         if( context.getTransaction().getConversationId()!=null){
  115.             showContext.append("ConversationId="+context.getTransaction().getConversationId()+"\n");
  116.         } 
  117.         if( context.getTransaction().getClusterId()!=null){
  118.             showContext.append("ClusterId="+context.getTransaction().getClusterId()+"\n");
  119.         } 
  120.         
  121.         if( this.getClient()!=null){
  122.             showContext.append("*** Client ***\n");
  123.             if( this.getClient().getPrincipal()!=null){
  124.                 showContext.append("Principal="+this.getClient().getPrincipal()+"\n");
  125.             }
  126.             if( this.getClient().getName()!=null){
  127.                 showContext.append("Name="+this.getClient().getName()+"\n");
  128.             }
  129.             if( this.getClient().getInvocationEndpoint()!=null){
  130.                 showContext.append("InvocationEndpoint="+this.getClient().getInvocationEndpoint()+"\n");
  131.             }
  132.             if( this.getClient().getInterfaceName()!=null){
  133.                 showContext.append("InterfaceName="+this.getClient().getInterfaceName()+"\n");
  134.             }
  135.             if( this.getClient() instanceof HttpClient) {
  136.                 HttpClient httpClient = (HttpClient) this.getClient();
  137.                 if( httpClient.getResponseStatusCode()>0){
  138.                     showContext.append("ResponseStatusCode="+httpClient.getResponseStatusCode()+"\n");
  139.                 }
  140.                 if(httpClient.getTransportRequestMethod()!=null) {
  141.                     showContext.append("HttpMethod="+httpClient.getTransportRequestMethod().name()+"\n");
  142.                 }
  143.                 if(httpClient.getSocketClientAddress()!=null) {
  144.                     showContext.append("SocketClientAddress="+httpClient.getSocketClientAddress()+"\n");
  145.                 }
  146.                 if(httpClient.getTransportClientAddress()!=null) {
  147.                     showContext.append("TransportClientAddress="+httpClient.getTransportClientAddress()+"\n");
  148.                 }
  149.             }
  150.             if( this.getClient().getGenericProperties()!=null && this.getClient().getGenericProperties().size()>0 ){
  151.                 for (Property property : this.getClient().getGenericPropertiesAsList()) {
  152.                     showContext.append("Property."+property.getName()+"="+property.getValue()+"\n");        
  153.                 }
  154.             }
  155.         } 
  156.                 
  157.         if( context.getTransaction().getFrom()!=null){
  158.             showContext.append("*** From ***\n");
  159.             if( context.getTransaction().getFrom().getType()!=null){
  160.                 showContext.append("Type="+context.getTransaction().getFrom().getType()+"\n");
  161.             }
  162.             if( context.getTransaction().getFrom().getName()!=null){
  163.                 showContext.append("Name="+context.getTransaction().getFrom().getName()+"\n");
  164.             }
  165.             if( context.getTransaction().getFrom().getAddress()!=null){
  166.                 showContext.append("Address="+context.getTransaction().getFrom().getAddress()+"\n");
  167.             }
  168.         } 
  169.         
  170.         if( context.getTransaction().getTo()!=null){
  171.             showContext.append("*** To ***\n");
  172.             if( context.getTransaction().getTo().getType()!=null){
  173.                 showContext.append("Type="+context.getTransaction().getTo().getType()+"\n");
  174.             }
  175.             if( context.getTransaction().getTo().getName()!=null){
  176.                 showContext.append("Name="+context.getTransaction().getTo().getName()+"\n");
  177.             }
  178.             if( context.getTransaction().getTo().getAddress()!=null){
  179.                 showContext.append("Address="+context.getTransaction().getTo().getAddress()+"\n");
  180.             }
  181.         } 
  182.         
  183.         if( context.getTransaction().getService()!=null){
  184.             showContext.append("*** Service ***\n");
  185.             if( context.getTransaction().getService().getType()!=null){
  186.                 showContext.append("Type="+context.getTransaction().getService().getType()+"\n");
  187.             }
  188.             if( context.getTransaction().getService().getName()!=null){
  189.                 showContext.append("Name="+context.getTransaction().getService().getName()+"\n");
  190.             }
  191.             if( context.getTransaction().getService().getVersion()!=null){
  192.                 showContext.append("Version="+context.getTransaction().getService().getVersion()+"\n");
  193.             }
  194.         } 
  195.         
  196.         if( context.getTransaction().getOperation()!=null){
  197.             showContext.append("*** Operation ***\n");
  198.             if( context.getTransaction().getOperation().getName()!=null){
  199.                 showContext.append("Name="+context.getTransaction().getOperation().getName()+"\n");
  200.             }
  201.             if( context.getTransaction().getOperation().getMode()!=null){
  202.                 showContext.append("FlowMode="+context.getTransaction().getOperation().getMode().name()+"\n");
  203.             }
  204.         } 
  205.         
  206.         List<BaseServer> listServer = this.getServers();
  207.         if(listServer!=null && !listServer.isEmpty()) {
  208.             int indexServer = 1;
  209.             for (BaseServer baseServer : listServer) {
  210.                 if( baseServer!=null){
  211.                     if(listServer.size()<2) {
  212.                         showContext.append("*** Server ***\n");
  213.                         if( baseServer.getName()!=null){
  214.                             showContext.append("Name="+baseServer.getName()+"\n");
  215.                         }
  216.                     }
  217.                     else if(baseServer.getName()!=null) {
  218.                         showContext.append("*** Server '"+baseServer.getName()+"' ***\n");
  219.                     }
  220.                     else {
  221.                         showContext.append("*** Server-"+indexServer+" ***\n");
  222.                     }
  223.                     if( baseServer.getIdOperation()!=null){
  224.                         showContext.append("IdOperation="+baseServer.getIdOperation()+"\n");
  225.                     }
  226.                     if( baseServer.getEndpointType()!=null){
  227.                         showContext.append("EndpointType="+baseServer.getEndpointType()+"\n");
  228.                     }
  229.                     if( baseServer.getEndpoint()!=null){
  230.                         showContext.append("Endpoint="+baseServer.getEndpoint()+"\n");
  231.                     }
  232.                     if(baseServer instanceof HttpServer) {
  233.                         HttpServer httpServer = (HttpServer) baseServer;
  234.                         if( httpServer.getResponseStatusCode()>0){
  235.                             showContext.append("ResponseStatusCode="+httpServer.getResponseStatusCode()+"\n");
  236.                         }
  237.                         if(httpServer.getTransportRequestMethod()!=null) {
  238.                             showContext.append("HttpMethod="+httpServer.getTransportRequestMethod().name()+"\n");
  239.                         }
  240.                     }
  241.                     if( baseServer.getGenericProperties()!=null && baseServer.getGenericProperties().size()>0 ){
  242.                         for (Property property : baseServer.getGenericPropertiesAsList()) {
  243.                             showContext.append("Property."+property.getName()+"="+property.getValue()+"\n");        
  244.                         }
  245.                     }
  246.                     if(baseServer.getRequest()!=null) {
  247.                         this._log(true, baseServer.getRequest(), showContext, dateformat);
  248.                     }
  249.                     if(baseServer.getResponse()!=null) {
  250.                         this._log(false, baseServer.getResponse(), showContext, dateformat);
  251.                     }
  252.                 
  253.                 }
  254.                 indexServer++;
  255.             }
  256.         }

  258.         if(context.getTransaction() instanceof AbstractTransactionWithClient) {
  259.             
  260.             AbstractTransactionWithClient trWithClient = (AbstractTransactionWithClient) context.getTransaction();
  261.             
  262.             if( trWithClient.getRequest()!=null){
  263.                 showContext.append("*** Request ***\n");
  264.                 if( trWithClient.getRequest().getIdentifier()!=null){
  265.                     if( trWithClient.getRequest().getIdentifier().getId()!=null){
  266.                         showContext.append("Identifier="+trWithClient.getRequest().getIdentifier().getId()+"\n");
  267.                     }
  268.                     if( trWithClient.getRequest().getIdentifier().getDate()!=null){
  269.                         showContext.append("DateIdentifier="+dateformat.format(trWithClient.getRequest().getIdentifier().getDate())+"\n");
  270.                     }
  271.                 }
  272.                 if( trWithClient.getRequest().getDate()!=null){
  273.                     showContext.append("Date="+dateformat.format(trWithClient.getRequest().getDate())+"\n");
  274.                 }
  275.                 if( trWithClient.getRequest().getSize()!=null){
  276.                     showContext.append("Size="+trWithClient.getRequest().getSize()+"\n");
  277.                 }
  278.                 if( trWithClient.getRequest().getCorrelationIdentifier()!=null){
  279.                     showContext.append("CorrelationIdentifier="+trWithClient.getRequest().getCorrelationIdentifier()+"\n");     
  280.                 }
  281.                 if( trWithClient.getRequest().getGenericProperties()!=null && trWithClient.getRequest().getGenericProperties().size()>0 ){
  282.                     for (Property property : trWithClient.getRequest().getGenericPropertiesAsList()) {
  283.                         showContext.append("Property."+property.getName()+"="+property.getValue()+"\n");        
  284.                     }
  285.                 }
  286.             } 
  287.             
  288.             if( trWithClient.getResponse()!=null){
  289.                 showContext.append("*** Response ***\n");
  290.                 if( trWithClient.getResponse().getIdentifier()!=null){
  291.                     if( trWithClient.getResponse().getIdentifier().getId()!=null){
  292.                         showContext.append("Identifier="+trWithClient.getResponse().getIdentifier().getId()+"\n");
  293.                     }
  294.                     if( trWithClient.getResponse().getIdentifier().getDate()!=null){
  295.                         showContext.append("DateIdentifier="+dateformat.format(trWithClient.getResponse().getIdentifier().getDate())+"\n");
  296.                     }
  297.                 }
  298.                 if( trWithClient.getResponse().getDate()!=null){
  299.                     showContext.append("Date="+dateformat.format(trWithClient.getResponse().getDate())+"\n");
  300.                 }
  301.                 if( trWithClient.getResponse().getSize()!=null){
  302.                     showContext.append("Size="+trWithClient.getResponse().getSize()+"\n");
  303.                 }
  304.                 if( trWithClient.getResponse().getCorrelationIdentifier()!=null){
  305.                     showContext.append("CorrelationIdentifier="+trWithClient.getResponse().getCorrelationIdentifier()+"\n");        
  306.                 }
  307.                 if( trWithClient.getResponse().getGenericProperties()!=null && trWithClient.getResponse().getGenericProperties().size()>0 ){
  308.                     for (Property property : trWithClient.getResponse().getGenericPropertiesAsList()) {
  309.                         showContext.append("Property."+property.getName()+"="+property.getValue()+"\n");        
  310.                     }
  311.                 }
  312.                 if( trWithClient.getResponse().getFault()!=null){
  313.                     int max = 250 * 1024;
  314.                     String text = null;
  315.                     try{
  316.                         text = org.openspcoop2.utils.Utilities.convertToPrintableText(trWithClient.getResponse().getFault(),max);
  317.                     }catch(Exception e){
  318.                         text = e.getMessage();
  319.                     }
  320.                     showContext.append("Fault="+text+"\n");
  321.                 }
  322.             } 
  323.             
  324.         }
  325.         
  326.         showContext.append("\n");
  327.         
  328.     }
  329.         
  330.     private void _log(boolean request, ConnectionMessage message ,StringBuilder showContext,SimpleDateFormat dateformat) {
  331.         if( message!=null){
  332.             String prefix = request ? "Request-" : "Response-";
  333.             if( message.getIdMessage()!=null){
  334.                 showContext.append(prefix+"IdMessage="+message.getIdMessage()+"\n");
  335.             }
  336.             if( message.getDate()!=null){
  337.                 showContext.append(prefix+"Date="+dateformat.format(message.getDate())+"\n");
  338.             }
  339.             if( message.getSize()!=null){
  340.                 showContext.append(prefix+"Size="+message.getSize()+"\n");
  341.             }
  342.         } 
  343.     }
  344.     

  346.     @Override
  347.     protected String getDomain(IContext contextParam){
  348.         AbstractContext context = (AbstractContext) contextParam;
  349.         return context.getTransaction().getDomain();
  350.     }
  351.     @Override
  352.     protected String getRequestIdentifier(IContext contextParam){
  353.         AbstractContext context = (AbstractContext) contextParam;
  354.         if(context instanceof AbstractContextWithClient) {
  355.             if(((AbstractContextWithClient)context).getRequest()!=null)
  356.                 return ((AbstractContextWithClient)context).getRequest().getId();
  357.         }
  358.         return null;
  359.     }
  360.     @Override
  361.     protected String getResponseIdentifier(IContext contextParam){
  362.         AbstractContext context = (AbstractContext) contextParam;
  363.         if(context instanceof AbstractContextWithClient) {
  364.             if(((AbstractContextWithClient)context).getResponse()!=null)
  365.                 return ((AbstractContextWithClient)context).getResponse().getId();
  366.         }
  367.         return null;
  368.     }
  369.     @Override
  370.     protected String getRequestCorrelationIdentifier(IContext contextParam){
  371.         AbstractContext context = (AbstractContext) contextParam;
  372.         if(context instanceof AbstractContextWithClient) {
  373.             if(((AbstractContextWithClient)context).getRequest()!=null)
  374.                 return ((AbstractContextWithClient)context).getRequest().getCorrelationIdentifier();
  375.         }
  376.         return null;
  377.     }
  378.     @Override
  379.     protected String getResponseCorrelationIdentifier(IContext contextParam){
  380.         AbstractContext context = (AbstractContext) contextParam;
  381.         if(context instanceof AbstractContextWithClient) {
  382.             if(((AbstractContextWithClient)context).getResponse()!=null)
  383.                 return ((AbstractContextWithClient)context).getResponse().getCorrelationIdentifier();
  384.         }
  385.         return null;
  386.     }
  387.     @Override
  388.     protected String getClient(IContext contextParam){
  389.         AbstractContext context = (AbstractContext) contextParam;
  390.         if(context.getTransaction()==null) {
  391.             return null;
  392.         }
  393.         if(context.getTransaction() instanceof AbstractTransactionWithClient) {
  394.             BaseClient baseClient = ((AbstractTransactionWithClient)context.getTransaction()).getClient();
  395.             if(baseClient!=null) {
  396.                 return baseClient.getName();
  397.             }
  398.         }
  399.         return null;
  400.     }
  401.     @Override
  402.     protected String getClientPrincipal(IContext contextParam){
  403.         AbstractContext context = (AbstractContext) contextParam;
  404.         if(context.getTransaction()==null) {
  405.             return null;
  406.         }
  407.         if(context.getTransaction() instanceof AbstractTransactionWithClient) {
  408.             BaseClient baseClient = ((AbstractTransactionWithClient)context.getTransaction()).getClient();
  409.             if(baseClient!=null) {
  410.                 return baseClient.getPrincipal();
  411.             }
  412.         }
  413.         return null;
  414.     }
  415.     @Override
  416.     protected String getFrom(IContext contextParam){
  417.         AbstractContext context = (AbstractContext) contextParam;
  418.         if(context.getTransaction()==null) {
  419.             return null;
  420.         }
  421.         if(context.getTransaction().getFrom()!=null){
  422.             if(context.getTransaction().getFrom().getName()!=null){
  423.                 return context.getTransaction().getFrom().getName();
  424.             }
  425.         }
  426.         return null;
  427.     }
  428.     @Override
  429.     protected String getTo(IContext contextParam){
  430.         AbstractContext context = (AbstractContext) contextParam;
  431.         if(context.getTransaction()==null) {
  432.             return null;
  433.         }
  434.         if(context.getTransaction().getTo()!=null){
  435.             if(context.getTransaction().getTo().getName()!=null){
  436.                 return context.getTransaction().getTo().getName();
  437.             }
  438.         }
  439.         return null;
  440.     }
  441.     @Override
  442.     protected String getService(IContext contextParam){
  443.         AbstractContext context = (AbstractContext) contextParam;
  444.         if(context.getTransaction()==null) {
  445.             return null;
  446.         }
  447.         if(context.getTransaction().getService()!=null){
  448.             if(context.getTransaction().getService().getName()!=null){
  449.                 return context.getTransaction().getService().getName();
  450.             }
  451.         }
  452.         return null;
  453.     }
  454.     @Override
  455.     protected String getOperation(IContext contextParam){
  456.         AbstractContext context = (AbstractContext) contextParam;
  457.         if(context.getTransaction()==null) {
  458.             return null;
  459.         }
  460.         if(context.getTransaction().getOperation()!=null){
  461.             if(context.getTransaction().getOperation().getName()!=null){
  462.                 return context.getTransaction().getOperation().getName();
  463.             }
  464.         }
  465.         return null;
  466.     }


  469.     
  470. }
Created with JaCoCo 0.8.8.202204050719