Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 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.ui; |
| 17 | |
| 18 | import com.fasterxml.jackson.databind.ObjectMapper; |
| 19 | import com.fasterxml.jackson.databind.node.ObjectNode; |
| 20 | |
| 21 | /** |
| 22 | * Abstraction of an entity that handles a specific request from the |
| 23 | * user interface client. |
| 24 | * |
Simon Hunt | a0ddb02 | 2015-05-01 09:53:01 -0700 | [diff] [blame] | 25 | * @see UiMessageHandler |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 26 | */ |
| 27 | public abstract class RequestHandler { |
| 28 | |
| 29 | protected static final ObjectMapper MAPPER = new ObjectMapper(); |
| 30 | |
| 31 | private final String eventType; |
Simon Hunt | a0ddb02 | 2015-05-01 09:53:01 -0700 | [diff] [blame] | 32 | private UiMessageHandler parent; |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 33 | |
| 34 | |
Simon Hunt | 8add9ee | 2016-09-20 17:05:07 -0700 | [diff] [blame] | 35 | /** |
| 36 | * Constructs a request handler instance that will handle events |
| 37 | * of the specified type. |
| 38 | * |
| 39 | * @param eventType type of event that will be handled |
| 40 | */ |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 41 | public RequestHandler(String eventType) { |
| 42 | this.eventType = eventType; |
| 43 | } |
| 44 | |
| 45 | // package private |
Simon Hunt | a0ddb02 | 2015-05-01 09:53:01 -0700 | [diff] [blame] | 46 | void setParent(UiMessageHandler parent) { |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 47 | this.parent = parent; |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * Returns the event type that this handler handles. |
| 52 | * |
| 53 | * @return event type |
| 54 | */ |
| 55 | public String eventType() { |
| 56 | return eventType; |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * Processes the incoming message payload from the client. |
| 61 | * |
Simon Hunt | b1ced8e | 2016-05-27 19:34:34 -0700 | [diff] [blame] | 62 | * @param sid message sequence identifier |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 63 | * @param payload request message payload |
| 64 | */ |
Simon Hunt | c54cd1b | 2015-05-11 13:43:44 -0700 | [diff] [blame] | 65 | // TODO: remove sid from signature |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 66 | public abstract void process(long sid, ObjectNode payload); |
| 67 | |
| 68 | |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 69 | // =================================================================== |
| 70 | // === Convenience methods... |
| 71 | |
| 72 | /** |
Simon Hunt | 8add9ee | 2016-09-20 17:05:07 -0700 | [diff] [blame] | 73 | * Returns an implementation of the specified service class. |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 74 | * |
| 75 | * @param serviceClass service class |
| 76 | * @param <T> type of service |
| 77 | * @return implementation class |
| 78 | * @throws org.onlab.osgi.ServiceNotFoundException if no implementation found |
| 79 | */ |
| 80 | protected <T> T get(Class<T> serviceClass) { |
| 81 | return parent.directory().get(serviceClass); |
| 82 | } |
| 83 | |
| 84 | /** |
Simon Hunt | 8add9ee | 2016-09-20 17:05:07 -0700 | [diff] [blame] | 85 | * Sends a message back to the client with the given event type and payload. |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 86 | * |
| 87 | * @param eventType message event type |
| 88 | * @param sid message sequence identifier |
| 89 | * @param payload message payload |
| 90 | */ |
Simon Hunt | da58088 | 2015-05-12 20:58:18 -0700 | [diff] [blame] | 91 | // TODO: remove sid from signature |
Simon Hunt | 8add9ee | 2016-09-20 17:05:07 -0700 | [diff] [blame] | 92 | @Deprecated |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 93 | protected void sendMessage(String eventType, long sid, ObjectNode payload) { |
| 94 | parent.connection().sendMessage(eventType, sid, payload); |
| 95 | } |
| 96 | |
| 97 | /** |
Simon Hunt | 8add9ee | 2016-09-20 17:05:07 -0700 | [diff] [blame] | 98 | * Sends a message back to the client with the given event type and payload. |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 99 | * |
| 100 | * @param eventType message event type |
| 101 | * @param payload message payload |
| 102 | */ |
| 103 | protected void sendMessage(String eventType, ObjectNode payload) { |
| 104 | // TODO: remove sid |
| 105 | parent.connection().sendMessage(eventType, 0, payload); |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Sends a message back to the client. |
Simon Hunt | 8add9ee | 2016-09-20 17:05:07 -0700 | [diff] [blame] | 110 | * Here, the message is preformatted; the assumption is that it has its |
| 111 | * eventType and payload attributes already filled in. |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 112 | * |
| 113 | * @param message the message to send |
| 114 | */ |
| 115 | protected void sendMessage(ObjectNode message) { |
| 116 | parent.connection().sendMessage(message); |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Allows one request handler to pass the event on to another for |
| 121 | * further processing. |
| 122 | * Note that the message handlers must be defined in the same parent. |
| 123 | * |
| 124 | * @param eventType event type |
| 125 | * @param sid sequence identifier |
| 126 | * @param payload message payload |
| 127 | */ |
Simon Hunt | da58088 | 2015-05-12 20:58:18 -0700 | [diff] [blame] | 128 | // TODO: remove sid from signature |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 129 | protected void chain(String eventType, long sid, ObjectNode payload) { |
| 130 | parent.exec(eventType, sid, payload); |
| 131 | } |
| 132 | |
| 133 | // =================================================================== |
| 134 | |
| 135 | |
Simon Hunt | da58088 | 2015-05-12 20:58:18 -0700 | [diff] [blame] | 136 | /** |
| 137 | * Returns the specified node property as a string. |
| 138 | * |
| 139 | * @param node message event |
Simon Hunt | b1ced8e | 2016-05-27 19:34:34 -0700 | [diff] [blame] | 140 | * @param key property name |
Simon Hunt | da58088 | 2015-05-12 20:58:18 -0700 | [diff] [blame] | 141 | * @return property as a string |
| 142 | */ |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 143 | protected String string(ObjectNode node, String key) { |
| 144 | return JsonUtils.string(node, key); |
| 145 | } |
| 146 | |
Simon Hunt | da58088 | 2015-05-12 20:58:18 -0700 | [diff] [blame] | 147 | /** |
| 148 | * Returns the specified node property as a string, with a default fallback. |
| 149 | * |
Simon Hunt | b1ced8e | 2016-05-27 19:34:34 -0700 | [diff] [blame] | 150 | * @param node object node |
| 151 | * @param key property name |
| 152 | * @param defValue fallback value if property is absent |
Simon Hunt | da58088 | 2015-05-12 20:58:18 -0700 | [diff] [blame] | 153 | * @return property as a string |
| 154 | */ |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 155 | protected String string(ObjectNode node, String key, String defValue) { |
| 156 | return JsonUtils.string(node, key, defValue); |
| 157 | } |
| 158 | |
Simon Hunt | b1ced8e | 2016-05-27 19:34:34 -0700 | [diff] [blame] | 159 | /** |
| 160 | * Returns the specified node property as a boolean. More precisely, if |
| 161 | * the value for the given key is the string "true" then this returns true, |
| 162 | * false otherwise. |
| 163 | * |
| 164 | * @param node object node |
| 165 | * @param key property name |
| 166 | * @return property as a boolean |
| 167 | */ |
| 168 | protected boolean bool(ObjectNode node, String key) { |
| 169 | return JsonUtils.bool(node, key); |
| 170 | } |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 171 | } |