blob: ac1d7f7dbc56eadd37f2d0d903c17b5537933922 (
plain)
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
|
/*
* Copyright (c) 2016 Cisco and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.fd.honeycomb.v3po.vpp.facade;
import com.google.common.annotations.Beta;
import com.google.common.base.Preconditions;
import javax.annotation.Nonnull;
/**
* Thrown when Vpp jAPI method invocation failed.
*/
@Beta
public class VppApiInvocationException extends VppException {
private final String methodName;
private final int ctxId;
private final int errorCode;
/**
* Constructs an VppApiInvocationFailedException with the specified api method name and error code.
*
* @param methodName method name that failed to invoke
* @param ctxId api request context identifier
* @param errorCode negative error code value associated with this failure
* @throws NullPointerException if apiMethodName is null
* @throws IllegalArgumentException if errorCode is nonnegative
*/
public VppApiInvocationException(@Nonnull final String methodName, final int ctxId, final int errorCode) {
super(String.format("vppApi.%s failed with error code: %d (ctxId=%d) ", methodName, errorCode, ctxId));
this.methodName = Preconditions.checkNotNull(methodName, "apiMethodName is null!");
this.ctxId = ctxId;
Preconditions.checkArgument(errorCode < 0);
this.errorCode = errorCode;
}
/**
* Returns method name that failed to invoke.
*
* @return method name
*/
public String getMethodName() {
return methodName;
}
/**
* Returns api request context identifier.
*
* @return value of context identifier
*/
public int getCtxId() {
return ctxId;
}
/**
* Returns the error code associated with this failure.
*
* @return a negative integer error code
*/
public int getErrorCode() {
return errorCode;
}
}
|