CAMEL-7999: Renamed command
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/6b07fa82 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6b07fa82 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6b07fa82 Branch: refs/heads/master Commit: 6b07fa82a918c4c78f3885f221485d15c181035a Parents: 0906ef8 Author: Claus Ibsen <davscl...@apache.org> Authored: Fri Nov 14 09:36:58 2014 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Fri Nov 14 13:02:05 2014 +0100 ---------------------------------------------------------------------- .../commands/CatalogComponentListCommand.java | 183 +++++++++++++++++++ .../commands/ComponentCatalogListCommand.java | 183 ------------------- .../karaf/commands/CatalogComponentList.java | 35 ++++ .../karaf/commands/ComponentCatalogList.java | 35 ---- .../OSGI-INF/blueprint/camel-commands.xml | 4 +- 5 files changed, 220 insertions(+), 220 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/6b07fa82/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogComponentListCommand.java ---------------------------------------------------------------------- diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogComponentListCommand.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogComponentListCommand.java new file mode 100644 index 0000000..a168045 --- /dev/null +++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CatalogComponentListCommand.java @@ -0,0 +1,183 @@ +/** + * 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.commands; + +import java.io.PrintStream; +import java.util.Hashtable; +import java.util.List; +import java.util.Map; + +/** + * From the Camel catalog lists all the components. + */ +public class CatalogComponentListCommand extends AbstractCamelCommand { + + private static final String NAME_COLUMN_LABEL = "Name"; + private static final String STATUS_COLUMN_LABEL = "Status"; + private static final String MAVEN_COLUMN_LABEL = "Maven Coordinate"; + private static final String DESCRIPTION_COLUMN_LABEL = "Description"; + + 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; + // descriptions can be very long so clip by default after 120 chars + private static final int MAX_COLUMN_WIDTH = 120; + private static final int MIN_COLUMN_WIDTH = 12; + + private boolean verbose; + + public CatalogComponentListCommand(boolean verbose) { + this.verbose = verbose; + } + + @Override + public Object execute(CamelController camelController, PrintStream out, PrintStream err) throws Exception { + List<Map<String, String>> components = camelController.listComponentsCatalog(); + + if (components == null || components.isEmpty()) { + return null; + } + + final Map<String, Integer> columnWidths = computeColumnWidths(components); + final String headerFormat = buildFormatString(columnWidths, true, verbose); + final String rowFormat = buildFormatString(columnWidths, false, verbose); + + if (verbose) { + out.println(String.format(headerFormat, NAME_COLUMN_LABEL, STATUS_COLUMN_LABEL, MAVEN_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL)); + out.println(String.format(headerFormat, "----", "------", "----------------", "-----------")); + } else { + out.println(String.format(headerFormat, NAME_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL)); + out.println(String.format(headerFormat, "----", "-----------")); + } + for (final Map<String, String> component : components) { + if (verbose) { + String name = safeNull(component.get("name")); + String status = safeNull(component.get("status")); + String maven = ""; + if (component.containsKey("groupId") && component.containsKey("artifactId") && component.containsKey("version")) { + maven = component.get("groupId") + "/" + component.get("artifactId") + "/" + component.get("version"); + } + String description = safeNull(component.get("description")); + out.println(String.format(rowFormat, name, status, maven, description)); + } else { + String name = safeNull(component.get("name")); + String description = safeNull(component.get("description")); + out.println(String.format(rowFormat, name, description)); + } + } + + return null; + } + + private Map<String, Integer> computeColumnWidths(final Iterable<Map<String, String>> components) throws Exception { + if (components == null) { + return null; + } else { + // some of the options is optional so we need to start from 1 + int maxNameLen = NAME_COLUMN_LABEL.length(); + int maxStatusLen = STATUS_COLUMN_LABEL.length(); + int maxMavenLen = MAVEN_COLUMN_LABEL.length(); + int maxDescriptionLen = DESCRIPTION_COLUMN_LABEL.length(); + + for (final Map<String, String> component : components) { + + // grab the information and compute max len + String name = component.get("name"); + if (name != null) { + maxNameLen = Math.max(maxNameLen, name.length()); + } + String status = component.get("status"); + if (status != null) { + maxStatusLen = Math.max(maxStatusLen, status.length()); + } + if (component.containsKey("groupId") && component.containsKey("artifactId") && component.containsKey("version")) { + String mvn = component.get("groupId") + "/" + component.get("artifactId") + "/" + component.get("version"); + maxMavenLen = Math.max(maxMavenLen, mvn.length()); + } + String description = component.get("description"); + if (description != null) { + maxDescriptionLen = Math.max(maxDescriptionLen, description.length()); + } + } + + final Map<String, Integer> retval = new Hashtable<String, Integer>(4); + retval.put(NAME_COLUMN_LABEL, maxNameLen); + retval.put(STATUS_COLUMN_LABEL, maxStatusLen); + retval.put(MAVEN_COLUMN_LABEL, maxMavenLen); + retval.put(DESCRIPTION_COLUMN_LABEL, maxDescriptionLen); + + return retval; + } + } + + private String buildFormatString(Map<String, Integer> columnWidths, boolean isHeader, boolean isVerbose) { + 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; + + if (verbose) { + int nameLen = Math.min(columnWidths.get(NAME_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); + int statusLen = Math.min(columnWidths.get(STATUS_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); + int mavenLen = Math.min(columnWidths.get(MAVEN_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); + int descriptionLen = Math.min(columnWidths.get(DESCRIPTION_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); + + nameLen = Math.max(MIN_COLUMN_WIDTH, nameLen); + statusLen = Math.max(MIN_COLUMN_WIDTH, statusLen); + mavenLen = Math.max(MIN_COLUMN_WIDTH, mavenLen); + descriptionLen = Math.max(MIN_COLUMN_WIDTH, descriptionLen); + + final StringBuilder retval = new StringBuilder(DEFAULT_FORMAT_BUFFER_LENGTH); + retval.append(fieldPreamble).append("%-").append(nameLen).append('.').append(nameLen).append('s').append(fieldPostamble).append(' '); + retval.append(fieldPreamble).append("%-").append(statusLen).append('.').append(statusLen).append('s').append(fieldPostamble).append(' '); + retval.append(fieldPreamble).append("%-").append(mavenLen).append('.').append(mavenLen).append('s').append(fieldPostamble).append(' '); + retval.append(fieldPreamble).append("%-").append(descriptionLen).append('.').append(descriptionLen).append('s').append(fieldPostamble).append(' '); + return retval.toString(); + } else { + int nameLen = Math.min(columnWidths.get(NAME_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); + int descriptionLen = Math.min(columnWidths.get(DESCRIPTION_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); + + nameLen = Math.max(MIN_COLUMN_WIDTH, nameLen); + descriptionLen = Math.max(MIN_COLUMN_WIDTH, descriptionLen); + + final StringBuilder retval = new StringBuilder(DEFAULT_FORMAT_BUFFER_LENGTH); + retval.append(fieldPreamble).append("%-").append(nameLen).append('.').append(nameLen).append('s').append(fieldPostamble).append(' '); + retval.append(fieldPreamble).append("%-").append(descriptionLen).append('.').append(descriptionLen).append('s').append(fieldPostamble).append(' '); + return retval.toString(); + } + } + + private int getMaxColumnWidth() { + if (verbose) { + return Integer.MAX_VALUE; + } else { + return MAX_COLUMN_WIDTH; + } + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/6b07fa82/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ComponentCatalogListCommand.java ---------------------------------------------------------------------- diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ComponentCatalogListCommand.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ComponentCatalogListCommand.java deleted file mode 100644 index d63ec00..0000000 --- a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ComponentCatalogListCommand.java +++ /dev/null @@ -1,183 +0,0 @@ -/** - * 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.commands; - -import java.io.PrintStream; -import java.util.Hashtable; -import java.util.List; -import java.util.Map; - -/** - * List all the Camel components from the Camel catalog - */ -public class ComponentCatalogListCommand extends AbstractCamelCommand { - - private static final String NAME_COLUMN_LABEL = "Name"; - private static final String STATUS_COLUMN_LABEL = "Status"; - private static final String MAVEN_COLUMN_LABEL = "Maven Coordinate"; - private static final String DESCRIPTION_COLUMN_LABEL = "Description"; - - 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; - // descriptions can be very long so clip by default after 120 chars - private static final int MAX_COLUMN_WIDTH = 120; - private static final int MIN_COLUMN_WIDTH = 12; - - private boolean verbose; - - public ComponentCatalogListCommand(boolean verbose) { - this.verbose = verbose; - } - - @Override - public Object execute(CamelController camelController, PrintStream out, PrintStream err) throws Exception { - List<Map<String, String>> components = camelController.listComponentsCatalog(); - - if (components == null || components.isEmpty()) { - return null; - } - - final Map<String, Integer> columnWidths = computeColumnWidths(components); - final String headerFormat = buildFormatString(columnWidths, true, verbose); - final String rowFormat = buildFormatString(columnWidths, false, verbose); - - if (verbose) { - out.println(String.format(headerFormat, NAME_COLUMN_LABEL, STATUS_COLUMN_LABEL, MAVEN_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL)); - out.println(String.format(headerFormat, "----", "------", "----------------", "-----------")); - } else { - out.println(String.format(headerFormat, NAME_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL)); - out.println(String.format(headerFormat, "----", "-----------")); - } - for (final Map<String, String> component : components) { - if (verbose) { - String name = safeNull(component.get("name")); - String status = safeNull(component.get("status")); - String maven = ""; - if (component.containsKey("groupId") && component.containsKey("artifactId") && component.containsKey("version")) { - maven = component.get("groupId") + "/" + component.get("artifactId") + "/" + component.get("version"); - } - String description = safeNull(component.get("description")); - out.println(String.format(rowFormat, name, status, maven, description)); - } else { - String name = safeNull(component.get("name")); - String description = safeNull(component.get("description")); - out.println(String.format(rowFormat, name, description)); - } - } - - return null; - } - - private Map<String, Integer> computeColumnWidths(final Iterable<Map<String, String>> components) throws Exception { - if (components == null) { - return null; - } else { - // some of the options is optional so we need to start from 1 - int maxNameLen = NAME_COLUMN_LABEL.length(); - int maxStatusLen = STATUS_COLUMN_LABEL.length(); - int maxMavenLen = MAVEN_COLUMN_LABEL.length(); - int maxDescriptionLen = DESCRIPTION_COLUMN_LABEL.length(); - - for (final Map<String, String> component : components) { - - // grab the information and compute max len - String name = component.get("name"); - if (name != null) { - maxNameLen = Math.max(maxNameLen, name.length()); - } - String status = component.get("status"); - if (status != null) { - maxStatusLen = Math.max(maxStatusLen, status.length()); - } - if (component.containsKey("groupId") && component.containsKey("artifactId") && component.containsKey("version")) { - String mvn = component.get("groupId") + "/" + component.get("artifactId") + "/" + component.get("version"); - maxMavenLen = Math.max(maxMavenLen, mvn.length()); - } - String description = component.get("description"); - if (description != null) { - maxDescriptionLen = Math.max(maxDescriptionLen, description.length()); - } - } - - final Map<String, Integer> retval = new Hashtable<String, Integer>(4); - retval.put(NAME_COLUMN_LABEL, maxNameLen); - retval.put(STATUS_COLUMN_LABEL, maxStatusLen); - retval.put(MAVEN_COLUMN_LABEL, maxMavenLen); - retval.put(DESCRIPTION_COLUMN_LABEL, maxDescriptionLen); - - return retval; - } - } - - private String buildFormatString(Map<String, Integer> columnWidths, boolean isHeader, boolean isVerbose) { - 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; - - if (verbose) { - int nameLen = Math.min(columnWidths.get(NAME_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); - int statusLen = Math.min(columnWidths.get(STATUS_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); - int mavenLen = Math.min(columnWidths.get(MAVEN_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); - int descriptionLen = Math.min(columnWidths.get(DESCRIPTION_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); - - nameLen = Math.max(MIN_COLUMN_WIDTH, nameLen); - statusLen = Math.max(MIN_COLUMN_WIDTH, statusLen); - mavenLen = Math.max(MIN_COLUMN_WIDTH, mavenLen); - descriptionLen = Math.max(MIN_COLUMN_WIDTH, descriptionLen); - - final StringBuilder retval = new StringBuilder(DEFAULT_FORMAT_BUFFER_LENGTH); - retval.append(fieldPreamble).append("%-").append(nameLen).append('.').append(nameLen).append('s').append(fieldPostamble).append(' '); - retval.append(fieldPreamble).append("%-").append(statusLen).append('.').append(statusLen).append('s').append(fieldPostamble).append(' '); - retval.append(fieldPreamble).append("%-").append(mavenLen).append('.').append(mavenLen).append('s').append(fieldPostamble).append(' '); - retval.append(fieldPreamble).append("%-").append(descriptionLen).append('.').append(descriptionLen).append('s').append(fieldPostamble).append(' '); - return retval.toString(); - } else { - int nameLen = Math.min(columnWidths.get(NAME_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); - int descriptionLen = Math.min(columnWidths.get(DESCRIPTION_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth()); - - nameLen = Math.max(MIN_COLUMN_WIDTH, nameLen); - descriptionLen = Math.max(MIN_COLUMN_WIDTH, descriptionLen); - - final StringBuilder retval = new StringBuilder(DEFAULT_FORMAT_BUFFER_LENGTH); - retval.append(fieldPreamble).append("%-").append(nameLen).append('.').append(nameLen).append('s').append(fieldPostamble).append(' '); - retval.append(fieldPreamble).append("%-").append(descriptionLen).append('.').append(descriptionLen).append('s').append(fieldPostamble).append(' '); - return retval.toString(); - } - } - - private int getMaxColumnWidth() { - if (verbose) { - return Integer.MAX_VALUE; - } else { - return MAX_COLUMN_WIDTH; - } - } - -} http://git-wip-us.apache.org/repos/asf/camel/blob/6b07fa82/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/CatalogComponentList.java ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/CatalogComponentList.java b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/CatalogComponentList.java new file mode 100644 index 0000000..2fc2463 --- /dev/null +++ b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/CatalogComponentList.java @@ -0,0 +1,35 @@ +/** + * 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 org.apache.camel.commands.CatalogComponentListCommand; +import org.apache.felix.gogo.commands.Command; +import org.apache.felix.gogo.commands.Option; + +@Command(scope = "camel", name = "catalog-component-list", description = "Lists all Camel components from the Camel catalog.") +public class CatalogComponentList extends CamelCommandSupport { + + @Option(name = "--verbose", aliases = "-v", description = "Verbose output which shows more information", + required = false, multiValued = false, valueToShowInHelp = "false") + boolean verbose; + + protected Object doExecute() throws Exception { + CatalogComponentListCommand command = new CatalogComponentListCommand(verbose); + return command.execute(camelController, System.out, System.err); + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/6b07fa82/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ComponentCatalogList.java ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ComponentCatalogList.java b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ComponentCatalogList.java deleted file mode 100644 index 380f455..0000000 --- a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ComponentCatalogList.java +++ /dev/null @@ -1,35 +0,0 @@ -/** - * 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 org.apache.camel.commands.ComponentCatalogListCommand; -import org.apache.felix.gogo.commands.Command; -import org.apache.felix.gogo.commands.Option; - -@Command(scope = "camel", name = "component-catalog-list", description = "Lists all Camel components from the Camel catalog.") -public class ComponentCatalogList extends CamelCommandSupport { - - @Option(name = "--verbose", aliases = "-v", description = "Verbose output which shows more information", - required = false, multiValued = false, valueToShowInHelp = "false") - boolean verbose; - - protected Object doExecute() throws Exception { - ComponentCatalogListCommand command = new ComponentCatalogListCommand(verbose); - return command.execute(camelController, System.out, System.err); - } - -} http://git-wip-us.apache.org/repos/asf/camel/blob/6b07fa82/platforms/karaf/commands/src/main/resources/OSGI-INF/blueprint/camel-commands.xml ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/resources/OSGI-INF/blueprint/camel-commands.xml b/platforms/karaf/commands/src/main/resources/OSGI-INF/blueprint/camel-commands.xml index e18cc3f..0e87fe6 100644 --- a/platforms/karaf/commands/src/main/resources/OSGI-INF/blueprint/camel-commands.xml +++ b/platforms/karaf/commands/src/main/resources/OSGI-INF/blueprint/camel-commands.xml @@ -233,8 +233,8 @@ <null/> </completers> </command> - <command name="camel/component-catalog-list"> - <action class="org.apache.camel.karaf.commands.ComponentCatalogList"> + <command name="camel/catalog-component-list"> + <action class="org.apache.camel.karaf.commands.CatalogComponentList"> <property name="camelController" ref="camelController"/> </action> <completers>
