protocols/snmp/api/src/main/java/org/onosproject/snmp/SnmpDevice.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.snmp;

import com.google.common.annotations.Beta;
import org.onosproject.net.DeviceId;
import org.snmp4j.Snmp;

/**
 * Abstraction a default Snmp Device.
 */
@Beta
public interface SnmpDevice {

    /**
     * Returns host IP and host Port, used by this particular SNMP Device.
     *
     * @return Device Information.
     */
    String deviceInfo();

    /**
     * Returns an Snmp session context for this device.
     *
     * @return snmp session
     */
    Snmp getSession();

    /**
     * Terminates the device connection.
     */
    void disconnect();

    /**
     * Retrieves the device state.
     *
     * @return true if connected
     */
    boolean isReachable();

    /**
     * Returns the IP used connect ssh on the device.
     *
     * @return SNMP Device IP
     */
    String getSnmpHost();

    /**
     * Returns the SSH Port used connect the device.
     *
     * @return SSH Port number
     */
    int getSnmpPort();

    /**
     * Returns the notification port for asynchronous messages from the device.
     *
     * @return notification port
     */
    int getNotificationPort();

    /**
     * Retrieves the username of the device.
     *
     * @return username
     */
    String getUsername();

    /**
     * Retrieves the community (password) of the device.
     *
     * @return password
     */
    String getCommunity();

    /**
     * Returns the protocol of the device.
     *
     * @return protocol
     */
    String getProtocol();

    /**
     * Returns the notification protocol of the device.
     *
     * @return notification protocol
     */
    String getNotificationProtocol();

    /**
     * Return the SNMP device deviceID.
     *
     * @return DeviceId
     */
    DeviceId deviceId();
}