1 /**
2 * This file Copyright (c) 2017-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.rest;
35
36 import javax.xml.bind.annotation.XmlElement;
37 import javax.xml.bind.annotation.XmlRootElement;
38
39 import com.fasterxml.jackson.annotation.JsonProperty;
40
41 /**
42 * This class is an error response entity and created to mainly support for delivery endpoint.
43 * It also maintains backward compatibility for legacy endpoints like nodes, properties, commands using JAXB.
44 */
45 @XmlRootElement
46 public class RestError {
47
48 @XmlElement(name = "error")
49 @JsonProperty("error")
50 private final ErrorContainer errorContainer;
51
52 public RestError() {
53 errorContainer = new ErrorContainer("", "");
54 }
55
56 public RestError(String code, String message) {
57 errorContainer = new ErrorContainer(code, message);
58 }
59
60 /**
61 * Error container.
62 */
63 public static class ErrorContainer {
64
65 @XmlElement(name = "code")
66 private final String code;
67
68 @XmlElement(name = "message")
69 private final String message;
70
71 public ErrorContainer() {
72 this.code = "";
73 this.message = "";
74 }
75
76 public ErrorContainer(String code, String message) {
77 this.code = code;
78 this.message = message;
79 }
80
81 public String getCode() {
82 return code;
83 }
84
85 public String getMessage() {
86 return message;
87 }
88 }
89
90 public ErrorContainer getErrorContainer() {
91 return errorContainer;
92 }
93 }