View Javadoc
1   /**
2    * This file Copyright (c) 2013-2018 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.audit;
35  
36  import info.magnolia.jcr.decoration.ContentDecoratorSessionWrapper;
37  
38  import java.util.LinkedList;
39  import java.util.Map;
40  import java.util.Map.Entry;
41  
42  import javax.jcr.AccessDeniedException;
43  import javax.jcr.InvalidItemStateException;
44  import javax.jcr.ItemExistsException;
45  import javax.jcr.PathNotFoundException;
46  import javax.jcr.ReferentialIntegrityException;
47  import javax.jcr.RepositoryException;
48  import javax.jcr.Session;
49  import javax.jcr.lock.LockException;
50  import javax.jcr.nodetype.ConstraintViolationException;
51  import javax.jcr.nodetype.NoSuchNodeTypeException;
52  import javax.jcr.version.VersionException;
53  
54  /**
55   * A Session wrapper implementation which inform
56   * Magnolia audit logging content decorator {@link info.magnolia.audit.MgnlAuditLoggingContentDecorator} about action (Move, Delete) on the node.
57   * The implementation also take care about logging actions into audit-log output during save action.
58   */
59  public class MgnlAuditLoggingContentDecoratorSessionWrapper extends ContentDecoratorSessionWrapper<MgnlAuditLoggingContentDecorator> {
60  
61      public MgnlAuditLoggingContentDecoratorSessionWrapper(Session session, MgnlAuditLoggingContentDecorator contentDecorator) {
62          super(session, contentDecorator);
63      }
64  
65      @Override
66      public void move(String srcAbsPath, String destAbsPath) throws ItemExistsException, PathNotFoundException, VersionException, ConstraintViolationException, LockException, RepositoryException {
67          super.move(srcAbsPath, destAbsPath);
68          getContentDecorator().logActionMove(srcAbsPath, destAbsPath, getWorkspace().getName());
69      }
70  
71      @Override
72      public void removeItem(String absPath) throws VersionException, LockException, ConstraintViolationException, AccessDeniedException, RepositoryException {
73          super.removeItem(absPath);
74          getContentDecorator().logActionDelete(absPath, getWorkspace().getName(), null);
75      }
76  
77      /**
78       * During node save action log all action which was done in the session.
79       */
80      @Override
81      public void save() throws AccessDeniedException, ItemExistsException, ReferentialIntegrityException, ConstraintViolationException, InvalidItemStateException, VersionException, LockException, NoSuchNodeTypeException, RepositoryException {
82          super.save();
83  
84          Map<String, LinkedList<MgnlAuditLogEntry>> logMap = getContentDecorator().getLogEntries();
85          for (Entry<String, LinkedList<MgnlAuditLogEntry>> pathLogEntries : logMap.entrySet()) {
86              for (MgnlAuditLogEntry entry : pathLogEntries.getValue()) {
87                  AuditLoggingUtil.log(entry.getAction(), entry.getTimeStamp(), entry.getWorkspace(), entry.getNodeType(), entry.getPath(), entry.getPathTo());
88              }
89          }
90          logMap.clear();
91      }
92  
93  }