1 Developing Apps on the OpenDaylight controller
2 ==============================================
4 This section provides information that is required to develop apps on
5 the OpenDaylight controller.
7 You can either develop apps within the controller using the model-driven
8 SAL (MD-SAL) archetype or develop external apps and use the RESTCONF to
9 communicate with the controller.
14 This section enables you to get started with app development within the
15 OpenDaylight controller. In this example, you perform the following
16 steps to develop an app.
18 1. Create a local repository for the code using a simple build process.
20 2. Start the OpenDaylight controller.
22 3. Test a simple remote procedure call (RPC) which you have created
23 based on the principle of *hello world*.
28 This example requires the following.
30 - A development environment with following set up and working correctly
33 - Maven 3.1.1 or later
35 - Java 7- or Java 8-compliant JDK
37 - An appropriate Maven settings.xml file. A simple way to get the
38 default OpenDaylight settings.xml file is:
42 cp -n ~/.m2/settings.xml{,.orig} ; \wget -q -O - https://raw.githubusercontent.com/opendaylight/odlparent/stable/boron/settings.xml > ~/.m2/settings.xml
46 If you are using Linux or Mac OS X as your development OS, your
47 local repository is ~/.m2/repository. For other platforms the local
48 repository location will vary.
50 Building an example module
51 --------------------------
53 To develop an app perform the following steps.
55 1. Create an *Example* project using Maven and an archetype called the
56 *opendaylight-startup-archetype*. If you are downloading this project
57 for the first time, then it will take sometime to pull all the code
58 from the remote repository.
62 mvn archetype:generate -DarchetypeGroupId=org.opendaylight.controller -DarchetypeArtifactId=opendaylight-startup-archetype \
63 -DarchetypeRepository=https://nexus.opendaylight.org/content/repositories/public/ \
64 -DarchetypeCatalog=https://nexus.opendaylight.org/content/repositories/public/archetype-catalog.xml
66 2. Update the properties values as follows. Ensure that the groupid and
67 the artifactid is lower case.
71 Define value for property 'groupId': : org.opendaylight.example
72 Define value for property 'artifactId': : example
73 Define value for property 'version': 1.0-SNAPSHOT: : 1.0.0-SNAPSHOT
74 Define value for property 'package': org.opendaylight.example: :
75 Define value for property 'classPrefix': ${artifactId.substring(0,1).toUpperCase()}${artifactId.substring(1)}
76 Define value for property 'copyright': : Copyright (c) 2015 Yoyodyne, Inc.
78 3. Accept the default value of classPrefix that is,
79 ``(${artifactId.substring(0,1).toUpperCase()}${artifactId.substring(1)})``.
80 The classPrefix creates a Java Class Prefix by capitalizing the first
81 character of the artifactId.
85 In this scenario, the classPrefix used is "Example". Create a
86 top-level directory for the archetype.
100 4. Build the *example* project.
104 Depending on your development machine’s specification this might
105 take a little while. Ensure that you are in the project’s root
106 directory, example/, and then issue the build command, shown
113 5. Start the *example* project for the first time.
117 cd karaf/target/assembly/bin
121 6. Wait for the karaf cli that appears as follows. Wait for OpenDaylight
122 to fully load all the components. This can take a minute or two after
123 the prompt appears. Check the CPU on your dev machine, specifically
124 the Java process to see when it calms down.
128 opendaylight-user@root>
130 7. Verify if the “example” module is built and search for the log entry
131 which includes the entry *ExampleProvider Session Initiated*.
135 log:display | grep Example
137 8. Shutdown the OpenDaylight through the console by using the following
144 Defining a Simple Hello World RPC
145 ---------------------------------
147 1. | Run the maven archetype *opendaylight-startup-archetype*, and
148 create the *hello* project.
152 mvn archetype:generate -DarchetypeGroupId=org.opendaylight.controller -DarchetypeArtifactId=opendaylight-startup-archetype \
153 -DarchetypeRepository=http://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/ \
154 -DarchetypeCatalog=http://nexus.opendaylight.org/content/repositories/opendaylight.snapshot/archetype-catalog.xml
156 2. Update the Properties values as follows.
160 Define value for property 'groupId': : org.opendaylight.hello
161 Define value for property 'artifactId': : hello
162 Define value for property 'version': 1.0-SNAPSHOT: : 1.0.0-SNAPSHOT
163 Define value for property 'package': org.opendaylight.hello: :
164 Define value for property 'classPrefix': ${artifactId.substring(0,1).toUpperCase()}${artifactId.substring(1)}
165 Define value for property 'copyright': : Copyright(c) Yoyodyne, Inc.
167 3. View the *hello* project.
180 4. Build *hello* project by using the following command.
186 5. Verify that the project is functioning by executing karaf.
190 cd karaf/target/assembly/bin
193 6. | The karaf cli appears as follows.
194 | NOTE: Remember to wait for OpenDaylight to load completely. Verify
195 that the Java process CPU has stabilized.+
199 opendaylight-user@root>
201 7. Verify that the *hello* module is loaded by checking the log.
205 log:display | grep Hello
213 9. Return to the top of the directory structure:
219 10. View the entry point to understand where the log line came from. The
220 entry point is in the impl project:
224 impl/src/main/java/org/opendaylight/hello/impl/HelloProvider.java
226 11. Add any new things that you are doing in your implementation by
227 using the HelloProvider.onSessionInitiate method. Its analogous to
233 public void onSessionInitiated(ProviderContext session) {
234 LOG.info("HelloProvider Session Initiated");
237 Add a simple HelloWorld RPC API
238 -------------------------------
240 1. Navigate to the file.
245 api/src/main/yang/hello.yang
247 2. Edit this file as follows. In the following example, we are adding
248 the code in a YANG module to define the *hello-world* RPC:
254 namespace "urn:opendaylight:params:xml:ns:yang:hello";
256 revision "2015-01-05" {
257 description "Initial revision of hello model";
273 3. Return to the hello/api directory and build your API as follows.
280 Implement the HelloWorld RPC API
281 --------------------------------
283 1. Define the HelloService, which is invoked through the *hello-world*
288 cd ../impl/src/main/java/org/opendaylight/hello/impl/
290 2. Create a new file called HelloWorldImpl.java and add in the code
295 package org.opendaylight.hello.impl;
296 import java.util.concurrent.Future;
297 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev150105.HelloService;
298 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev150105.HelloWorldInput;
299 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev150105.HelloWorldOutput;
300 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev150105.HelloWorldOutputBuilder;
301 import org.opendaylight.yangtools.yang.common.RpcResult;
302 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
303 public class HelloWorldImpl implements HelloService {
305 public Future<RpcResult<HelloWorldOutput>> helloWorld(HelloWorldInput input) {
306 HelloWorldOutputBuilder helloBuilder = new HelloWorldOutputBuilder();
307 helloBuilder.setGreating("Hello " + input.getName());
308 return RpcResultBuilder.success(helloBuilder.build()).buildFuture();
312 3. The HelloProvider.java file is in the current directory. Register the
313 RPC that you created in the *hello.yang* file in the
314 HelloProvider.java file. You can either edit the HelloProvider.java
315 to match what is below or you can simple replace it with the code
321 * Copyright(c) Yoyodyne, Inc. and others. All rights reserved.
323 * This program and the accompanying materials are made available under the
324 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
325 * and is available at http://www.eclipse.org/legal/epl-v10.html
327 package org.opendaylight.hello.impl;
329 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
330 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RpcRegistration;
331 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
332 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.hello.rev150105.HelloService;
333 import org.slf4j.Logger;
334 import org.slf4j.LoggerFactory;
336 public class HelloProvider implements BindingAwareProvider, AutoCloseable {
337 private static final Logger LOG = LoggerFactory.getLogger(HelloProvider.class);
338 private RpcRegistration<HelloService> helloService;
340 public void onSessionInitiated(ProviderContext session) {
341 LOG.info("HelloProvider Session Initiated");
342 helloService = session.addRpcImplementation(HelloService.class, new HelloWorldImpl());
345 public void close() throws Exception {
346 LOG.info("HelloProvider Closed");
347 if (helloService != null) {
348 helloService.close();
353 4. Optionally, you can also build the Java classes which will register
354 the new RPC. This is useful to test the edits you have made to
355 HelloProvider.java and HelloWorldImpl.java.
359 cd ../../../../../../../
362 5. Return to the top level directory
368 6. Build the entire *hello* again, which will pickup the changes you
369 have made and build them into your project:
375 Execute the *hello* project for the first time
376 ----------------------------------------------
382 cd ../karaf/target/assembly/bin
385 2. Wait for the project to load completely. Then view the log to see the
386 loaded *Hello* Module:
390 log:display | grep Hello
392 Test the *hello-world* RPC via REST
393 -----------------------------------
395 There are a lot of ways to test your RPC. Following are some examples.
397 1. Using the API Explorer through HTTP
399 2. Using a browser REST client
401 Using the API Explorer through HTTP
402 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
404 1. | Navigate to `apidoc
405 UI <http://localhost:8181/apidoc/explorer/index.html>`__ with your
407 | NOTE: In the URL mentioned above, Change *localhost* to the IP/Host
408 name to reflect your development machine’s network address.
420 POST /operations/hello:hello-world
422 4. Provide the required value.
426 {"hello:input": { "name":"Your Name"}}
430 6. Enter the username and password, by default the credentials are
433 7. In the response body you should see.
439 "greating": "Hello Your Name"
443 Using a browser REST client
444 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
446 | For example, use the following information in the Firefox plugin
448 [`https://github.com/chao/RESTClient} <https://github.com/chao/RESTClient}>`__
452 POST: http://192.168.1.43:8181/restconf/operations/hello:hello-world
472 If you get a response code 501 while attempting to POST
473 /operations/hello:hello-world, check the file: HelloProvider.java and
474 make sure the helloService member is being set. By not invoking
475 "session.addRpcImplementation()" the REST API will be unable to map
476 /operations/hello:hello-world url to HelloWorldImpl.