Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.device; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 18 | import org.onosproject.net.Description; |
| 19 | import org.onosproject.net.Device; |
alshabib | 7911a05 | 2014-10-16 17:49:37 -0700 | [diff] [blame] | 20 | import org.onlab.packet.ChassisId; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 21 | |
| 22 | import java.net.URI; |
| 23 | |
| 24 | /** |
| 25 | * Carrier of immutable information about a device. |
| 26 | */ |
| 27 | public interface DeviceDescription extends Description { |
| 28 | |
| 29 | /** |
| 30 | * Protocol/provider specific URI that can be used to encode the identity |
| 31 | * information required to communicate with the device externally, e.g. |
| 32 | * datapath ID. |
| 33 | * |
| 34 | * @return provider specific URI for the device |
| 35 | */ |
Jonathan Hart | d9df7bd | 2015-11-10 17:10:25 -0800 | [diff] [blame] | 36 | URI deviceUri(); |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 37 | |
tom | d1900f3 | 2014-09-03 14:08:16 -0700 | [diff] [blame] | 38 | /** |
| 39 | * Returns the type of the infrastructure device. |
| 40 | * |
| 41 | * @return type of the device |
| 42 | */ |
| 43 | Device.Type type(); |
| 44 | |
| 45 | /** |
| 46 | * Returns the device manufacturer name. |
| 47 | * |
| 48 | * @return manufacturer name |
| 49 | */ |
| 50 | String manufacturer(); |
| 51 | |
| 52 | /** |
| 53 | * Returns the device hardware version. |
| 54 | * |
| 55 | * @return hardware version |
| 56 | */ |
| 57 | String hwVersion(); |
| 58 | |
| 59 | /** |
| 60 | * Returns the device software version. |
| 61 | * |
| 62 | * @return software version |
| 63 | */ |
| 64 | String swVersion(); |
| 65 | |
| 66 | /** |
| 67 | * Returns the device serial number. |
| 68 | * |
| 69 | * @return serial number |
| 70 | */ |
| 71 | String serialNumber(); |
| 72 | |
alshabib | 7911a05 | 2014-10-16 17:49:37 -0700 | [diff] [blame] | 73 | /** |
| 74 | * Returns a device chassis id. |
| 75 | * |
| 76 | * @return chassis id |
| 77 | */ |
| 78 | ChassisId chassisId(); |
| 79 | |
helenyrwu | fd296b6 | 2016-06-22 17:43:02 -0700 | [diff] [blame] | 80 | /** |
| 81 | * Return whether device should be made available by default. |
| 82 | * |
| 83 | * @return default availability |
| 84 | */ |
| 85 | boolean isDefaultAvailable(); |
| 86 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 87 | } |