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