1 /**
2 * This file Copyright (c) 2009-2011 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.nodebuilder;
35
36 import info.magnolia.cms.core.Content;
37
38 import javax.jcr.ItemExistsException;
39 import javax.jcr.ItemNotFoundException;
40 import javax.jcr.PathNotFoundException;
41 import javax.jcr.RepositoryException;
42
43 /**
44 * Provides a basic behaviour for ErrorHandlers.
45 *
46 * @author gjoseph
47 * @version $Revision: $ ($Author: $)
48 */
49 public abstract class AbstractErrorHandler implements ErrorHandler {
50
51 // We currently can't differentiate between properties and nodes removal,
52 // since we have a single operation for removal. Likewise, we can't assume
53 // ItemExistsException is only thrown when a property already exists
54 // (we throw it ourselves in info.magnolia.nodebuilder.Ops#addProperty,
55 // but it might be thrown on other occasions too.
56 // PathNotFoundException and ItemNotFoundException are also not clearly
57 // distinguished, for similar reasons.
58 // Moreover, while we're consistent in the Ops code, there's no guarantee
59 // (neither spec nor api) that, for instance, an ItemExistsException is
60 // thrown with the item's name as it's sole message (and unfortunately we
61 // rely on this here below)
62 public void handle(RepositoryException e, Content context) throws NodeOperationException {
63 if (e instanceof ItemExistsException) {
64 report(e.getMessage() + " already exists at " + context.getHandle() + ".", e);
65 } else if (e instanceof ItemNotFoundException) {
66 report(e.getMessage() + " can't be found at " + context.getHandle() + ".", e);
67 } else if (e instanceof PathNotFoundException) {
68 report(e.getMessage() + " can't be found at " + context.getHandle() + ".", e);
69 } else {
70 unhandledRepositoryException(e, context);
71 }
72 }
73
74 /**
75 * Override this method if you need finer grained control on RepositoryExceptions that haven't been handled
76 * by the handle() method yet, or if you want to try and keep on proceeding anyway.
77 */
78 protected void unhandledRepositoryException(RepositoryException e, Content context) throws NodeOperationException {
79 throw new NodeOperationException("Failed to operate on " + context.getHandle() + " with message: " + e.getMessage(), e);
80 }
81
82 /**
83 * Default implementation dropping the cause for those handlers that care only about the message.
84 */
85 public void report(String message, Throwable cause) throws NodeOperationException {
86 report(message);
87 }
88 }