org.onosproject.cli.net

Class DevicesListCommand

java.lang.Object

org.apache.karaf.shell.console.AbstractAction

org.apache.karaf.shell.console.OsgiCommandSupport

org.onosproject.cli.AbstractShellCommand

org.onosproject.cli.net.DevicesListCommand

All Implemented Interfaces:

org.apache.felix.gogo.commands.Action, org.apache.karaf.shell.console.BundleContextAware

Direct Known Subclasses:

DevicePortsListCommand

public class DevicesListCommand
extends AbstractShellCommand

Lists all infrastructure devices.

Field Summary

Fields inherited from class org.apache.karaf.shell.console.OsgiCommandSupport

bundleContext, usedReferences

Fields inherited from class org.apache.karaf.shell.console.AbstractAction

log, session

Constructor Summary

Constructors

Constructor and Description
DevicesListCommand()

Method Summary

Modifier and Type	Method and Description
protected void	execute() Executes this command.
static List<org.onosproject.net.Device>	getSortedDevices(org.onosproject.net.device.DeviceService service) Returns the list of devices sorted using the device ID URIs.
static com.fasterxml.jackson.databind.JsonNode	json(org.onosproject.net.device.DeviceService service, Iterable<org.onosproject.net.Device> devices) Returns JSON node representing the specified devices.
static com.fasterxml.jackson.databind.node.ObjectNode	json(org.onosproject.net.device.DeviceService service, com.fasterxml.jackson.databind.ObjectMapper mapper, org.onosproject.net.Device device) Returns JSON node representing the specified device.
protected void	printDevice(org.onosproject.net.device.DeviceService service, org.onosproject.net.Device device) Prints information about the specified device.

Methods inherited from class org.onosproject.cli.AbstractShellCommand

annotations, annotations, appId, doExecute, error, get, outputJson, print

Methods inherited from class org.apache.karaf.shell.console.OsgiCommandSupport

execute, getAllServices, getBundleContext, getService, getService, getService, setBundleContext, ungetServices

Methods inherited from class org.apache.karaf.shell.console.AbstractAction

checkInterrupted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DevicesListCommand

public DevicesListCommand()

Method Detail

execute

protected void execute()

Description copied from class: AbstractShellCommand

Executes this command.

Specified by:

execute in class AbstractShellCommand

json

public static com.fasterxml.jackson.databind.JsonNode json(org.onosproject.net.device.DeviceService service,
                                                           Iterable<org.onosproject.net.Device> devices)

Returns JSON node representing the specified devices.

Parameters:

service - device service

devices - collection of devices

Returns:

JSON node

json

public static com.fasterxml.jackson.databind.node.ObjectNode json(org.onosproject.net.device.DeviceService service,
                                                                  com.fasterxml.jackson.databind.ObjectMapper mapper,
                                                                  org.onosproject.net.Device device)

Returns JSON node representing the specified device.

Parameters:

service - device service

mapper - object mapper

device - infrastructure device

Returns:

JSON node

getSortedDevices

public static List<org.onosproject.net.Device> getSortedDevices(org.onosproject.net.device.DeviceService service)

Returns the list of devices sorted using the device ID URIs.

Parameters:

service - device service

Returns:

sorted device list

printDevice

protected void printDevice(org.onosproject.net.device.DeviceService service,
                           org.onosproject.net.Device device)

Prints information about the specified device.

Parameters:

service - device service

device - infrastructure device