You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2015/03/26 22:51:26 UTC
[04/10] camel git commit: CAMEL-8558: Camel component docs now
include a human readable title for the component names.
CAMEL-8558: Camel component docs now include a human readable title for the component names.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/ce73f2b3
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/ce73f2b3
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/ce73f2b3
Branch: refs/heads/master
Commit: ce73f2b37b5e22d486f4f4833739cf5a1d35aff1
Parents: 78a9015
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Mar 26 21:49:01 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Mar 26 21:49:01 2015 +0100
----------------------------------------------------------------------
.../management/mbean/CamelOpenMBeanTypes.java | 6 ++---
.../management/mbean/ManagedCamelContext.java | 9 ++++---
.../salesforce/SalesforceEndpoint.java | 2 +-
.../camel/commands/AbstractCamelController.java | 8 +++++-
.../commands/CatalogComponentListCommand.java | 27 +++++++++++++++-----
.../jolokia/DefaultJolokiaCamelController.java | 1 +
6 files changed, 39 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/ce73f2b3/camel-core/src/main/java/org/apache/camel/api/management/mbean/CamelOpenMBeanTypes.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/api/management/mbean/CamelOpenMBeanTypes.java b/camel-core/src/main/java/org/apache/camel/api/management/mbean/CamelOpenMBeanTypes.java
index 90de994..de84321 100644
--- a/camel-core/src/main/java/org/apache/camel/api/management/mbean/CamelOpenMBeanTypes.java
+++ b/camel-core/src/main/java/org/apache/camel/api/management/mbean/CamelOpenMBeanTypes.java
@@ -108,9 +108,9 @@ public final class CamelOpenMBeanTypes {
}
public static CompositeType listComponentsCompositeType() throws OpenDataException {
- return new CompositeType("components", "Components", new String[]{"name", "description", "label", "status", "type", "groupId", "artifactId", "version"},
- new String[]{"Name", "Description", "Label", "Status", "Type", "GroupId", "ArtifactId", "Version"},
- new OpenType[]{SimpleType.STRING, SimpleType.STRING, SimpleType.STRING, SimpleType.STRING,
+ return new CompositeType("components", "Components", new String[]{"name", "title", "description", "label", "status", "type", "groupId", "artifactId", "version"},
+ new String[]{"Name", "Title", "Description", "Label", "Status", "Type", "GroupId", "ArtifactId", "Version"},
+ new OpenType[]{SimpleType.STRING, SimpleType.STRING, SimpleType.STRING, SimpleType.STRING, SimpleType.STRING,
SimpleType.STRING, SimpleType.STRING, SimpleType.STRING, SimpleType.STRING});
}
http://git-wip-us.apache.org/repos/asf/camel/blob/ce73f2b3/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java b/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java
index 598c340..aa4204c 100644
--- a/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java
+++ b/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java
@@ -535,6 +535,7 @@ public class ManagedCamelContext extends ManagedPerformanceCounter implements Ti
// gather component detail for each component
for (Map.Entry<String, Properties> entry : components.entrySet()) {
String name = entry.getKey();
+ String title = null;
String description = null;
String label = null;
String status = context.hasComponent(name) != null ? "in use" : "on classpath";
@@ -552,7 +553,9 @@ public class ManagedCamelContext extends ManagedPerformanceCounter implements Ti
String json = context.getComponentParameterJsonSchema(target);
List<Map<String, String>> rows = JsonSchemaHelper.parseJsonSchema("component", json, false);
for (Map<String, String> row : rows) {
- if (row.containsKey("description")) {
+ if (row.containsKey("title")) {
+ title = row.get("title");
+ } else if (row.containsKey("description")) {
description = row.get("description");
} else if (row.containsKey("label")) {
label = row.get("label");
@@ -568,8 +571,8 @@ public class ManagedCamelContext extends ManagedPerformanceCounter implements Ti
}
CompositeType ct = CamelOpenMBeanTypes.listComponentsCompositeType();
- CompositeData data = new CompositeDataSupport(ct, new String[]{"name", "description", "label", "status", "type", "groupId", "artifactId", "version"},
- new Object[]{name, description, label, status, type, groupId, artifactId, version});
+ CompositeData data = new CompositeDataSupport(ct, new String[]{"name", "title", "description", "label", "status", "type", "groupId", "artifactId", "version"},
+ new Object[]{name, title, description, label, status, type, groupId, artifactId, version});
answer.put(data);
}
return answer;
http://git-wip-us.apache.org/repos/asf/camel/blob/ce73f2b3/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
index 7f00b9d..925b594 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
+++ b/components/camel-salesforce/camel-salesforce-component/src/main/java/org/apache/camel/component/salesforce/SalesforceEndpoint.java
@@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory;
/**
* Represents a Salesforce endpoint.
*/
-@UriEndpoint(scheme = "salesforce", titles = "Salesforce", syntax = "salesforce:operationName:topicName", consumerClass = SalesforceConsumer.class)
+@UriEndpoint(scheme = "salesforce", title = "Salesforce", syntax = "salesforce:operationName:topicName", consumerClass = SalesforceConsumer.class)
public class SalesforceEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(SalesforceEndpoint.class);
http://git-wip-us.apache.org/repos/asf/camel/blob/ce73f2b3/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java
----------------------------------------------------------------------
diff --git a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java
index b7faa92..b5ddf3c 100644
--- a/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java
+++ b/platforms/commands/commands-core/src/main/java/org/apache/camel/commands/AbstractCamelController.java
@@ -95,6 +95,7 @@ public abstract class AbstractCamelController implements CamelController {
String json = catalog.componentJSonSchema(name);
List<Map<String, String>> rows = JsonSchemaHelper.parseJsonSchema("component", json, false);
+ String title = null;
String description = null;
String label = null;
// the status can be:
@@ -107,7 +108,9 @@ public abstract class AbstractCamelController implements CamelController {
String artifactId = null;
String version = null;
for (Map<String, String> row : rows) {
- if (row.containsKey("description")) {
+ if (row.containsKey("title")) {
+ title = row.get("title");
+ } else if (row.containsKey("description")) {
description = row.get("description");
} else if (row.containsKey("label")) {
label = row.get("label");
@@ -125,6 +128,9 @@ public abstract class AbstractCamelController implements CamelController {
Map<String, String> row = new HashMap<String, String>();
row.put("name", name);
row.put("status", status);
+ if (title != null) {
+ row.put("title", title);
+ }
if (description != null) {
row.put("description", description);
}
http://git-wip-us.apache.org/repos/asf/camel/blob/ce73f2b3/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
index d76bd67..cfa5305 100644
--- 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
@@ -27,6 +27,7 @@ import java.util.Map;
public class CatalogComponentListCommand extends AbstractCamelCommand {
private static final String NAME_COLUMN_LABEL = "Name";
+ private static final String TITLE_COLUMN_LABEL = "Title";
private static final String LABEL_COLUMN_LABEL = "Label";
private static final String MAVEN_COLUMN_LABEL = "Maven Coordinate";
private static final String DESCRIPTION_COLUMN_LABEL = "Description";
@@ -62,30 +63,32 @@ public class CatalogComponentListCommand extends AbstractCamelCommand {
final String rowFormat = buildFormatString(columnWidths, false);
if (verbose) {
- out.println(String.format(headerFormat, NAME_COLUMN_LABEL, LABEL_COLUMN_LABEL, MAVEN_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL));
- out.println(String.format(headerFormat, "----", "-----", "----------------", "-----------"));
+ out.println(String.format(headerFormat, NAME_COLUMN_LABEL, TITLE_COLUMN_LABEL, LABEL_COLUMN_LABEL, MAVEN_COLUMN_LABEL, DESCRIPTION_COLUMN_LABEL));
+ out.println(String.format(headerFormat, "----", "-----", "-----", "----------------", "-----------"));
} else {
- out.println(String.format(headerFormat, NAME_COLUMN_LABEL, LABEL_COLUMN_LABEL, MAVEN_COLUMN_LABEL));
- out.println(String.format(headerFormat, "----", "-----", "----------------"));
+ out.println(String.format(headerFormat, NAME_COLUMN_LABEL, TITLE_COLUMN_LABEL, LABEL_COLUMN_LABEL));
+ out.println(String.format(headerFormat, "----", "-----", "-----"));
}
for (final Map<String, String> component : components) {
if (verbose) {
String name = safeNull(component.get("name"));
+ String title = safeNull(component.get("title"));
String label = safeNull(component.get("label"));
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, label, maven, description));
+ out.println(String.format(rowFormat, name, title, label, maven, description));
} else {
String name = safeNull(component.get("name"));
+ String title = safeNull(component.get("title"));
String label = safeNull(component.get("label"));
String maven = "";
if (component.containsKey("groupId") && component.containsKey("artifactId") && component.containsKey("version")) {
maven = component.get("groupId") + "/" + component.get("artifactId") + "/" + component.get("version");
}
- out.println(String.format(rowFormat, name, label, maven));
+ out.println(String.format(rowFormat, name, title, label, maven));
}
}
@@ -98,6 +101,7 @@ public class CatalogComponentListCommand extends AbstractCamelCommand {
} else {
// some of the options is optional so we need to start from 1
int maxNameLen = NAME_COLUMN_LABEL.length();
+ int maxTitleLen = TITLE_COLUMN_LABEL.length();
int maxLabelLen = LABEL_COLUMN_LABEL.length();
int maxMavenLen = MAVEN_COLUMN_LABEL.length();
int maxDescriptionLen = DESCRIPTION_COLUMN_LABEL.length();
@@ -109,6 +113,10 @@ public class CatalogComponentListCommand extends AbstractCamelCommand {
if (name != null) {
maxNameLen = Math.max(maxNameLen, name.length());
}
+ String title = component.get("title");
+ if (title != null) {
+ maxTitleLen = Math.max(maxTitleLen, title.length());
+ }
String label = component.get("label");
if (label != null) {
maxLabelLen = Math.max(maxLabelLen, label.length());
@@ -125,6 +133,7 @@ public class CatalogComponentListCommand extends AbstractCamelCommand {
final Map<String, Integer> retval = new Hashtable<String, Integer>(4);
retval.put(NAME_COLUMN_LABEL, maxNameLen);
+ retval.put(TITLE_COLUMN_LABEL, maxTitleLen);
retval.put(LABEL_COLUMN_LABEL, maxLabelLen);
retval.put(MAVEN_COLUMN_LABEL, maxMavenLen);
retval.put(DESCRIPTION_COLUMN_LABEL, maxDescriptionLen);
@@ -149,32 +158,38 @@ public class CatalogComponentListCommand extends AbstractCamelCommand {
if (verbose) {
int nameLen = Math.min(columnWidths.get(NAME_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
+ int titleLen = Math.min(columnWidths.get(TITLE_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int labelLen = Math.min(columnWidths.get(LABEL_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);
+ titleLen = Math.max(MIN_COLUMN_WIDTH, titleLen);
labelLen = Math.max(MIN_COLUMN_WIDTH, labelLen);
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(titleLen).append('.').append(titleLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(labelLen).append('.').append(labelLen).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 titleLen = Math.min(columnWidths.get(TITLE_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int labelLen = Math.min(columnWidths.get(LABEL_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
int mavenLen = Math.min(columnWidths.get(MAVEN_COLUMN_LABEL) + columnWidthIncrement, getMaxColumnWidth());
nameLen = Math.max(MIN_COLUMN_WIDTH, nameLen);
+ titleLen = Math.max(MIN_COLUMN_WIDTH, titleLen);
labelLen = Math.max(MIN_COLUMN_WIDTH, labelLen);
mavenLen = Math.max(MIN_COLUMN_WIDTH, mavenLen);
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(titleLen).append('.').append(titleLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(labelLen).append('.').append(labelLen).append('s').append(fieldPostamble).append(' ');
retval.append(fieldPreamble).append("%-").append(mavenLen).append('.').append(mavenLen).append('s').append(fieldPostamble).append(' ');
return retval.toString();
http://git-wip-us.apache.org/repos/asf/camel/blob/ce73f2b3/platforms/commands/commands-jolokia/src/main/java/org/apache/camel/commands/jolokia/DefaultJolokiaCamelController.java
----------------------------------------------------------------------
diff --git a/platforms/commands/commands-jolokia/src/main/java/org/apache/camel/commands/jolokia/DefaultJolokiaCamelController.java b/platforms/commands/commands-jolokia/src/main/java/org/apache/camel/commands/jolokia/DefaultJolokiaCamelController.java
index 5979de8..8f8ffae 100644
--- a/platforms/commands/commands-jolokia/src/main/java/org/apache/camel/commands/jolokia/DefaultJolokiaCamelController.java
+++ b/platforms/commands/commands-jolokia/src/main/java/org/apache/camel/commands/jolokia/DefaultJolokiaCamelController.java
@@ -642,6 +642,7 @@ public class DefaultJolokiaCamelController extends AbstractCamelController imple
Map<String, String> row = new LinkedHashMap<String, String>();
row.put("artifactId", asString(component.get("artifactId")));
+ row.put("title", asString(component.get("title")));
row.put("description", asString(component.get("description")));
row.put("groupId", asString(component.get("groupId")));
row.put("label", asString(component.get("label")));