Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

We create the following class skeleton for our new command, tentatively named ForwardingMapCommand. The Our class is a child of AbstractShellCommand, and the @Command annotation is used to set its name, scope, and description.

Code Block
languagejava
titleForwardingMapCommand.java
collapsetrue
/*
 * Copyright 2014 Open Networking Laboratory
 *
 * 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 org.onlab.onos.cli.net;


import org.apache.karaf.shell.commands.Command;
import org.onlab.onos.cli.AbstractShellCommand;


/**
 * Lists the endpoints for which intents are installed
 */
@Command(scope = "onos", name = "fwdmap",
        description = "Lists the endpoints for which intents are installed")
public class ForwardingMapCommand extends AbstractShellCommand {

    @Override
    protected void execute() {
    }
}

...

2. Register command with Karaf CLI

...

Next, we need to tell Karaf about our new command by editing shell-config.xml, located in ONOS_ROOT/cli/src/main/resources/OSGI-INF/blueprint/. We add the following between the <command-bundle></command-bundle> clause:

Code Block
languagexml
titleshell-config.xml
        <command>
            <action class="org.onlab.onos.cli.net.ForwardingMapCommand"/>
            <completers>
                <ref component-id="deviceIdCompleter"/>
                <null/>
            </completers>
        </command>