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.RepositoryException;
39
40 /**
41 * ErrorHandler implementations can decide what to do with certain conditions.
42 * Specifically, they'll usually log or throw exceptions. They can only throw
43 * NodeOperationException (or other RuntimeExceptions, obviously), which
44 * the client code is expected to handle.
45 *
46 * @author gjoseph
47 * @version $Revision: $ ($Author: $)
48 */
49 public interface ErrorHandler {
50
51 /**
52 * The operation calling this method is expected to pass a fully formed message;
53 * it should ideally contain some context information about the operation that
54 * caused an issue. The ErrorHandler implementation will decide what to do
55 * with it. (log, throw a NodeOperationException, ...)
56 */
57 void report(String message) throws NodeOperationException;
58
59 /**
60 * The operation calling this method is expected to pass a fully formed message; it should ideally contain some context information about the operation that caused an issue. The ErrorHandler implementation will decide what to do with it. (log, throw a NodeOperationException, ...)
61 */
62 void report(String message, Throwable cause) throws NodeOperationException;
63
64 /**
65 * The operation calling this method isn't expected to do anything here; the ErrorHandler implementation will attempt to build a fully formed message, then decide what to do with it. (log, throw a NodeOperationException, ...)
66 */
67 void handle(RepositoryException e, Content context) throws NodeOperationException;
68
69 }