alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 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.net.flowobjective; |
| 17 | |
Thomas Vachuska | a9d491e | 2015-05-20 11:17:21 -0700 | [diff] [blame] | 18 | import com.google.common.annotations.Beta; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 19 | import org.onosproject.net.behaviour.NextGroup; |
| 20 | import org.onosproject.store.Store; |
| 21 | |
| 22 | /** |
| 23 | * The flow objective store. |
| 24 | */ |
Thomas Vachuska | a9d491e | 2015-05-20 11:17:21 -0700 | [diff] [blame] | 25 | @Beta |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 26 | public interface FlowObjectiveStore |
| 27 | extends Store<ObjectiveEvent, FlowObjectiveStoreDelegate> { |
| 28 | |
| 29 | /** |
Saurav Das | 423fe2b | 2015-12-04 10:52:59 -0800 | [diff] [blame] | 30 | * Adds a NextGroup to the store, by mapping it to the nextId as key, |
| 31 | * and replacing any previous mapping. |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 32 | * |
| 33 | * @param nextId an integer |
| 34 | * @param group a next group opaque object |
| 35 | */ |
| 36 | void putNextGroup(Integer nextId, NextGroup group); |
| 37 | |
| 38 | /** |
| 39 | * Fetch a next group from the store. |
Saurav Das | 423fe2b | 2015-12-04 10:52:59 -0800 | [diff] [blame] | 40 | * |
| 41 | * @param nextId an integer used as key |
| 42 | * @return a next group, or null if group was not found |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 43 | */ |
| 44 | NextGroup getNextGroup(Integer nextId); |
alshabib | f6ea9e6 | 2015-04-21 17:08:26 -0700 | [diff] [blame] | 45 | |
| 46 | /** |
Saurav Das | 423fe2b | 2015-12-04 10:52:59 -0800 | [diff] [blame] | 47 | * Remove a next group mapping from the store. |
| 48 | * |
| 49 | * @param nextId the key to remove from the store. |
| 50 | * @return the next group which mapped to the nextId and is now removed, or |
| 51 | * null if no group mapping existed in the store |
| 52 | */ |
| 53 | NextGroup removeNextGroup(Integer nextId); |
| 54 | |
| 55 | /** |
alshabib | f6ea9e6 | 2015-04-21 17:08:26 -0700 | [diff] [blame] | 56 | * Allocates a next objective id. This id is globally unique |
| 57 | * |
| 58 | * @return an integer |
| 59 | */ |
| 60 | int allocateNextId(); |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 61 | } |