Thomas Vachuska | 7d693f5 | 2014-10-21 19:17:57 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 7d693f5 | 2014-10-21 19:17:57 -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 | 7d693f5 | 2014-10-21 19:17:57 -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 | 7d693f5 | 2014-10-21 19:17:57 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.cli; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 17 | |
tom | 32085cf | 2014-10-16 00:04:33 -0700 | [diff] [blame] | 18 | import org.apache.karaf.shell.commands.Option; |
Thomas Vachuska | a7a0f56 | 2015-04-14 23:27:44 -0700 | [diff] [blame] | 19 | import org.apache.karaf.shell.console.AbstractAction; |
| 20 | import org.onlab.osgi.DefaultServiceDirectory; |
| 21 | import org.onlab.osgi.ServiceNotFoundException; |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 22 | import org.onosproject.codec.CodecContext; |
| 23 | import org.onosproject.codec.CodecService; |
| 24 | import org.onosproject.codec.JsonCodec; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 25 | import org.onosproject.core.ApplicationId; |
| 26 | import org.onosproject.core.CoreService; |
| 27 | import org.onosproject.net.Annotations; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 28 | |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 29 | import com.fasterxml.jackson.databind.ObjectMapper; |
| 30 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Yi Tseng | f18e66e | 2018-01-31 16:11:42 -0800 | [diff] [blame] | 31 | import org.onosproject.net.DefaultAnnotations; |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 32 | |
Andrea Campanella | 1303253 | 2016-03-31 10:50:50 -0700 | [diff] [blame] | 33 | import java.util.Set; |
| 34 | import java.util.TreeSet; |
| 35 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 36 | /** |
| 37 | * Base abstraction of Karaf shell commands. |
| 38 | */ |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 39 | public abstract class AbstractShellCommand extends AbstractAction implements CodecContext { |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 40 | |
tom | 32085cf | 2014-10-16 00:04:33 -0700 | [diff] [blame] | 41 | @Option(name = "-j", aliases = "--json", description = "Output JSON", |
| 42 | required = false, multiValued = false) |
| 43 | private boolean json = false; |
| 44 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 45 | /** |
tom | 6d2a43e | 2014-09-08 01:50:20 -0700 | [diff] [blame] | 46 | * Returns the reference to the implementation of the specified service. |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 47 | * |
| 48 | * @param serviceClass service class |
| 49 | * @param <T> type of service |
| 50 | * @return service implementation |
tom | caf3bf7 | 2014-09-23 13:20:53 -0700 | [diff] [blame] | 51 | * @throws org.onlab.osgi.ServiceNotFoundException if service is unavailable |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 52 | */ |
tom | 6d2a43e | 2014-09-08 01:50:20 -0700 | [diff] [blame] | 53 | public static <T> T get(Class<T> serviceClass) { |
tom | 0872a17 | 2014-09-23 11:24:26 -0700 | [diff] [blame] | 54 | return DefaultServiceDirectory.getService(serviceClass); |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 55 | } |
| 56 | |
tom | 6d2a43e | 2014-09-08 01:50:20 -0700 | [diff] [blame] | 57 | /** |
Thomas Vachuska | b97cf28 | 2014-10-20 23:31:12 -0700 | [diff] [blame] | 58 | * Returns application ID for the CLI. |
| 59 | * |
| 60 | * @return command-line application identifier |
| 61 | */ |
| 62 | protected ApplicationId appId() { |
Ray Milkey | 0247986 | 2015-02-17 17:02:19 -0800 | [diff] [blame] | 63 | return get(CoreService.class) |
| 64 | .registerApplication("org.onosproject.cli"); |
Thomas Vachuska | b97cf28 | 2014-10-20 23:31:12 -0700 | [diff] [blame] | 65 | } |
| 66 | |
| 67 | /** |
tom | 6d2a43e | 2014-09-08 01:50:20 -0700 | [diff] [blame] | 68 | * Prints the arguments using the specified format. |
| 69 | * |
| 70 | * @param format format string; see {@link String#format} |
| 71 | * @param args arguments |
| 72 | */ |
tom | caf3bf7 | 2014-09-23 13:20:53 -0700 | [diff] [blame] | 73 | public void print(String format, Object... args) { |
Brian O'Connor | b28f5d7 | 2015-02-23 19:29:30 +0000 | [diff] [blame] | 74 | System.out.println(String.format(format, args)); |
tom | 6d2a43e | 2014-09-08 01:50:20 -0700 | [diff] [blame] | 75 | } |
| 76 | |
tom | 9eb57fb | 2014-09-11 19:42:38 -0700 | [diff] [blame] | 77 | /** |
| 78 | * Prints the arguments using the specified format to error stream. |
| 79 | * |
| 80 | * @param format format string; see {@link String#format} |
| 81 | * @param args arguments |
| 82 | */ |
tom | caf3bf7 | 2014-09-23 13:20:53 -0700 | [diff] [blame] | 83 | public void error(String format, Object... args) { |
Brian O'Connor | b28f5d7 | 2015-02-23 19:29:30 +0000 | [diff] [blame] | 84 | System.err.println(String.format(format, args)); |
tom | 9eb57fb | 2014-09-11 19:42:38 -0700 | [diff] [blame] | 85 | } |
| 86 | |
tom | 0872a17 | 2014-09-23 11:24:26 -0700 | [diff] [blame] | 87 | /** |
Thomas Vachuska | 944cb6c | 2014-10-22 17:05:42 -0700 | [diff] [blame] | 88 | * Produces a string image of the specified key/value annotations. |
| 89 | * |
| 90 | * @param annotations key/value annotations |
| 91 | * @return string image with ", k1=v1, k2=v2, ..." pairs |
| 92 | */ |
| 93 | public static String annotations(Annotations annotations) { |
Yi Tseng | f18e66e | 2018-01-31 16:11:42 -0800 | [diff] [blame] | 94 | if (annotations == null) { |
| 95 | annotations = DefaultAnnotations.EMPTY; |
| 96 | } |
Thomas Vachuska | 944cb6c | 2014-10-22 17:05:42 -0700 | [diff] [blame] | 97 | StringBuilder sb = new StringBuilder(); |
Laszlo Papp | 62c3e07 | 2018-01-18 12:40:21 +0000 | [diff] [blame] | 98 | Set<String> keys = new TreeSet<>(annotations.keys()); |
| 99 | for (String key : keys) { |
Thomas Vachuska | 944cb6c | 2014-10-22 17:05:42 -0700 | [diff] [blame] | 100 | sb.append(", ").append(key).append('=').append(annotations.value(key)); |
| 101 | } |
| 102 | return sb.toString(); |
| 103 | } |
| 104 | |
| 105 | /** |
Andrea Campanella | 1303253 | 2016-03-31 10:50:50 -0700 | [diff] [blame] | 106 | * Produces a string image of the specified key/value annotations. |
| 107 | * Excludes the keys in the given Set. |
| 108 | * |
| 109 | * @param annotations key/value annotations |
| 110 | * @param excludedKeys keys not to add in the resulting string |
| 111 | * @return string image with ", k1=v1, k2=v2, ..." pairs |
| 112 | */ |
| 113 | public static String annotations(Annotations annotations, Set<String> excludedKeys) { |
| 114 | StringBuilder sb = new StringBuilder(); |
| 115 | Set<String> keys = new TreeSet<>(annotations.keys()); |
| 116 | keys.removeAll(excludedKeys); |
| 117 | for (String key : keys) { |
| 118 | sb.append(", ").append(key).append('=').append(annotations.value(key)); |
| 119 | } |
| 120 | return sb.toString(); |
| 121 | } |
| 122 | |
| 123 | /** |
Thomas Vachuska | 944cb6c | 2014-10-22 17:05:42 -0700 | [diff] [blame] | 124 | * Produces a JSON object from the specified key/value annotations. |
| 125 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 126 | * @param mapper ObjectMapper to use while converting to JSON |
Thomas Vachuska | 944cb6c | 2014-10-22 17:05:42 -0700 | [diff] [blame] | 127 | * @param annotations key/value annotations |
| 128 | * @return JSON object |
| 129 | */ |
| 130 | public static ObjectNode annotations(ObjectMapper mapper, Annotations annotations) { |
| 131 | ObjectNode result = mapper.createObjectNode(); |
| 132 | for (String key : annotations.keys()) { |
| 133 | result.put(key, annotations.value(key)); |
| 134 | } |
| 135 | return result; |
| 136 | } |
| 137 | |
| 138 | /** |
tom | 0872a17 | 2014-09-23 11:24:26 -0700 | [diff] [blame] | 139 | * Executes this command. |
| 140 | */ |
| 141 | protected abstract void execute(); |
| 142 | |
tom | 32085cf | 2014-10-16 00:04:33 -0700 | [diff] [blame] | 143 | /** |
| 144 | * Indicates whether JSON format should be output. |
| 145 | * |
| 146 | * @return true if JSON is requested |
| 147 | */ |
| 148 | protected boolean outputJson() { |
| 149 | return json; |
| 150 | } |
| 151 | |
tom | 0872a17 | 2014-09-23 11:24:26 -0700 | [diff] [blame] | 152 | @Override |
| 153 | protected Object doExecute() throws Exception { |
| 154 | try { |
| 155 | execute(); |
| 156 | } catch (ServiceNotFoundException e) { |
| 157 | error(e.getMessage()); |
| 158 | } |
| 159 | return null; |
| 160 | } |
| 161 | |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 162 | |
| 163 | |
| 164 | private final ObjectMapper mapper = new ObjectMapper(); |
| 165 | |
| 166 | @Override |
| 167 | public ObjectMapper mapper() { |
| 168 | return mapper; |
| 169 | } |
| 170 | |
| 171 | @Override |
| 172 | @SuppressWarnings("unchecked") |
| 173 | public <T> JsonCodec<T> codec(Class<T> entityClass) { |
| 174 | return get(CodecService.class).getCodec(entityClass); |
| 175 | } |
| 176 | |
| 177 | @Override |
| 178 | public <T> T getService(Class<T> serviceClass) { |
| 179 | return get(serviceClass); |
| 180 | } |
| 181 | |
| 182 | /** |
| 183 | * Generates a Json representation of an object. |
| 184 | * |
| 185 | * @param entity object to generate JSON for |
| 186 | * @param entityClass class to format with - this chooses which codec to use |
| 187 | * @param <T> Type of the object being formatted |
| 188 | * @return JSON object representation |
| 189 | */ |
| 190 | public <T> ObjectNode jsonForEntity(T entity, Class<T> entityClass) { |
| 191 | return codec(entityClass).encode(entity, this); |
| 192 | } |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 193 | } |