Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present Open Networking Laboratory |
| 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.xosclient.api; |
| 17 | |
| 18 | /** |
| 19 | * Provides interactions with XOS. |
| 20 | */ |
| 21 | public interface XosClientService { |
| 22 | |
| 23 | /** |
| 24 | * Returns XOS API access information of the client. |
| 25 | * |
| 26 | * @return xos access |
| 27 | */ |
| 28 | XosAccess access(); |
| 29 | |
| 30 | /** |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 31 | * Returns XOS client with access. |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 32 | * |
Hyunsun Moon | 03d2851 | 2016-05-09 13:19:45 -0700 | [diff] [blame] | 33 | * @param xosAccess xos access information |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 34 | * @return xos client; null if access fails authentication |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 35 | */ |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 36 | XosClientService getClient(XosAccess xosAccess); |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 37 | |
| 38 | /** |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 39 | * Returns CORD VTN service and service dependency API. |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 40 | * |
| 41 | * @return cord vtn service api |
| 42 | */ |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 43 | VtnServiceApi vtnService(); |
| 44 | |
| 45 | /** |
| 46 | * Returns CORD VTN port API. |
| 47 | * |
| 48 | * @return cord vtn port api |
| 49 | */ |
| 50 | VtnPortApi vtnPort(); |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 51 | |
| 52 | /* |
| 53 | * adds more XOS service APIs below. |
| 54 | */ |
| 55 | } |