Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [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.cli.app; |
| 17 | |
Sho SHIMIZU | ef7e290 | 2016-02-12 18:38:29 -0800 | [diff] [blame] | 18 | import java.net.URI; |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 19 | import java.util.Collections; |
Yuta HIGUCHI | 9892d1a | 2017-07-07 16:31:30 -0700 | [diff] [blame] | 20 | import java.util.Comparator; |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 21 | import java.util.List; |
| 22 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 23 | import org.apache.karaf.shell.api.action.Command; |
| 24 | import org.apache.karaf.shell.api.action.lifecycle.Service; |
| 25 | import org.apache.karaf.shell.api.action.Option; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 26 | import org.onosproject.app.ApplicationService; |
| 27 | import org.onosproject.cli.AbstractShellCommand; |
Ray Milkey | c747729 | 2016-03-11 10:53:43 -0800 | [diff] [blame] | 28 | import org.onosproject.utils.Comparators; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 29 | import org.onosproject.core.Application; |
| 30 | |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 31 | import com.fasterxml.jackson.databind.JsonNode; |
| 32 | import com.fasterxml.jackson.databind.ObjectMapper; |
| 33 | import com.fasterxml.jackson.databind.node.ArrayNode; |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 34 | |
| 35 | import static com.google.common.collect.Lists.newArrayList; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 36 | import static org.onosproject.app.ApplicationState.ACTIVE; |
| 37 | |
| 38 | /** |
| 39 | * Lists application information. |
| 40 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 41 | @Service |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 42 | @Command(scope = "onos", name = "apps", |
| 43 | description = "Lists application information") |
| 44 | public class ApplicationsListCommand extends AbstractShellCommand { |
| 45 | |
| 46 | private static final String FMT = |
Jian Li | 02c109c | 2016-01-19 19:24:44 -0800 | [diff] [blame] | 47 | "%s id=%d, name=%s, version=%s, origin=%s, category=%s, description=%s, " + |
| 48 | "features=%s, featuresRepo=%s, apps=%s, permissions=%s, url=%s"; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 49 | |
Thomas Vachuska | 8ceff30 | 2015-04-03 11:45:53 -0700 | [diff] [blame] | 50 | private static final String SHORT_FMT = |
Jian Li | 02c109c | 2016-01-19 19:24:44 -0800 | [diff] [blame] | 51 | "%s %3d %-36s %-8s %s"; |
Thomas Vachuska | 8ceff30 | 2015-04-03 11:45:53 -0700 | [diff] [blame] | 52 | |
| 53 | @Option(name = "-s", aliases = "--short", description = "Show short output only", |
| 54 | required = false, multiValued = false) |
| 55 | private boolean shortOnly = false; |
| 56 | |
Thomas Vachuska | fba2857 | 2015-03-25 18:48:59 -0700 | [diff] [blame] | 57 | @Option(name = "-a", aliases = "--active", description = "Show active only", |
| 58 | required = false, multiValued = false) |
| 59 | private boolean activeOnly = false; |
| 60 | |
Yuta HIGUCHI | 9892d1a | 2017-07-07 16:31:30 -0700 | [diff] [blame] | 61 | @Option(name = "-n", aliases = "--name", description = "Sort by application ID name") |
| 62 | private boolean sortByName = false; |
| 63 | |
Thomas Vachuska | fba2857 | 2015-03-25 18:48:59 -0700 | [diff] [blame] | 64 | |
Arnav Jain | efb57e5 | 2019-07-09 14:24:10 -0700 | [diff] [blame] | 65 | @Option(name = "-r", aliases = "--regapps", description = "Get Registered Apps for Runtime Version") |
| 66 | private boolean getRegisteredApps = false; |
| 67 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 68 | @Override |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 69 | protected void doExecute() { |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 70 | ApplicationService service = get(ApplicationService.class); |
Arnav Jain | efb57e5 | 2019-07-09 14:24:10 -0700 | [diff] [blame] | 71 | List<Application> apps; |
| 72 | if (getRegisteredApps) { |
| 73 | apps = newArrayList(service.getRegisteredApplications()); |
| 74 | } else { |
| 75 | apps = newArrayList(service.getApplications()); |
| 76 | } |
Yuta HIGUCHI | 9892d1a | 2017-07-07 16:31:30 -0700 | [diff] [blame] | 77 | if (sortByName) { |
| 78 | apps.sort(Comparator.comparing(app -> app.id().name())); |
| 79 | } else { |
| 80 | Collections.sort(apps, Comparators.APP_COMPARATOR); |
| 81 | } |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 82 | if (outputJson()) { |
| 83 | print("%s", json(service, apps)); |
| 84 | } else { |
| 85 | for (Application app : apps) { |
Thomas Vachuska | fba2857 | 2015-03-25 18:48:59 -0700 | [diff] [blame] | 86 | boolean isActive = service.getState(app.id()) == ACTIVE; |
| 87 | if (activeOnly && isActive || !activeOnly) { |
Thomas Vachuska | 8ceff30 | 2015-04-03 11:45:53 -0700 | [diff] [blame] | 88 | if (shortOnly) { |
Andrea Campanella | 915e6c8 | 2016-03-09 17:55:41 -0800 | [diff] [blame] | 89 | String shortDescription = app.title().equals(app.id().name()) ? |
| 90 | app.description().replaceAll("[\\r\\n]", " ").replaceAll(" +", " ") : |
| 91 | app.title(); |
Thomas Vachuska | 8ceff30 | 2015-04-03 11:45:53 -0700 | [diff] [blame] | 92 | print(SHORT_FMT, isActive ? "*" : " ", |
Andrea Campanella | 915e6c8 | 2016-03-09 17:55:41 -0800 | [diff] [blame] | 93 | app.id().id(), app.id().name(), app.version(), shortDescription); |
Thomas Vachuska | 8ceff30 | 2015-04-03 11:45:53 -0700 | [diff] [blame] | 94 | } else { |
| 95 | print(FMT, isActive ? "*" : " ", |
| 96 | app.id().id(), app.id().name(), app.version(), app.origin(), |
Jian Li | 02c109c | 2016-01-19 19:24:44 -0800 | [diff] [blame] | 97 | app.category(), app.description(), app.features(), |
Sho SHIMIZU | ef7e290 | 2016-02-12 18:38:29 -0800 | [diff] [blame] | 98 | app.featuresRepo().map(URI::toString).orElse(""), |
Jian Li | 02c109c | 2016-01-19 19:24:44 -0800 | [diff] [blame] | 99 | app.requiredApps(), app.permissions(), app.url()); |
Thomas Vachuska | 8ceff30 | 2015-04-03 11:45:53 -0700 | [diff] [blame] | 100 | } |
Thomas Vachuska | fba2857 | 2015-03-25 18:48:59 -0700 | [diff] [blame] | 101 | } |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 102 | } |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 103 | } |
| 104 | } |
| 105 | |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 106 | private JsonNode json(ApplicationService service, List<Application> apps) { |
| 107 | ObjectMapper mapper = new ObjectMapper(); |
| 108 | ArrayNode result = mapper.createArrayNode(); |
| 109 | for (Application app : apps) { |
Thomas Vachuska | fba2857 | 2015-03-25 18:48:59 -0700 | [diff] [blame] | 110 | boolean isActive = service.getState(app.id()) == ACTIVE; |
| 111 | if (activeOnly && isActive || !activeOnly) { |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 112 | result.add(jsonForEntity(app, Application.class)); |
Thomas Vachuska | fba2857 | 2015-03-25 18:48:59 -0700 | [diff] [blame] | 113 | } |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 114 | } |
| 115 | return result; |
| 116 | } |
| 117 | |
Ray Milkey | 3078fc0 | 2015-05-06 16:14:14 -0700 | [diff] [blame] | 118 | |
Thomas Vachuska | ebf5e54 | 2015-02-03 19:38:13 -0800 | [diff] [blame] | 119 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 120 | } |