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 | /** |
| 30 | * Adds a NextGroup to the store. |
| 31 | * |
| 32 | * @param nextId an integer |
| 33 | * @param group a next group opaque object |
| 34 | */ |
| 35 | void putNextGroup(Integer nextId, NextGroup group); |
| 36 | |
| 37 | /** |
| 38 | * Fetch a next group from the store. |
| 39 | * @param nextId an integer |
| 40 | * @return a next group |
| 41 | */ |
| 42 | NextGroup getNextGroup(Integer nextId); |
alshabib | f6ea9e6 | 2015-04-21 17:08:26 -0700 | [diff] [blame] | 43 | |
| 44 | /** |
| 45 | * Allocates a next objective id. This id is globally unique |
| 46 | * |
| 47 | * @return an integer |
| 48 | */ |
| 49 | int allocateNextId(); |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 50 | } |