#!/usr/bin/env python # # 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. import os from string import Template import dto_gen import util jvpp_facade_callback_template = Template(""" package $plugin_package.$future_package; /** *
Async facade callback setting values to future objects
* Async facade extension adding specific methods for each request invocation
* Implementation of FutureJVpp based on AbstractFutureJVppInvoker
* Create FutureJVpp${plugin_name}Facade object for provided JVpp instance.
* Constructor internally creates FutureJVppFacadeCallback class for processing callbacks
* and then connects to provided JVpp instance
*
* @param jvpp provided $base_package.JVpp instance
*
* @throws java.io.IOException in case instance cannot connect to JVPP
*/
public FutureJVpp${plugin_name}Facade(final $base_package.JVppRegistry registry, final $base_package.JVpp jvpp) throws java.io.IOException {
super(jvpp, registry, new java.util.HashMap<>());
java.util.Objects.requireNonNull(registry, "JVppRegistry should not be null");
registry.register(jvpp, new FutureJVpp${plugin_name}FacadeCallback(getRequests(), eventRegistry));
}
@Override
public $plugin_package.$notification_package.${plugin_name}EventRegistry getEventRegistry() {
return eventRegistry;
}
$methods
}
''')
future_jvpp_method_impl_template = Template('''
@Override
public java.util.concurrent.CompletionStage<$plugin_package.$dto_package.$reply_name> $method_name($plugin_package.$dto_package.$request_name request) {
return send(request);
}
''')
future_jvpp_dump_method_impl_template = Template('''
@Override
public java.util.concurrent.CompletionStage<$plugin_package.$dto_package.$reply_name> $method_name($plugin_package.$dto_package.$request_name request) {
return send(request, new $plugin_package.$dto_package.$reply_name());
}
''')
def generate_callback(func_list, base_package, plugin_package, plugin_name, dto_package, callback_package, notification_package, future_facade_package, inputfile):
callbacks = []
for func in func_list:
camel_case_name_with_suffix = util.underscore_to_camelcase_upper(func['name'])
if util.is_control_ping(camel_case_name_with_suffix):
# Skip control ping managed by jvpp registry.
continue
if util.is_dump(func['name']) or util.is_request(func['name'], func_list):
continue
# Generate callbacks for all messages except for dumps and requests (handled by vpp, not client).
if util.is_details(camel_case_name_with_suffix):
# Callbacks for detail messages that append replies to a list.
camel_case_method_name = util.underscore_to_camelcase(func['name'])
camel_case_reply_name = util.underscore_to_camelcase_upper(func['name'])
callbacks.append(jvpp_facade_details_callback_method_template.substitute(base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_dto=camel_case_name_with_suffix,
callback_dto_field=camel_case_method_name,
callback_dto_reply_dump=camel_case_reply_name + dto_gen.dump_dto_suffix,
future_package=future_facade_package))
elif util.is_reply(camel_case_name_with_suffix):
request_dto = util.remove_reply_suffix(util.underscore_to_camelcase_upper(func['name']))
callbacks.append(jvpp_facade_callback_method_template.substitute(base_package=base_package,
plugin_package=plugin_package,
dto_package=dto_package,
callback_dto=camel_case_name_with_suffix,
request_dto=request_dto))
else:
callbacks.append(jvpp_facade_callback_notification_method_template.substitute(plugin_package=plugin_package,
dto_package=dto_package,
callback_dto=camel_case_name_with_suffix))
jvpp_file = open(os.path.join(future_facade_package, "FutureJVpp%sFacadeCallback.java" % plugin_name), 'w')
jvpp_file.write(jvpp_facade_callback_template.substitute(inputfile=inputfile,
base_package=base_package,
plugin_package=plugin_package,
plugin_name=plugin_name,
dto_package=dto_package,
notification_package=notification_package,
callback_package=callback_package,
methods="".join(callbacks),
future_package=future_facade_package))
jvpp_file.flush()
jvpp_file.close()
It was generated by jvpp_future_facade_gen.py based on $inputfile
*
(python representation of api file generated by vppapigen).
*/
public final class FutureJVpp${plugin_name}FacadeCallback implements $plugin_package.$callback_package.JVpp${plugin_name}GlobalCallback {
private final java.util.Map
It was generated by jvpp_future_facade_gen.py based on $inputfile
*
(python representation of api file generated by vppapigen).
*/
public interface FutureJVpp${plugin_name} extends $base_package.$future_package.FutureJVppInvoker {
$methods
@Override
public $plugin_package.$notification_package.${plugin_name}EventRegistry getEventRegistry();
}
''')
future_jvpp_method_template = Template('''
java.util.concurrent.CompletionStage<$plugin_package.$dto_package.$reply_name> $method_name($plugin_package.$dto_package.$request_name request);
''')
future_jvpp_facade_template = Template('''
package $plugin_package.$future_package;
/**
*
It was generated by jvpp_future_facade_gen.py based on $inputfile
*
(python representation of api file generated by vppapigen).
*/
public class FutureJVpp${plugin_name}Facade extends $base_package.$future_package.AbstractFutureJVppInvoker implements FutureJVpp${plugin_name} {
private final $plugin_package.$notification_package.${plugin_name}EventRegistryImpl eventRegistry = new $plugin_package.$notification_package.${plugin_name}EventRegistryImpl();
/**
*