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
|
/*
* 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.translate.vpp.util;
import static com.google.common.base.Preconditions.checkArgument;
import io.fd.honeycomb.translate.read.ReadFailedException;
import io.fd.honeycomb.translate.write.WriteFailedException;
import io.fd.vpp.jvpp.VppBaseCallException;
import io.fd.vpp.jvpp.dto.JVppReply;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
/**
* Trait providing logic for consuming reply's to jvpp api calls
*/
public interface JvppReplyConsumer {
int DEFAULT_TIMEOUT_IN_SECONDS = 5;
/**
* Consumes reply for jvpp call representing any write operation
* Should be used in case of calls where it's not clear which write crud operation respective
* call represents, for ex. setRouting
*/
default <REP extends JVppReply<?>> REP getReplyForWrite(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType)
throws WriteFailedException {
return getReplyForWrite(future, replyType, DEFAULT_TIMEOUT_IN_SECONDS);
}
/**
* Consumes reply for jvpp call representing any write operation
* Should be used in case of calls where it's not clear which write crud operation respective
* call represents, for ex. setRouting
*/
default <REP extends JVppReply<?>> REP getReplyForWrite(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType,
@Nonnegative final int timeoutInSeconds)
throws WriteFailedException {
try {
return getReply(future, timeoutInSeconds);
} catch (TimeoutException e) {
throw new WriteTimeoutException(replyType, e);
} catch (VppBaseCallException e) {
throw new WriteFailedException(replyType, e);
}
}
/**
* Consumes reply for jvpp call representing create operation
*/
default <REP extends JVppReply<?>> REP getReplyForCreate(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType,
@Nonnull final DataObject data)
throws WriteFailedException {
return getReplyForCreate(future, replyType, data, DEFAULT_TIMEOUT_IN_SECONDS);
}
/**
* Consumes reply for jvpp call representing create operation
*/
default <REP extends JVppReply<?>> REP getReplyForCreate(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType,
@Nonnull final DataObject data,
@Nonnegative final int timeoutInSeconds)
throws WriteFailedException {
try {
return getReply(future, timeoutInSeconds);
} catch (VppBaseCallException e) {
throw new WriteFailedException.CreateFailedException(replyType, data, e);
} catch (TimeoutException e) {
throw new WriteTimeoutException(replyType, e);
}
}
/**
* Consumes reply for jvpp call representing update operation
*/
default <REP extends JVppReply<?>> REP getReplyForUpdate(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType,
@Nonnull final DataObject dataBefore,
@Nonnull final DataObject dataAfter)
throws WriteFailedException {
return getReplyForUpdate(future, replyType, dataBefore, dataAfter, DEFAULT_TIMEOUT_IN_SECONDS);
}
/**
* Consumes reply for jvpp call representing update operation
*/
default <REP extends JVppReply<?>> REP getReplyForUpdate(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType,
@Nonnull final DataObject dataBefore,
@Nonnull final DataObject dataAfter,
@Nonnegative final int timeoutInSeconds)
throws WriteFailedException {
try {
return getReply(future, timeoutInSeconds);
} catch (VppBaseCallException e) {
throw new WriteFailedException.UpdateFailedException(replyType, dataBefore, dataAfter, e);
} catch (TimeoutException e) {
throw new WriteTimeoutException(replyType, e);
}
}
/**
* Consumes reply for jvpp call representing delete operation
*/
default <REP extends JVppReply<?>> REP getReplyForDelete(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType)
throws WriteFailedException {
return getReplyForDelete(future, replyType, DEFAULT_TIMEOUT_IN_SECONDS);
}
/**
* Consumes reply for jvpp call representing delete operation
*/
default <REP extends JVppReply<?>> REP getReplyForDelete(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType,
@Nonnegative final int timeoutInSeconds)
throws WriteFailedException {
try {
return getReply(future, timeoutInSeconds);
} catch (VppBaseCallException e) {
throw new WriteFailedException.DeleteFailedException(replyType, e);
} catch (TimeoutException e) {
throw new WriteTimeoutException(replyType, e);
}
}
default <REP extends JVppReply<?>> REP getReplyForRead(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType)
throws ReadFailedException {
return getReplyForRead(future, replyType, DEFAULT_TIMEOUT_IN_SECONDS);
}
default <REP extends JVppReply<?>> REP getReplyForRead(@Nonnull Future<REP> future,
@Nonnull final InstanceIdentifier<?> replyType,
@Nonnegative final int timeoutInSeconds)
throws ReadFailedException {
try {
return getReply(future, timeoutInSeconds);
} catch (TimeoutException e) {
throw new ReadTimeoutException(replyType, e);
} catch (VppBaseCallException e) {
throw new ReadFailedException(replyType, e);
}
}
default <REP extends JVppReply<?>> REP getReply(@Nonnull Future<REP> future)
throws TimeoutException, VppBaseCallException {
return getReply(future, DEFAULT_TIMEOUT_IN_SECONDS);
}
default <REP extends JVppReply<?>> REP getReply(@Nonnull Future<REP> future,
@Nonnegative final int timeoutInSeconds)
throws TimeoutException, VppBaseCallException {
try {
checkArgument(timeoutInSeconds > 0, "Timeout cannot be < 0");
return future.get(timeoutInSeconds, TimeUnit.SECONDS);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new IllegalStateException("Interrupted", e);
} catch (ExecutionException e) {
// Execution exception could generally contains any exception
// when using exceptions instead of return codes just rethrow it for processing on corresponding place
if (e instanceof ExecutionException && (e.getCause() instanceof VppBaseCallException)) {
throw (VppBaseCallException) (e.getCause());
}
throw new IllegalStateException(e);
}
}
}
|
