protocols/rest/api/src/main/java/org/onosproject/protocol/rest/RestSBDevice.java

/*
 * Copyright 2016-present Open Networking Foundation
 *
 * 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.onosproject.protocol.rest;

import org.onlab.packet.IpAddress;
import org.onosproject.net.DeviceId;

import java.util.Optional;

/**
 * Represents an abstraction of a Rest Device in ONOS.
 */
public interface RestSBDevice {
    /**
     * REST Authentication schemes.
     */
    public enum AuthenticationScheme {
        NO_AUTHENTICATION,
        BASIC,
        OAUTH,
        OAUTH2,
    }

    /**
     * Returns the ip of this device.
     *
     * @return ip
     */
    IpAddress ip();

    /**
     * Returns the port of this device.
     *
     * @return port
     */
    int port();

    /**
     * The authentication scheme of rest device.
     *
     * @return authentication
     */
    AuthenticationScheme authentication();

    /**
     * The access token of rest device if authentication is OAuth2.
     *
     * @return token
     */
    String token();

    /**
     * Returns the username of this device.
     *
     * @return username
     */
    String username();

    /**
     * Returns the password of this device.
     *
     * @return password
     */
    String password();

    /**
     * Returns the ONOS deviceID for this device.
     *
     * @return DeviceId
     */
    DeviceId deviceId();

    /**
     * Sets or unsets the state of the device.
     *
     * @param active boolean
     */
    void setActive(boolean active);

    /**
     * Returns the state of this device.
     *
     * @return state
     */
    boolean isActive();

    /**
     * Returns the protocol for the REST request, usually HTTP o HTTPS.
     *
     * @return protocol
     */
    String protocol();

    /**
     * Returns the url for the REST requests, to be used instead of IP and PORT.
     *
     * @return url
     */
    String url();

    /**
     * Returns the proxy state of this device
     * (if true, the device is proxying multiple ONOS devices).
     *
     * @return proxy state
     */
    boolean isProxy();

    /**
     * Returns the url for the REST TEST requests.
     *
     * @return testUrl
     */
    Optional<String> testUrl();

    /**
     * The manufacturer of the rest device.
     *
     * @return the name of the manufacturer
     */
    Optional<String> manufacturer();

    /**
     * The hardware version of the rest device.
     *
     * @return the hardware version
     */
    Optional<String> hwVersion();

    /**
     * The software version of rest device.
     *
     * @return the software version.
     */
    Optional<String> swVersion();

}