1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/*
* Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.restconf.common.errors;
import static java.util.Objects.requireNonNull;
import java.io.Serializable;
import java.util.Locale;
import org.opendaylight.yangtools.yang.common.ErrorTag;
import org.opendaylight.yangtools.yang.common.ErrorType;
import org.opendaylight.yangtools.yang.common.RpcError;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
/**
* Encapsulates a restconf error as defined in the ietf restconf draft.
*
* <br>
* <br>
* <b>Note:</b> Enumerations defined within are provided by the ietf restconf draft.
*
* @author Devin Avery
* See also <a href="https://tools.ietf.org/html/draft-bierman-netconf-restconf-02">RESTCONF</a>.
*/
public class RestconfError implements Serializable {
private static final long serialVersionUID = 1L;
private final ErrorType errorType;
private final ErrorTag errorTag;
private final String errorInfo;
private final String errorAppTag;
private final String errorMessage;
private final YangInstanceIdentifier errorPath;
/**
* Constructs a RestConfError.
*
* @param errorType
* The enumerated type indicating the layer where the error occurred.
* @param errorTag
* The enumerated tag representing a more specific error cause.
* @param errorMessage
* A string which provides a plain text string describing the error.
*/
public RestconfError(final ErrorType errorType, final ErrorTag errorTag, final String errorMessage) {
this(errorType, errorTag, errorMessage, null, null, null);
}
/**
* Constructs a RestConfError object.
*
* @param errorType
* The enumerated type indicating the layer where the error occurred.
* @param errorTag
* The enumerated tag representing a more specific error cause.
* @param errorMessage
* A string which provides a plain text string describing the error.
* @param errorAppTag
* A string which represents an application-specific error tag that further specifies the error cause.
*/
public RestconfError(final ErrorType errorType, final ErrorTag errorTag, final String errorMessage,
final String errorAppTag) {
this(errorType, errorTag, errorMessage, errorAppTag, null, null);
}
/**
* Constructs a RestConfError object.
*
* @param errorType
* The enumerated type indicating the layer where the error occurred.
* @param errorTag
* The enumerated tag representing a more specific error cause.
* @param errorMessage
* A string which provides a plain text string describing the error.
* @param errorPath
* An instance identifier which contains error path
*/
public RestconfError(final ErrorType errorType, final ErrorTag errorTag, final String errorMessage,
final YangInstanceIdentifier errorPath) {
this(errorType, errorTag, errorMessage, null, null, errorPath);
}
/**
* Constructs a RestConfError object.
*
* @param errorType
* The enumerated type indicating the layer where the error occurred.
* @param errorTag
* The enumerated tag representing a more specific error cause.
* @param errorMessage
* A string which provides a plain text string describing the error.
* @param errorAppTag
* A string which represents an application-specific error tag that further specifies the error cause.
* @param errorInfo
* A string, <b>formatted as XML</b>, which contains additional error information.
*/
public RestconfError(final ErrorType errorType, final ErrorTag errorTag, final String errorMessage,
final String errorAppTag, final String errorInfo) {
this(errorType, errorTag, errorMessage, errorAppTag, errorInfo, null);
}
/**
* Constructs a RestConfError object.
*
* @param errorType
* The enumerated type indicating the layer where the error occurred.
* @param errorTag
* The enumerated tag representing a more specific error cause.
* @param errorMessage
* A string which provides a plain text string describing the error.
* @param errorAppTag
* A string which represents an application-specific error tag that further specifies the error cause.
* @param errorInfo
* A string, <b>formatted as XML</b>, which contains additional error information.
* @param errorPath
* An instance identifier which contains error path
*/
public RestconfError(final ErrorType errorType, final ErrorTag errorTag, final String errorMessage,
final String errorAppTag, final String errorInfo, final YangInstanceIdentifier errorPath) {
this.errorType = requireNonNull(errorType, "Error type is required for RestConfError");
this.errorTag = requireNonNull(errorTag, "Error tag is required for RestConfError");
this.errorMessage = errorMessage;
this.errorAppTag = errorAppTag;
this.errorInfo = errorInfo;
this.errorPath = errorPath;
}
/**
* Constructs a RestConfError object from an RpcError.
*/
public RestconfError(final RpcError rpcError) {
errorType = rpcError.getErrorType();
final ErrorTag tag = rpcError.getTag();
errorTag = tag != null ? tag : ErrorTag.OPERATION_FAILED;
errorMessage = rpcError.getMessage();
errorAppTag = rpcError.getApplicationTag();
String localErrorInfo = null;
if (rpcError.getInfo() == null) {
if (rpcError.getCause() != null) {
localErrorInfo = rpcError.getCause().getMessage();
} else if (rpcError.getSeverity() != null) {
localErrorInfo = "<severity>" + rpcError.getSeverity().toString().toLowerCase(Locale.ROOT)
+ "</severity>";
}
} else {
localErrorInfo = rpcError.getInfo();
}
errorInfo = localErrorInfo;
errorPath = null;
}
public ErrorType getErrorType() {
return errorType;
}
public ErrorTag getErrorTag() {
return errorTag;
}
public String getErrorInfo() {
return errorInfo;
}
public String getErrorAppTag() {
return errorAppTag;
}
public String getErrorMessage() {
return errorMessage;
}
public YangInstanceIdentifier getErrorPath() {
return errorPath;
}
@Override
public String toString() {
return "RestconfError ["
+ "error-type: " + errorType.elementBody() + ", error-tag: " + errorTag.elementBody()
+ (errorAppTag != null ? ", error-app-tag: " + errorAppTag : "")
+ (errorMessage != null ? ", error-message: " + errorMessage : "")
+ (errorInfo != null ? ", error-info: " + errorInfo : "")
+ (errorPath != null ? ", error-path: " + errorPath.toString() : "")
+ "]";
}
}
|
