Aaron Kruglikov | 7adb89e | 2016-01-06 15:21:28 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Aaron Kruglikov | 7adb89e | 2016-01-06 15:21:28 -0800 | [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 | */ |
| 16 | |
Aaron Kruglikov | 12faf8d | 2016-01-04 16:24:07 -0800 | [diff] [blame] | 17 | package org.onosproject.net.behaviour; |
| 18 | |
| 19 | import org.onosproject.net.driver.HandlerBehaviour; |
| 20 | |
| 21 | /** |
| 22 | * Behaviour that gets the configuration of the specified type from the device. |
| 23 | * |
| 24 | * This is a temporary development tool for use until yang integration is complete. |
| 25 | * This is not a properly specified behavior. DO NOT USE AS AN EXAMPLE. |
| 26 | */ |
| 27 | //FIXME this should eventually be removed. |
| 28 | public interface ConfigGetter extends HandlerBehaviour { |
| 29 | |
| 30 | /** |
| 31 | * Returns the string representation of a device configuration, returns a |
Marc De Leenheer | c662d32 | 2016-02-18 16:05:10 -0800 | [diff] [blame] | 32 | * failure string if the configuration cannot be retrieved. |
Aaron Kruglikov | 12faf8d | 2016-01-04 16:24:07 -0800 | [diff] [blame] | 33 | * @param type the type of configuration to get (i.e. running). |
| 34 | * @return string representation of the configuration or an error string. |
| 35 | */ |
Sho SHIMIZU | 07e31cf | 2016-08-15 11:46:38 -0700 | [diff] [blame] | 36 | String getConfiguration(String type); |
Aaron Kruglikov | 12faf8d | 2016-01-04 16:24:07 -0800 | [diff] [blame] | 37 | } |