OpenDaylight Carbon二次开发实用指南

1

https://github.com/opendaylight/controller/tree/master/opendaylight/archetypes

https://github.com/opendaylight/controller/blob/release/carbon-sr1/opendaylight/archetypes/opendaylight-startup/src/main/resources/archetype-resources/impl/src/main/java/__packageInPathFormat__/impl/__classPrefix__Provider.java

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

/*

* Copyright © ${copyrightYear} ${copyright} and others.  All rights reserved.

*

* This program and the accompanying materials are made available under the

* terms of the Eclipse Public License v1.0 which accompanies this distribution,

* and is available at http://www.eclipse.org/legal/epl-v10.html

*/

package ${package}.impl;

import org.opendaylight.controller.md.sal.binding.api.DataBroker;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class ${classPrefix}Provider {

    private static final Logger LOG = LoggerFactory.getLogger(${classPrefix}Provider.class);

    private final DataBroker dataBroker;

    public ${classPrefix}Provider(final DataBroker dataBroker) {

        this.dataBroker = dataBroker;

    }

    /**

     * Method called when the blueprint container is created.

     */

    public void init() {

        LOG.info("${classPrefix}Provider Session Initiated");

    }

    /**

     * Method called when the blueprint container is destroyed.

     */

    public void close() {

        LOG.info("${classPrefix}Provider Closed");

    }

}

<groupId>org.opendaylight.controller</groupId>

<artifactId>opendaylight-startup-archetype</artifactId>

<version>1.3.1-Carbon</version>

# 下载controller项目

git clone https://github.com/opendaylight/controller.git

# 进入controller目录

cd controller

# 切换到carbon-sr1版本

git checkout release/carbon-sr1

# 进入Archetype/opendaylight-startup目录

cd opendaylight/archetypes/opendaylight-startup/

# 将Archetype安装到本地仓库

mvn clean install

mvn archetype:generate -B \

  -DarchetypeGroupId=org.opendaylight.controller \

  -DarchetypeArtifactId=opendaylight-startup-archetype \

  -DarchetypeVersion=1.3.1-Carbon \

  -DgroupId=snlab \

  -DartifactId=helloworld \

  -DclassPrefix=HelloWorld \

  -Dcopyright=snlab \

  -DcopyrightYear=2017

# 进入helloworld目录

cd helloworld

# 查看该目录下的内容，对于该目录下的内容详见第二章

ll

# 编译helloword，并将相应artifact安装到本地Maven仓库

mvn clean install

api/

artifacts/

cli/

features/

impl/

it/

karaf/

src/

├── pom.xml

└── src

    └── main

        ├── java

        │   └── snlab

        │       └── cli

        │           ├── api

        │           │   └── HelloworldCliCommands.java

        │           ├── commands

        │           │   └── HelloworldCliTestCommand.java

        │           └── impl

        │               └── HelloworldCliCommandsImpl.java

        └── resources

            └── org

                └── opendaylight

                    └── blueprint

                        └── cli-blueprint.xml

1

Object testCommand(Object testArgument);

// HelloworldCliTestCommand.java

/**

* This is an example class. The class name can be renamed to match the command implementation that it will invoke.

* Specify command details by updating the fields in the Command annotation below.

*/

@Command(name = "test-command", scope = "add the scope of the command, usually project name", description= "add a description for the command")

public class HelloworldCliTestCommand extends AbstractAction {

    private static final Logger LOG = LoggerFactory.getLogger(HelloworldCliTestCommand.class);

    protected final HelloworldCliCommands service;

    public HelloworldCliTestCommand(final HelloworldCliCommands service) {

        this.service = service;

    }

    /**

     * Add the arguments required by the command.

     * Any number of arguments can be added using the Option annotation

     * The below argument is just an example and should be changed as per your requirements

     */

    @Option(name = "-tA",

            aliases = { "--testArgument" },

            description = "test command argument",

            required = true,

            multiValued = false)

    private Object testArgument;

    @Override

    protected Object doExecute() throws Exception {

        /**

         * Invoke commannd implementation here using the service instance.

         * Implement how you want the output of the command to be displayed.

         * Below is just an example.

         */

        final String testMessage = (String) service.testCommand(testArgument);

        return testMessage;

    }

}

// HelloworldCliCommandsImpl.java

public class HelloworldCliCommandsImpl implements HelloworldCliCommands {

    private static final Logger LOG = LoggerFactory.getLogger(HelloworldCliCommandsImpl.class);

    private final DataBroker dataBroker;

    public HelloworldCliCommandsImpl(final DataBroker db) {

        this.dataBroker = db;

        LOG.info("HelloworldCliCommandImpl initialized");

    }

    @Override

    public Object testCommand(Object testArgument) {

        return "This is a test implementation of test-command";

    }

}

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"

  xmlns:odl="http://opendaylight.org/xmlns/blueprint/v1.0.0"

  odl:use-default-for-reference-types="true&">

  <reference id="dataBroker"

    interface="org.opendaylight.controller.md.sal.binding.api.DataBroker"

    odl:type="default" />

  <bean id="cliCommandsImpl" class="snlab.cli.impl.HelloworldCliCommandsImpl">

    <argument ref="dataBroker" />

  </bean>

  <service ref="cliCommandsImpl" odl:type="default"

    interface="snlab.cli.api.HelloworldCliCommands" />

  <command-bundle xmlns="http://karaf.apache.org/xmlns/shell/v1.0.0">

        <command name="test-command">

            <action class="snlab.cli.commands.HelloworldCliTestCommand">

                <argument ref="cliCommandsImpl"/>

            </action>

        </command>

  </command-bundle>

</blueprint>

/bin：包含了开始、停止、登陆等脚本。

/etc：配置文件

/data：工作目录

  /data/cache: OSGi框架bundle的缓存

  /data/generated-bundles: 部署者使用的临时文件

  /data/log: log文件

/deploy：热部署目录

/lib：包含类

/system：OSGi bundles仓库

1

https://www.opendaylight.org/technical-community/getting-started-for-developers/downloads-and-documentation

org.ops4j.pax.url.mvn.defaultRepositories=\ file:${karaf.home}/${karaf.default.repository}@id=system.repository@snapshots,\ file:${karaf.data}/kar@id=kar.repository@multi@snapshots

# 安装自己的编译生成的kar包到控制器。kar包的位置位于helloworld/features/target下

opendaylight-user@root&gt; kar:installfile:/Users/shawn/Develop/alto-sdnlab/helloworld/features/target/helloworld-features-0.1.0-SNAPSHOT.kar

# 可以看到我们的项目helloworld已经被加入到正在运行的ODL Carbon SR1控制器上

opendaylight-user@root&gt; feature:list | grep hello

odl-helloworld-api                               | 0.1.0-SNAPSHOT  | x         | odl-helloworld-0.1.0-SNAPSHOT             | OpenDaylight :: helloworld :: api                

odl-helloworld                                   | 0.1.0-SNAPSHOT   |x         | odl-helloworld-0.1.0-SNAPSHOT             | OpenDaylight :: helloworld                        

odl-helloworld-rest                              | 0.1.0-SNAPSHOT  | x         | odl-helloworld-0.1.0-SNAPSHOT             | OpenDaylight :: helloworld :: REST                

odl-helloworld-ui                                | 0.1.0-SNAPSHOT  | x         | odl-helloworld-0.1.0-SNAPSHOT             | OpenDaylight :: helloworld :: UI                  

odl-helloworld-cli                               | 0.1.0-SNAPSHOT  | x         | odl-helloworld-0.1.0-SNAPSHOT             | OpenDaylight :: helloworld :: CLI

# 查看我们的项目helloworld中打印的log信息

opendaylight-user@root&gt;log:display | grep hello

......

2017-09-22 20:21:29,543 | INFO  | l for user karaf | helloworldCliCommandsImpl        | 297 - snlab.helloworld-cli - 0.1.0.SNAPSHOT | helloworldCliCommandImpl initialized

......