Jonathan Hart | aa38097 | 2014-04-03 10:24:46 -0700 | [diff] [blame] | 1 | package net.onrc.onos.core.intent; |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 2 | |
| 3 | import java.util.Collection; |
| 4 | import java.util.EventListener; |
| 5 | import java.util.HashMap; |
| 6 | import java.util.HashSet; |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 7 | import java.util.LinkedList; |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 8 | import java.util.Map.Entry; |
| 9 | |
Jonathan Hart | aa38097 | 2014-04-03 10:24:46 -0700 | [diff] [blame] | 10 | import net.onrc.onos.core.intent.Intent.IntentState; |
| 11 | import net.onrc.onos.core.intent.runtime.IntentStateList; |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 12 | |
| 13 | /** |
| 14 | * @author Toshio Koide (t-koide@onlab.us) |
| 15 | */ |
| 16 | public class IntentMap { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 17 | private HashSet<ChangedListener> listeners = new HashSet<>(); |
| 18 | private HashMap<String, Intent> intents = new HashMap<>(); |
| 19 | private LinkedList<ChangedEvent> events = new LinkedList<>(); |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 20 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 21 | public enum ChangedEventType { |
| 22 | /** |
| 23 | * Added new intent. |
| 24 | */ |
| 25 | ADDED, |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 26 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 27 | /** |
| 28 | * Removed existing intent. |
| 29 | * The specified intent is an instance of Intent class (not a child class) |
| 30 | * Only id and state are valid. |
| 31 | */ |
| 32 | REMOVED, |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 33 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 34 | /** |
| 35 | * Changed state of existing intent. |
| 36 | * The specified intent is an instance of Intent class (not a child class) |
| 37 | * Only id and state are valid. |
| 38 | */ |
| 39 | STATE_CHANGED, |
| 40 | } |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 41 | |
Pavlin Radoslavov | fee8098 | 2014-04-10 12:12:04 -0700 | [diff] [blame] | 42 | public static class ChangedEvent { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 43 | public ChangedEvent(ChangedEventType eventType, Intent intent) { |
| 44 | this.eventType = eventType; |
| 45 | this.intent = intent; |
| 46 | } |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 47 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 48 | public ChangedEventType eventType; |
| 49 | public Intent intent; |
Pavlin Radoslavov | b630929 | 2014-04-11 03:25:47 -0700 | [diff] [blame^] | 50 | |
| 51 | /** |
| 52 | * Get a string representation of the object. |
| 53 | * <p/> |
| 54 | * The string has the following form: |
| 55 | * [eventType=XXX intent=XXX] |
| 56 | * |
| 57 | * @return a string representation of the object. |
| 58 | */ |
| 59 | @Override |
| 60 | public String toString() { |
| 61 | StringBuilder ret = new StringBuilder(); |
| 62 | ret.append("[eventType="); |
| 63 | ret.append(this.eventType.toString()); |
| 64 | ret.append(" intent="); |
| 65 | ret.append(this.intent.toString()); |
| 66 | ret.append("]"); |
| 67 | return ret.toString(); |
| 68 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 69 | } |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 70 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 71 | public interface ChangedListener extends EventListener { |
| 72 | void intentsChange(LinkedList<ChangedEvent> events); |
| 73 | } |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 74 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 75 | //================================================================================ |
| 76 | // public methods |
| 77 | //================================================================================ |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 78 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 79 | public void executeOperations(IntentOperationList operations) { |
| 80 | for (IntentOperation operation : operations) { |
| 81 | switch (operation.operator) { |
| 82 | case ADD: |
| 83 | handleAddOperation(operation); |
| 84 | break; |
| 85 | case REMOVE: |
| 86 | handleRemoveOperation(operation); |
| 87 | break; |
| 88 | case ERROR: |
| 89 | handleErrorOperation(operation); |
| 90 | break; |
| 91 | } |
| 92 | } |
| 93 | notifyEvents(); |
| 94 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 95 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 96 | public void purge() { |
| 97 | LinkedList<String> removeIds = new LinkedList<>(); |
| 98 | for (Entry<String, Intent> entry : intents.entrySet()) { |
| 99 | Intent intent = entry.getValue(); |
| 100 | if (intent.getState() == IntentState.DEL_ACK |
| 101 | || intent.getState() == IntentState.INST_NACK) { |
| 102 | removeIds.add(intent.getId()); |
| 103 | } |
| 104 | } |
| 105 | for (String intentId : removeIds) { |
| 106 | removeIntent(intentId); |
| 107 | } |
| 108 | notifyEvents(); |
| 109 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 110 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 111 | public void changeStates(IntentStateList states) { |
| 112 | for (Entry<String, IntentState> state : states.entrySet()) { |
| 113 | setState(state.getKey(), state.getValue()); |
| 114 | } |
| 115 | notifyEvents(); |
| 116 | } |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 117 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 118 | public Intent getIntent(String intentId) { |
| 119 | return intents.get(intentId); |
| 120 | } |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 121 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 122 | public Collection<Intent> getAllIntents() { |
| 123 | return intents.values(); |
| 124 | } |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 125 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 126 | public void addChangeListener(ChangedListener listener) { |
| 127 | listeners.add(listener); |
| 128 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 129 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 130 | public void removeChangedListener(ChangedListener listener) { |
| 131 | listeners.remove(listener); |
| 132 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 133 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 134 | //================================================================================ |
| 135 | // methods that affect intents map (protected) |
| 136 | //================================================================================ |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 137 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 138 | protected void putIntent(Intent intent) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 139 | if (intents.containsKey(intent.getId())) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 140 | removeIntent(intent.getId()); |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 141 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 142 | intents.put(intent.getId(), intent); |
| 143 | events.add(new ChangedEvent(ChangedEventType.ADDED, intent)); |
| 144 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 145 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 146 | protected void removeIntent(String intentId) { |
| 147 | Intent intent = intents.remove(intentId); |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 148 | if (intent == null) { |
| 149 | return; |
| 150 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 151 | events.add(new ChangedEvent(ChangedEventType.REMOVED, intent)); |
| 152 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 153 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 154 | protected void setState(String intentId, IntentState state) { |
| 155 | Intent intent = intents.get(intentId); |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 156 | if (intent == null) { |
| 157 | return; |
| 158 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 159 | intent.setState(state); |
| 160 | events.add(new ChangedEvent(ChangedEventType.STATE_CHANGED, intent)); |
| 161 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 162 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 163 | //================================================================================ |
| 164 | // helper methods (protected) |
| 165 | //================================================================================ |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 166 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 167 | protected void handleAddOperation(IntentOperation operation) { |
| 168 | putIntent(operation.intent); |
| 169 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 170 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 171 | protected void handleRemoveOperation(IntentOperation operation) { |
| 172 | Intent intent = getIntent(operation.intent.getId()); |
| 173 | if (intent == null) { |
| 174 | // TODO error handling |
Ray Milkey | 1aa71f8 | 2014-04-08 16:23:24 -0700 | [diff] [blame] | 175 | return; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 176 | } else { |
| 177 | setState(intent.getId(), IntentState.DEL_REQ); |
| 178 | } |
| 179 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 180 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 181 | protected void handleErrorOperation(IntentOperation operation) { |
| 182 | //TODO put error message into the intent |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 183 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 184 | ErrorIntent errorIntent = (ErrorIntent) operation.intent; |
| 185 | Intent targetIntent = intents.get(errorIntent.getId()); |
| 186 | if (targetIntent == null) { |
| 187 | // TODO error handling |
| 188 | return; |
| 189 | } |
Toshio Koide | df2eab9 | 2014-02-20 11:24:59 -0800 | [diff] [blame] | 190 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 191 | switch (targetIntent.getState()) { |
| 192 | case CREATED: |
| 193 | case INST_REQ: |
| 194 | case INST_ACK: |
| 195 | case REROUTE_REQ: |
| 196 | setState(targetIntent.getId(), IntentState.INST_NACK); |
| 197 | break; |
| 198 | case DEL_REQ: |
| 199 | setState(targetIntent.getId(), IntentState.DEL_PENDING); |
| 200 | break; |
| 201 | case INST_NACK: |
| 202 | case DEL_PENDING: |
| 203 | case DEL_ACK: |
| 204 | // do nothing |
| 205 | break; |
| 206 | } |
| 207 | } |
| 208 | |
| 209 | protected void notifyEvents() { |
| 210 | for (ChangedListener listener : listeners) { |
| 211 | listener.intentsChange(events); |
| 212 | } |
| 213 | events.clear(); |
| 214 | } |
Toshio Koide | b609b3b | 2014-02-14 18:25:52 -0800 | [diff] [blame] | 215 | } |