View Javadoc
1   /**
2    * This file Copyright (c) 2009-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.jcr.nodebuilder;
35  
36  import javax.jcr.Node;
37  import javax.jcr.RepositoryException;
38  
39  /**
40   * ErrorHandler implementations can decide what to do with certain conditions.
41   * Specifically, they'll usually log or throw exceptions. They can only throw
42   * NodeOperationException (or other RuntimeExceptions, obviously), which
43   * the client code is expected to handle.
44   */
45  public interface ErrorHandler {
46  
47      /**
48       * The operation calling this method is expected to pass a fully formed message;
49       * it should ideally contain some context information about the operation that
50       * caused an issue. The ErrorHandler implementation will decide what to do
51       * with it. (log, throw a NodeOperationException, ...)
52       */
53      void report(String message) throws NodeOperationException, RepositoryException;
54  
55      /**
56       * The operation calling this method isn't expected to do anything here;
57       * the ErrorHandler implementation will attempt to build a fully formed message,
58       * then decide what to do with it. (log, throw a NodeOperationException, ...)
59       */
60      void handle(RepositoryException e, Node context) throws NodeOperationException, RepositoryException;
61  
62  }