Jian Li | 95edb59 | 2017-01-29 08:42:07 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-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.mapping; |
| 17 | |
| 18 | import org.onosproject.net.provider.ProviderService; |
| 19 | |
Jian Li | 38bb109 | 2017-05-01 15:04:32 +0900 | [diff] [blame] | 20 | import java.util.List; |
| 21 | |
Jian Li | 95edb59 | 2017-01-29 08:42:07 +0900 | [diff] [blame] | 22 | /** |
| 23 | * Service through which mapping providers can inject mapping information into |
| 24 | * the core. |
| 25 | */ |
| 26 | public interface MappingProviderService extends ProviderService<MappingProvider> { |
| 27 | |
| 28 | /** |
| 29 | * Signals that a new mapping has been received. |
| 30 | * |
Jian Li | c7badf9 | 2017-02-02 19:43:46 +0900 | [diff] [blame] | 31 | * @param mappingEntry newly added mapping entry |
| 32 | * @param type indicates that where this map entry should be stored |
Jian Li | 95edb59 | 2017-01-29 08:42:07 +0900 | [diff] [blame] | 33 | */ |
Jian Li | c7badf9 | 2017-02-02 19:43:46 +0900 | [diff] [blame] | 34 | void mappingAdded(MappingEntry mappingEntry, MappingStore.Type type); |
Jian Li | 791dd32 | 2017-04-20 00:15:56 +0900 | [diff] [blame] | 35 | |
| 36 | /** |
| 37 | * Signals that a new mapping query has been issued. |
Jian Li | 55648ed | 2017-05-01 02:20:55 +0900 | [diff] [blame] | 38 | * If no mapping is found, simply returns null. |
Jian Li | 791dd32 | 2017-04-20 00:15:56 +0900 | [diff] [blame] | 39 | * |
| 40 | * @param mappingKey a mapping key that is used for query a mapping value |
| 41 | * @return a mapping value associated with a given mapping key |
| 42 | */ |
| 43 | MappingValue mappingQueried(MappingKey mappingKey); |
Jian Li | 38bb109 | 2017-05-01 15:04:32 +0900 | [diff] [blame] | 44 | |
| 45 | /** |
| 46 | * Signals that a new batch mapping query has been issued. |
| 47 | * If no mapping is found, simply returns empty list. |
| 48 | * |
| 49 | * @param mappingKeys a collection of mapping keys |
| 50 | * @return a collection of mapping values associated with give mapping keys |
| 51 | */ |
| 52 | List<MappingValue> mappingQueried(List<MappingKey> mappingKeys); |
Jian Li | 95edb59 | 2017-01-29 08:42:07 +0900 | [diff] [blame] | 53 | } |