org.onosproject.protocol.rest

Class DefaultRestSBDevice

java.lang.Object

org.onosproject.protocol.rest.DefaultRestSBDevice

All Implemented Interfaces:

RestSBDevice

public class DefaultRestSBDevice
extends Object
implements RestSBDevice

Default implementation for Rest devices.

Constructor Summary

Constructors

Constructor and Description
DefaultRestSBDevice(org.onlab.packet.IpAddress ip, int port, String name, String password, String protocol, String url, boolean isActive)
DefaultRestSBDevice(org.onlab.packet.IpAddress ip, int port, String name, String password, String protocol, String url, boolean isActive, String testUrl, String manufacturer, String hwVersion, String swVersion)

Method Summary

Modifier and Type	Method and Description
org.onosproject.net.DeviceId	deviceId() Returns the ONOS deviceID for this device.
boolean	equals(Object obj)
int	hashCode()
Optional<String>	hwVersion() The hardware version of the rest device.
org.onlab.packet.IpAddress	ip() Returns the ip of this device.
boolean	isActive() Returns the state of this device.
boolean	isProxy() Returns the proxy state of this device (if true, the device is proxying multiple ONOS devices).
Optional<String>	manufacturer() The manufacturer of the rest device.
String	password() Returns the password of this device.
int	port() Returns the password of this device.
String	protocol() Returns the protocol for the REST request, usually HTTP o HTTPS.
void	setActive(boolean active) Sets or unsets the state of the device.
Optional<String>	swVersion() The software version of rest device.
Optional<String>	testUrl() Returns the url for the REST TEST requests.
String	toString()
String	url() Returns the url for the REST requests, to be used instead of IP and PORT.
String	username() Returns the username of this device.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultRestSBDevice

public DefaultRestSBDevice(org.onlab.packet.IpAddress ip,
                           int port,
                           String name,
                           String password,
                           String protocol,
                           String url,
                           boolean isActive)

DefaultRestSBDevice

public DefaultRestSBDevice(org.onlab.packet.IpAddress ip,
                           int port,
                           String name,
                           String password,
                           String protocol,
                           String url,
                           boolean isActive,
                           String testUrl,
                           String manufacturer,
                           String hwVersion,
                           String swVersion)

Method Detail

ip

public org.onlab.packet.IpAddress ip()

Description copied from interface: RestSBDevice

Returns the ip of this device.

Specified by:

ip in interface RestSBDevice

Returns:

ip

port

public int port()

Description copied from interface: RestSBDevice

Returns the password of this device.

Specified by:

port in interface RestSBDevice

Returns:

port

username

public String username()

Description copied from interface: RestSBDevice

Returns the username of this device.

Specified by:

username in interface RestSBDevice

Returns:

username

password

public String password()

Description copied from interface: RestSBDevice

Returns the password of this device.

Specified by:

password in interface RestSBDevice

Returns:

password

deviceId

public org.onosproject.net.DeviceId deviceId()

Description copied from interface: RestSBDevice

Returns the ONOS deviceID for this device.

Specified by:

deviceId in interface RestSBDevice

Returns:

DeviceId

setActive

public void setActive(boolean active)

Description copied from interface: RestSBDevice

Sets or unsets the state of the device.

Specified by:

setActive in interface RestSBDevice

Parameters:

active - boolean

isActive

public boolean isActive()

Description copied from interface: RestSBDevice

Returns the state of this device.

Specified by:

isActive in interface RestSBDevice

Returns:

state

protocol

public String protocol()

Description copied from interface: RestSBDevice

Returns the protocol for the REST request, usually HTTP o HTTPS.

Specified by:

protocol in interface RestSBDevice

Returns:

protocol

url

public String url()

Description copied from interface: RestSBDevice

Returns the url for the REST requests, to be used instead of IP and PORT.

Specified by:

url in interface RestSBDevice

Returns:

url

isProxy

public boolean isProxy()

Description copied from interface: RestSBDevice

Returns the proxy state of this device (if true, the device is proxying multiple ONOS devices).

Specified by:

isProxy in interface RestSBDevice

Returns:

proxy state

testUrl

public Optional<String> testUrl()

Description copied from interface: RestSBDevice

Returns the url for the REST TEST requests.

Specified by:

testUrl in interface RestSBDevice

Returns:

testUrl

manufacturer

public Optional<String> manufacturer()

Description copied from interface: RestSBDevice

The manufacturer of the rest device.

Specified by:

manufacturer in interface RestSBDevice

Returns:

the name of the manufacturer

hwVersion

public Optional<String> hwVersion()

Description copied from interface: RestSBDevice

The hardware version of the rest device.

Specified by:

hwVersion in interface RestSBDevice

Returns:

the hardware version

swVersion

public Optional<String> swVersion()

Description copied from interface: RestSBDevice

The software version of rest device.

Specified by:

swVersion in interface RestSBDevice

Returns:

the software version.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object