2 * Copyright (c) 2013, 2015 EBay Software Foundation and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.ovsdb.lib.jsonrpc;
11 import com.fasterxml.jackson.core.JsonProcessingException;
12 import com.fasterxml.jackson.databind.JavaType;
13 import com.fasterxml.jackson.databind.JsonNode;
14 import com.fasterxml.jackson.databind.ObjectMapper;
15 import com.fasterxml.jackson.databind.type.TypeFactory;
16 import com.google.common.collect.Maps;
17 import com.google.common.reflect.Invokable;
18 import com.google.common.reflect.Reflection;
19 import com.google.common.reflect.TypeToken;
20 import com.google.common.util.concurrent.ListenableFuture;
21 import com.google.common.util.concurrent.SettableFuture;
22 import com.google.common.util.concurrent.ThreadFactoryBuilder;
23 import io.netty.channel.Channel;
24 import java.lang.reflect.InvocationHandler;
25 import java.lang.reflect.InvocationTargetException;
26 import java.lang.reflect.Method;
27 import java.util.List;
29 import java.util.UUID;
30 import java.util.concurrent.Executors;
31 import java.util.concurrent.ScheduledExecutorService;
32 import java.util.concurrent.ThreadFactory;
33 import java.util.concurrent.TimeUnit;
35 import org.opendaylight.ovsdb.lib.error.UnexpectedResultException;
36 import org.opendaylight.ovsdb.lib.error.UnsupportedArgumentException;
37 import org.opendaylight.ovsdb.lib.message.OvsdbRPC;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
41 public class JsonRpcEndpoint {
43 private static final Logger LOG = LoggerFactory.getLogger(JsonRpcEndpoint.class);
44 private static final int REAPER_INTERVAL = 300;
45 private static final int REAPER_THREADS = 3;
46 private static final ThreadFactory futureReaperThreadFactory = new ThreadFactoryBuilder()
47 .setNameFormat("OVSDB-Lib-Future-Reaper-%d").build();
48 private static final ScheduledExecutorService futureReaperService
49 = Executors.newScheduledThreadPool(REAPER_THREADS, futureReaperThreadFactory);
51 public class CallContext {
53 JsonRpc10Request request;
54 SettableFuture<Object> future;
56 public CallContext(JsonRpc10Request request, Method method, SettableFuture<Object> future) {
58 this.request = request;
62 public Method getMethod() {
66 public JsonRpc10Request getRequest() {
70 public SettableFuture<Object> getFuture() {
75 ObjectMapper objectMapper;
77 Map<String, CallContext> methodContext = Maps.newHashMap();
78 Map<Object, OvsdbRPC.Callback> requestCallbacks = Maps.newHashMap();
80 public JsonRpcEndpoint(ObjectMapper objectMapper, Channel channel) {
81 this.objectMapper = objectMapper;
82 this.nettyChannel = channel;
85 public <T> T getClient(final Object context, Class<T> klazz) {
87 return Reflection.newProxy(klazz, new InvocationHandler() {
89 public Object invoke(Object proxy, Method method, Object[] args) throws Exception {
90 if (method.getName().equals(OvsdbRPC.REGISTER_CALLBACK_METHOD)) {
91 if ((args == null) || args.length != 1 || !(args[0] instanceof OvsdbRPC.Callback)) {
94 requestCallbacks.put(context, (OvsdbRPC.Callback)args[0]);
98 JsonRpc10Request request = new JsonRpc10Request(UUID.randomUUID().toString());
99 request.setMethod(method.getName());
101 if (args != null && args.length != 0) {
102 List<Object> params = null;
104 if (args.length == 1) {
105 if (args[0] instanceof Params) {
106 params = ((Params) args[0]).params();
107 } else if (args[0] instanceof List) {
108 params = (List<Object>) args[0];
111 if (params == null) {
112 throw new UnsupportedArgumentException("do not understand this argument yet");
114 request.setParams(params);
118 String requestString = objectMapper.writeValueAsString(request);
119 LOG.trace("getClient Request : {}", requestString);
121 SettableFuture<Object> sf = SettableFuture.create();
122 methodContext.put(request.getId(), new CallContext(request, method, sf));
123 futureReaperService.schedule(new Runnable() {
126 if (sf.isDone() || sf.isCancelled()) {
129 methodContext.remove(request.getId()).getFuture().cancel(false);
131 },REAPER_INTERVAL, TimeUnit.MILLISECONDS);
133 nettyChannel.writeAndFlush(requestString);
141 public void processResult(JsonNode response) throws NoSuchMethodException {
143 LOG.trace("Response : {}", response.toString());
144 CallContext returnCtxt = methodContext.remove(response.get("id").asText());
145 if (returnCtxt == null) {
149 if (ListenableFuture.class == returnCtxt.getMethod().getReturnType()) {
150 TypeToken<?> retType = TypeToken.of(
151 returnCtxt.getMethod().getGenericReturnType())
152 .resolveType(ListenableFuture.class.getMethod("get").getGenericReturnType());
153 JavaType javaType = TypeFactory.defaultInstance().constructType(retType.getType());
155 JsonNode result = response.get("result");
156 Object result1 = objectMapper.convertValue(result, javaType);
157 JsonNode error = response.get("error");
158 if (error != null && !error.isNull()) {
159 LOG.error("Error : {}", error.toString());
162 returnCtxt.getFuture().set(result1);
165 throw new UnexpectedResultException("Don't know how to handle this");
169 public void processRequest(Object context, JsonNode requestJson) {
170 JsonRpc10Request request = new JsonRpc10Request(requestJson.get("id").asText());
171 request.setMethod(requestJson.get("method").asText());
172 LOG.trace("Request : {} {} {}", requestJson.get("id"), requestJson.get("method"),
173 requestJson.get("params"));
174 OvsdbRPC.Callback callback = requestCallbacks.get(context);
175 if (callback != null) {
176 Method[] methods = callback.getClass().getDeclaredMethods();
177 for (Method method : methods) {
178 if (method.getName().equals(request.getMethod())) {
179 Class<?>[] parameters = method.getParameterTypes();
180 JsonNode params = requestJson.get("params");
181 Object param = objectMapper.convertValue(params, parameters[1]);
183 Invokable from = Invokable.from(method);
184 from.setAccessible(true);
185 from.invoke(callback, context, param);
186 } catch (IllegalAccessException | InvocationTargetException e) {
187 LOG.error("Unable to invoke callback {}", method.getName(), e);
194 // Echo dont need any special processing. hence handling it internally.
196 if (request.getMethod().equals("echo")) {
197 JsonRpc10Response response = new JsonRpc10Response(request.getId());
198 response.setError(null);
199 String jsonString = null;
201 jsonString = objectMapper.writeValueAsString(response);
202 nettyChannel.writeAndFlush(jsonString);
203 } catch (JsonProcessingException e) {
204 LOG.error("Exception while processing JSON string {}", jsonString, e);
209 // send a null response for list_dbs
210 if (request.getMethod().equals("list_dbs")) {
211 JsonRpc10Response response = new JsonRpc10Response(request.getId());
212 response.setError(null);
213 String jsonString = null;
215 jsonString = objectMapper.writeValueAsString(response);
216 nettyChannel.writeAndFlush(jsonString);
217 } catch (JsonProcessingException e) {
218 LOG.error("Exception while processing JSON string {}", jsonString, e);
223 LOG.error("No handler for Request : {} on {}", requestJson.toString(), context);
226 public Map<String, CallContext> getMethodContext() {
227 return methodContext;