Yuta HIGUCHI | 8c6e194 | 2018-04-05 13:40:51 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 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 | */ |
| 16 | package org.onosproject.odtn.behaviour; |
| 17 | |
| 18 | import java.util.List; |
| 19 | |
| 20 | import org.onosproject.net.device.DeviceDescriptionDiscovery; |
| 21 | import org.onosproject.net.device.PortDescription; |
| 22 | |
Yuta HIGUCHI | 44e3a61 | 2018-05-11 15:03:39 -0700 | [diff] [blame^] | 23 | import com.google.common.annotations.Beta; |
| 24 | |
Yuta HIGUCHI | 8c6e194 | 2018-04-05 13:40:51 -0700 | [diff] [blame] | 25 | /** |
| 26 | * DeviceDescriptionDiscovery used in ODTN. |
| 27 | * |
Yuta HIGUCHI | e9df0c4 | 2018-05-07 16:24:42 -0700 | [diff] [blame] | 28 | * Just declaring certain Annotations will be required. |
Yuta HIGUCHI | 8c6e194 | 2018-04-05 13:40:51 -0700 | [diff] [blame] | 29 | */ |
Yuta HIGUCHI | 44e3a61 | 2018-05-11 15:03:39 -0700 | [diff] [blame^] | 30 | @Beta |
Yuta HIGUCHI | 8c6e194 | 2018-04-05 13:40:51 -0700 | [diff] [blame] | 31 | public interface OdtnDeviceDescriptionDiscovery |
| 32 | extends DeviceDescriptionDiscovery { |
| 33 | |
| 34 | /** |
Yuta HIGUCHI | 44e3a61 | 2018-05-11 15:03:39 -0700 | [diff] [blame^] | 35 | * Annotations key intended for a Port, which stores OpenConfig component name. |
Yuta HIGUCHI | 8c6e194 | 2018-04-05 13:40:51 -0700 | [diff] [blame] | 36 | */ |
| 37 | String OC_NAME = "oc-name"; |
| 38 | |
| 39 | /** |
Yuta HIGUCHI | 44e3a61 | 2018-05-11 15:03:39 -0700 | [diff] [blame^] | 40 | * Annotations key intended for a Port, which stores OpenConfig component type. |
Yuta HIGUCHI | 8c6e194 | 2018-04-05 13:40:51 -0700 | [diff] [blame] | 41 | */ |
| 42 | String OC_TYPE = "oc-type"; |
| 43 | |
Yuta HIGUCHI | 44e3a61 | 2018-05-11 15:03:39 -0700 | [diff] [blame^] | 44 | // will also be used from TAPI model to point to what we want to configure |
| 45 | /** |
| 46 | * Annotations key intended for a Port, |
| 47 | * which stores string identifier used to |
| 48 | * logically group Ports corresponding to a transponder. |
| 49 | */ |
| 50 | String TRANSPONDER_NAME = "odtn-transponder-name"; |
| 51 | |
| 52 | |
| 53 | /** |
| 54 | * OpenConfig component property name to store, |
| 55 | * decimal integer index to be used when creating PortNumber. |
| 56 | */ |
| 57 | String ONOS_PORT_INDEX = "onos-index"; |
| 58 | |
Yuta HIGUCHI | 8c6e194 | 2018-04-05 13:40:51 -0700 | [diff] [blame] | 59 | // overriding just to make checkstyle happy |
| 60 | @Override |
| 61 | List<PortDescription> discoverPortDetails(); |
| 62 | |
| 63 | } |