Michele Santuari | 38dd82e | 2017-01-04 09:23:49 +0100 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Michele Santuari | 38dd82e | 2017-01-04 09:23:49 +0100 | [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 | |
| 17 | package org.onosproject.net.domain; |
| 18 | |
| 19 | import org.onosproject.net.DeviceId; |
| 20 | |
| 21 | import java.util.Set; |
| 22 | |
| 23 | /** |
| 24 | * Service to access domain topology elements. |
| 25 | */ |
| 26 | public interface DomainService { |
| 27 | |
| 28 | /** |
| 29 | * Returns the set of domains that have an associated topology. |
| 30 | * |
| 31 | * @return set of domain identifiers |
| 32 | */ |
| 33 | Set<DomainId> getDomainIds(); |
| 34 | |
| 35 | /** |
| 36 | * Returns the set of the device ids of the specified domain. |
| 37 | * |
| 38 | * @param domainId domain identifier |
| 39 | * @return set of device objects |
| 40 | */ |
| 41 | Set<DeviceId> getDeviceIds(DomainId domainId); |
| 42 | |
| 43 | /** |
| 44 | * Returns a domain given a device id. |
| 45 | * |
| 46 | * @param deviceId the device id |
| 47 | * @return null or the domain id of a device |
| 48 | */ |
| 49 | DomainId getDomain(DeviceId deviceId); |
Michele Santuari | a271faa | 2017-04-18 11:36:37 +0200 | [diff] [blame] | 50 | |
| 51 | } |
| 52 | |