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 | import java.util.Set; |
| 19 | |
| 20 | /** |
| 21 | * Service for interacting with XOS VTN service and service dependency. |
| 22 | */ |
| 23 | public interface VtnServiceApi { |
| 24 | |
| 25 | /** |
| 26 | * Returns all services list. |
| 27 | * |
| 28 | * @return service list |
| 29 | */ |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 30 | Set<VtnServiceId> services(); |
| 31 | |
| 32 | /** |
| 33 | * Returns VTN service. |
| 34 | * |
| 35 | * @param serviceId service id |
| 36 | * @return vtn service |
| 37 | */ |
| 38 | VtnService service(VtnServiceId serviceId); |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 39 | |
| 40 | /** |
| 41 | * Returns dependent tenant services of a given provider service. |
| 42 | * |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 43 | * @param pServiceId vtn service id |
| 44 | * @return set of service ids |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 45 | */ |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 46 | Set<VtnServiceId> tenantServices(VtnServiceId pServiceId); |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 47 | |
| 48 | /** |
| 49 | * Returns dependent provider services of a given tenant service. |
| 50 | * |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 51 | * @param tServiceId vtn service id |
| 52 | * @return set of service ids |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 53 | */ |
Hyunsun Moon | 4c39663 | 2016-05-13 04:17:53 -0700 | [diff] [blame] | 54 | Set<VtnServiceId> providerServices(VtnServiceId tServiceId); |
Hyunsun Moon | e0f3e28 | 2016-05-13 18:58:35 -0700 | [diff] [blame] | 55 | |
| 56 | /** |
| 57 | * Returns VTN service from OpenStack. |
| 58 | * |
| 59 | * @param serviceId service id |
| 60 | * @param osAccess openstack access |
| 61 | * @return vtn service |
| 62 | */ |
| 63 | // TODO remove this when XOS provides service information |
| 64 | VtnService service(VtnServiceId serviceId, OpenStackAccess osAccess); |
Hyunsun Moon | 7ad9220 | 2016-04-20 10:36:02 -0700 | [diff] [blame] | 65 | } |