View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.logging;
35  
36  import java.util.ArrayList;
37  import java.util.Iterator;
38  import java.util.List;
39  
40  import info.magnolia.objectfactory.Components;
41  import org.apache.commons.lang.StringUtils;
42  import org.slf4j.Logger;
43  import org.slf4j.LoggerFactory;
44  
45  /**
46   * Class for auditory logging, it's optional to define it, configured in mgnl-beans.properties
47   * @author tmiyar
48   *
49   */
50  public class AuditLoggingManager {
51  
52      private List logConfigurations = new ArrayList();
53  
54      private String defaultSeparator = ", ";
55  
56      private static Logger applog = LoggerFactory.getLogger(AuditLoggingManager.class);
57  
58      public AuditLoggingManager() {
59  
60      }
61  
62      public static AuditLoggingManager getInstance() {
63          try {
64              return Components.getSingleton(AuditLoggingManager.class);
65          } catch (Exception e) {
66              // if not defined skip and return null
67              applog.info("Class AuditLoggingManager not defined");
68              return null;
69          }
70      }
71  
72      public void addLogConfigurations(LogConfiguration action) {
73          this.logConfigurations.add(action);
74      }
75  
76      public List getLogConfigurations() {
77          return logConfigurations;
78      }
79  
80      public void setLogConfigurations(List logConfigurations) {
81          this.logConfigurations = logConfigurations;
82      }
83  
84      public LogConfiguration getLogConfiguration(String action) {
85          Iterator iterator = this.logConfigurations.iterator();
86          while (iterator.hasNext()) {
87              final LogConfiguration trail = (LogConfiguration)iterator.next();
88              if(StringUtils.equals(trail.getName(), action) ) {
89                  return trail;
90              }
91          }
92          return null;
93      }
94  
95      public void log(String action, String[] data) {
96          String message = "";
97          try {
98              LogConfiguration trail = this.getLogConfiguration(action);
99              String separator = defaultSeparator;
100             if(!StringUtils.isEmpty(trail.getSeparator())) {
101                 separator = trail.getSeparator();
102             }
103             message += separator + action;
104             if (trail != null && trail.isActive()) {
105                 for (int i = 0; i < data.length; i++) {
106                     if (StringUtils.isNotEmpty(data[i])) {
107                       message += separator + data[i];
108                     }
109 
110                 }
111 
112                 org.apache.log4j.Logger.getLogger(trail.getLogName()).log(
113                         LoggingLevel.AUDIT_TRAIL, message);
114             }
115 
116         } catch (Exception e) {
117             applog.trace("Can't get log configuration");
118         }
119     }
120 
121     public String getDefaultSeparator() {
122         return defaultSeparator;
123     }
124 
125     public void setDefaultSeparator(String defaultSeparator) {
126         this.defaultSeparator = defaultSeparator;
127     }
128 
129 }