CAMEL-8041: Camel commands should be reusable.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/cfb04fde Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/cfb04fde Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/cfb04fde Branch: refs/heads/master Commit: cfb04fdeab012959288e1d02f8536aa2c213cd95 Parents: f5b7656 Author: Claus Ibsen <davscl...@apache.org> Authored: Thu Nov 13 10:04:14 2014 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Nov 13 10:04:14 2014 +0100 ---------------------------------------------------------------------- .../camel/commands/ContextResumeCommand.java | 34 ++++ .../camel/commands/ContextStartCommand.java | 34 ++++ .../camel/commands/ContextStopCommand.java | 34 ++++ .../camel/commands/ContextSuspendCommand.java | 34 ++++ .../karaf/commands/AbstractContextCommand.java | 1 + .../camel/karaf/commands/ComponentList.java | 154 +------------------ .../camel/karaf/commands/ContextResume.java | 14 +- .../camel/karaf/commands/ContextStart.java | 13 +- .../camel/karaf/commands/ContextStop.java | 13 +- .../camel/karaf/commands/ContextSuspend.java | 13 +- 10 files changed, 176 insertions(+), 168 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextResumeCommand.java ---------------------------------------------------------------------- diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextResumeCommand.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextResumeCommand.java new file mode 100644 index 0000000..8273b4a --- /dev/null +++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextResumeCommand.java @@ -0,0 +1,34 @@ +/** + * 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 org.apache.camel.CamelContext; + +public class ContextResumeCommand extends AbstractContextCommand { + + public ContextResumeCommand(String context) { + super(context); + } + + @Override + protected Object performContextCommand(CamelController camelController, CamelContext camelContext, PrintStream out, PrintStream err) throws Exception { + camelContext.resume(); + return null; + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextStartCommand.java ---------------------------------------------------------------------- diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextStartCommand.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextStartCommand.java new file mode 100644 index 0000000..d7e0f34 --- /dev/null +++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextStartCommand.java @@ -0,0 +1,34 @@ +/** + * 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 org.apache.camel.CamelContext; + +public class ContextStartCommand extends AbstractContextCommand { + + public ContextStartCommand(String context) { + super(context); + } + + @Override + protected Object performContextCommand(CamelController camelController, CamelContext camelContext, PrintStream out, PrintStream err) throws Exception { + camelContext.start(); + return null; + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextStopCommand.java ---------------------------------------------------------------------- diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextStopCommand.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextStopCommand.java new file mode 100644 index 0000000..615d7a8 --- /dev/null +++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextStopCommand.java @@ -0,0 +1,34 @@ +/** + * 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 org.apache.camel.CamelContext; + +public class ContextStopCommand extends AbstractContextCommand { + + public ContextStopCommand(String context) { + super(context); + } + + @Override + protected Object performContextCommand(CamelController camelController, CamelContext camelContext, PrintStream out, PrintStream err) throws Exception { + camelContext.stop(); + return null; + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextSuspendCommand.java ---------------------------------------------------------------------- diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextSuspendCommand.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextSuspendCommand.java new file mode 100644 index 0000000..15900c4 --- /dev/null +++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/ContextSuspendCommand.java @@ -0,0 +1,34 @@ +/** + * 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 org.apache.camel.CamelContext; + +public class ContextSuspendCommand extends AbstractContextCommand { + + public ContextSuspendCommand(String context) { + super(context); + } + + @Override + protected Object performContextCommand(CamelController camelController, CamelContext camelContext, PrintStream out, PrintStream err) throws Exception { + camelContext.suspend(); + return null; + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/AbstractContextCommand.java ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/AbstractContextCommand.java b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/AbstractContextCommand.java index 7cd3625..bb781d7 100644 --- a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/AbstractContextCommand.java +++ b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/AbstractContextCommand.java @@ -19,6 +19,7 @@ package org.apache.camel.karaf.commands; import org.apache.camel.CamelContext; import org.apache.felix.gogo.commands.Argument; +@Deprecated public abstract class AbstractContextCommand extends CamelCommandSupport { @Argument(index = 0, name = "context", description = "The name of the Camel context.", required = true, multiValued = false) http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ComponentList.java ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ComponentList.java b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ComponentList.java index 43d1a69..27a04cb 100644 --- a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ComponentList.java +++ b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ComponentList.java @@ -16,11 +16,7 @@ */ 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.commands.ComponentListCommand; import org.apache.felix.gogo.commands.Argument; import org.apache.felix.gogo.commands.Command; import org.apache.felix.gogo.commands.Option; @@ -31,21 +27,6 @@ import org.apache.felix.gogo.commands.Option; @Command(scope = "camel", name = "component-list", description = "Lists all Camel components available in CamelContexts.") public class ComponentList extends CamelCommandSupport { - 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; - @Argument(index = 0, name = "name", description = "The Camel context name where to look for the components", required = true, multiValued = false) String name; @@ -54,137 +35,8 @@ public class ComponentList extends CamelCommandSupport { boolean verbose; protected Object doExecute() throws Exception { - List<Map<String, String>> components = camelController.listComponents(name); - - 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); - final PrintStream out = System.out; - - 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 = 1; - int maxStatusLen = 1; - int maxMavenLen = 1; - int maxDescriptionLen = 1; - - 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()); - } - String type = component.get("type"); - 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); - // last row does not have min width - - 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); - // last row does not have min width - - 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; - } + ComponentListCommand command = new ComponentListCommand(name, verbose); + return command.execute(camelController, System.out, System.err); } } http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextResume.java ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextResume.java b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextResume.java index 7c8580e..384bd56 100644 --- a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextResume.java +++ b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextResume.java @@ -16,18 +16,22 @@ */ package org.apache.camel.karaf.commands; -import org.apache.camel.CamelContext; +import org.apache.camel.commands.ContextResumeCommand; +import org.apache.felix.gogo.commands.Argument; import org.apache.felix.gogo.commands.Command; /** * Command to resume a Camel context. */ @Command(scope = "camel", name = "context-resume", description = "Resumes a Camel context.") -public class ContextResume extends AbstractContextCommand { +public class ContextResume extends CamelCommandSupport { + + @Argument(index = 0, name = "context", description = "The name of the Camel context.", required = true, multiValued = false) + String context; @Override - protected void performContextCommand(CamelContext camelContext) throws Exception { - camelContext.resume(); + protected Object doExecute() throws Exception { + ContextResumeCommand command = new ContextResumeCommand(context); + return command.execute(camelController, System.out, System.err); } - } http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStart.java ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStart.java b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStart.java index e2d3e0f..b231715 100644 --- a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStart.java +++ b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStart.java @@ -16,18 +16,23 @@ */ package org.apache.camel.karaf.commands; -import org.apache.camel.CamelContext; +import org.apache.camel.commands.ContextStartCommand; +import org.apache.felix.gogo.commands.Argument; import org.apache.felix.gogo.commands.Command; /** * Command to start a Camel context. */ @Command(scope = "camel", name = "context-start", description = "Start a Camel context.") -public class ContextStart extends AbstractContextCommand { +public class ContextStart extends CamelCommandSupport { + + @Argument(index = 0, name = "context", description = "The name of the Camel context.", required = true, multiValued = false) + String context; @Override - protected void performContextCommand(CamelContext camelContext) throws Exception { - camelContext.start(); + protected Object doExecute() throws Exception { + ContextStartCommand command = new ContextStartCommand(context); + return command.execute(camelController, System.out, System.err); } } http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStop.java ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStop.java b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStop.java index 303c388..fd48e22 100644 --- a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStop.java +++ b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextStop.java @@ -16,18 +16,23 @@ */ package org.apache.camel.karaf.commands; -import org.apache.camel.CamelContext; +import org.apache.camel.commands.ContextStopCommand; +import org.apache.felix.gogo.commands.Argument; import org.apache.felix.gogo.commands.Command; /** * Command to stop a Camel context. */ @Command(scope = "camel", name = "context-stop", description = "Stop a Camel context. It becomes unavailable and can not be started again.") -public class ContextStop extends AbstractContextCommand { +public class ContextStop extends CamelCommandSupport { + + @Argument(index = 0, name = "context", description = "The name of the Camel context.", required = true, multiValued = false) + String context; @Override - protected void performContextCommand(CamelContext camelContext) throws Exception { - camelContext.stop(); + protected Object doExecute() throws Exception { + ContextStopCommand command = new ContextStopCommand(context); + return command.execute(camelController, System.out, System.err); } } http://git-wip-us.apache.org/repos/asf/camel/blob/cfb04fde/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextSuspend.java ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextSuspend.java b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextSuspend.java index db24b9d..05d48fd 100644 --- a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextSuspend.java +++ b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextSuspend.java @@ -16,18 +16,23 @@ */ package org.apache.camel.karaf.commands; -import org.apache.camel.CamelContext; +import org.apache.camel.commands.ContextSuspendCommand; +import org.apache.felix.gogo.commands.Argument; import org.apache.felix.gogo.commands.Command; /** * Command to suspend a Camel context. */ @Command(scope = "camel", name = "context-suspend", description = "Suspends a Camel context.") -public class ContextSuspend extends AbstractContextCommand { +public class ContextSuspend extends CamelCommandSupport { + + @Argument(index = 0, name = "context", description = "The name of the Camel context.", required = true, multiValued = false) + String context; @Override - protected void performContextCommand(CamelContext camelContext) throws Exception { - camelContext.suspend(); + protected Object doExecute() throws Exception { + ContextSuspendCommand command = new ContextSuspendCommand(context); + return command.execute(camelController, System.out, System.err); } }
