/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.karaf.commands;
import java.io.PrintStream;
import java.util.Hashtable;
import java.util.List;
import java.util.Map;
import org.apache.camel.Route;
import org.apache.camel.ServiceStatus;
import org.apache.felix.gogo.commands.Argument;
import org.apache.felix.gogo.commands.Command;
import org.apache.karaf.shell.console.OsgiCommandSupport;
/**
* Command to list all Camel routes.
*/
@Command(scope = "camel", name = "route-list", description = "List Camel routes.")
public class RouteList extends OsgiCommandSupport {
private static final String CONTEXT_COLUMN_LABEL = "Context";
private static final String ROUTE_COLUMN_LABEL = "Route";
private static final String STATUS_COLUMN_LABEL = "Status";
private static final int DEFAULT_COLUMN_WIDTH_INCREMENT = 0;
private static final String DEFAULT_FIELD_PREAMBLE = " ";
private static final String DEFAULT_FIELD_POSTAMBLE = " ";
private static final String DEFAULT_HEADER_PREAMBLE = " ";
private static final String DEFAULT_HEADER_POSTAMBLE = " ";
private static final int DEFAULT_FORMAT_BUFFER_LENGTH = 24;
private static final int MAX_COLUMN_WIDTH = Integer.MAX_VALUE;
private static final int MIN_COLUMN_WIDTH = 12;
@Argument(index = 0, name = "name", description = "The Camel context name where to look for the route", required = false, multiValued = false)
String name;
private CamelController camelController;
public void setCamelController(CamelController camelController) {
this.camelController = camelController;
}
protected Object doExecute() throws Exception {
List<Route> routes = camelController.getRoutes(name);
final Map<String, Integer> columnWidths = computeColumnWidths(routes);
final String headerFormat = buildFormatString(columnWidths, true);
final String rowFormat = buildFormatString(columnWidths, false);
final PrintStream out = System.out;
if (routes.size() > 0) {
out.println(String.format(headerFormat, CONTEXT_COLUMN_LABEL, ROUTE_COLUMN_LABEL, STATUS_COLUMN_LABEL));
out.println(String.format(headerFormat, "-------", "-----", "------"));
for (Route route : routes) {
String contextId = route.getRouteContext().getCamelContext().getName();
String routeId = route.getId();
ServiceStatus status = route.getRouteContext().getCamelContext().getRouteStatus(routeId);
out.println(String.format(rowFormat, contextId, routeId, status));
}
}
return null;
}
private static Map<String, Integer> computeColumnWidths(final Iterable<Route> routes) throws Exception {
if (routes == null) {
throw new IllegalArgumentException("Unable to determine column widths from null Iterable<Route>");
} else {
int maxContextLen = 0;
int maxRouteLen = 0;
int maxStatusLen = 0;
for (final Route route : routes) {
final String contextId = route.getRouteContext().getCamelContext().getName();
maxContextLen = java.lang.Math.max(maxContextLen, contextId == null ? 0 : contextId.length());
final String routeId = route.getId();
maxRouteLen = java.lang.Math.max(maxRouteLen, routeId == null ? 0 : routeId.length());
final String status = route.getRouteContext().getCamelContext().getRouteStatus(routeId).name();
maxStatusLen = java.lang.Math.max(maxStatusLen, status == null ? 0 : status.length());
}
final Map<String, Integer> retval = new Hashtable<String, Integer>(3);
retval.put(CONTEXT_COLUMN_LABEL, maxContextLen);
retval.put(ROUTE_COLUMN_LABEL, maxRouteLen);
retval.put(STATUS_COLUMN_LABEL, maxStatusLen);
return retval;
}
}
private static String buildFormatString(final Map<String, Integer> columnWidths, final boolean isHeader) {
final String fieldPreamble;
final String fieldPostamble;
final int columnWidthIncrement;
if (isHeader) {
fieldPreamble = DEFAULT_HEADER_PREAMBLE;
fieldPostamble = DEFAULT_HEADER_POSTAMBLE;
} else {
fieldPreamble = DEFAULT_FIELD_PREAMBLE;
fieldPostamble = DEFAULT_FIELD_POSTAMBLE;
}
columnWidthIncrement = DEFAULT_COLUMN_WIDTH_INCREMENT;
int contextLen = Math.min(columnWidths.get(CONTEXT_COLUMN_LABEL) + columnWidthIncrement, MAX_COLUMN_WIDTH);
int routeLen = Math.min(columnWidths.get(ROUTE_COLUMN_LABEL) + columnWidthIncrement, MAX_COLUMN_WIDTH);
int statusLen = Math.min(columnWidths.get(STATUS_COLUMN_LABEL) + columnWidthIncrement, MAX_COLUMN_WIDTH);
contextLen = Math.max(MIN_COLUMN_WIDTH, contextLen);
routeLen = Math.max(MIN_COLUMN_WIDTH, routeLen);
// last row does not have min width
final StringBuilder retval = new StringBuilder(DEFAULT_FORMAT_BUFFER_LENGTH);
retval.append(fieldPreamble).append("%-").append(contextLen).append('.').append(contextLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(routeLen).append('.').append(routeLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(statusLen).append('.').append(statusLen).append('s').append(fieldPostamble).append(' ');
return retval.toString();
}
}