Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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 |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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. |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 16 | package org.onlab.onos.net.intent; |
| 17 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 18 | import org.onlab.onos.store.Store; |
| 19 | |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 20 | import java.util.List; |
| 21 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 22 | /** |
| 23 | * Manages inventory of end-station intents; not intended for direct use. |
| 24 | */ |
| 25 | public interface IntentStore extends Store<IntentEvent, IntentStoreDelegate> { |
| 26 | |
| 27 | /** |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 28 | * Submits a new intent into the store. If the returned event is not |
| 29 | * null, the manager is expected to dispatch the event and then to kick |
| 30 | * off intent compilation process. Otherwise, another node has been elected |
| 31 | * to perform the compilation process and the node will learn about |
| 32 | * the submittal and results of the intent compilation via the delegate |
| 33 | * mechanism. |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 34 | * |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 35 | * @param intent intent to be submitted |
| 36 | * @return event indicating the intent was submitted or null if no |
| 37 | * change resulted, e.g. duplicate intent |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 38 | */ |
| 39 | IntentEvent createIntent(Intent intent); |
| 40 | |
| 41 | /** |
| 42 | * Removes the specified intent from the inventory. |
| 43 | * |
| 44 | * @param intentId intent identification |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 45 | * @return removed state transition event or null if intent was not found |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 46 | */ |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 47 | IntentEvent removeIntent(IntentId intentId); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 48 | |
| 49 | /** |
| 50 | * Returns the number of intents in the store. |
Toshio Koide | d32809b | 2014-10-09 10:58:54 -0700 | [diff] [blame] | 51 | * |
| 52 | * @return the number of intents in the store |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 53 | */ |
| 54 | long getIntentCount(); |
| 55 | |
| 56 | /** |
| 57 | * Returns a collection of all intents in the store. |
| 58 | * |
| 59 | * @return iterable collection of all intents |
| 60 | */ |
| 61 | Iterable<Intent> getIntents(); |
| 62 | |
| 63 | /** |
Toshio Koide | d32809b | 2014-10-09 10:58:54 -0700 | [diff] [blame] | 64 | * Returns the intent with the specified identifier. |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 65 | * |
| 66 | * @param intentId intent identification |
| 67 | * @return intent or null if not found |
| 68 | */ |
| 69 | Intent getIntent(IntentId intentId); |
| 70 | |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 71 | /** |
| 72 | * Returns the state of the specified intent. |
| 73 | * |
| 74 | * @param intentId intent identification |
| 75 | * @return current intent state |
| 76 | */ |
| 77 | IntentState getIntentState(IntentId intentId); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 78 | |
| 79 | /** |
| 80 | * Sets the state of the specified intent to the new state. |
| 81 | * |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 82 | * @param intent intent whose state is to be changed |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 83 | * @param newState new state |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 84 | * @return state transition event |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 85 | */ |
| 86 | IntentEvent setState(Intent intent, IntentState newState); |
| 87 | |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 88 | /** |
Yuta HIGUCHI | 10a31c3 | 2014-10-28 14:42:06 -0700 | [diff] [blame] | 89 | * Sets the installable intents which resulted from compilation of the |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 90 | * specified original intent. |
| 91 | * |
| 92 | * @param intentId original intent identifier |
| 93 | * @param installableIntents compiled installable intents |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 94 | */ |
Yuta HIGUCHI | 10a31c3 | 2014-10-28 14:42:06 -0700 | [diff] [blame] | 95 | void setInstallableIntents(IntentId intentId, List<Intent> installableIntents); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 96 | |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 97 | /** |
| 98 | * Returns the list of the installable events associated with the specified |
| 99 | * original intent. |
| 100 | * |
| 101 | * @param intentId original intent identifier |
| 102 | * @return compiled installable intents |
| 103 | */ |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 104 | List<Intent> getInstallableIntents(IntentId intentId); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 105 | |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 106 | // TODO: this should be triggered from with the store as a result of removeIntent call |
| 107 | |
| 108 | /** |
| 109 | * Removes any installable intents which resulted from compilation of the |
| 110 | * specified original intent. |
| 111 | * |
| 112 | * @param intentId original intent identifier |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 113 | */ |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 114 | void removeInstalledIntents(IntentId intentId); |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 115 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 116 | } |