camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject camel git commit: Component docs
Date Wed, 08 Mar 2017 09:45:44 GMT
Repository: camel
Updated Branches:
  refs/heads/master 8c43ee7e1 -> a6f109538


Component docs


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/a6f10953
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/a6f10953
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/a6f10953

Branch: refs/heads/master
Commit: a6f109538ccf230cce1f316b9e7a6b49f4819911
Parents: 8c43ee7
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Wed Mar 8 10:45:33 2017 +0100
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Wed Mar 8 10:45:33 2017 +0100

----------------------------------------------------------------------
 .../src/main/docs/box-component.adoc            | 77 +++++---------------
 .../maven/packaging/PrepareCatalogMojo.java     | 22 ++++--
 2 files changed, 36 insertions(+), 63 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/a6f10953/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
index 2a1102c..fb93bfd 100644
--- a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
+++ b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
@@ -123,45 +123,6 @@ Endpoint prefix can be one of:
 * tasks
 * users
 
-### BoxComponent
-
-The Box Component can be configured with the options below. These
-options can be provided using the component's bean
-property *`configuration`* of
-type *`org.apache.camel.component.box.BoxConfiguration`*. These options
-can also be specified in the endpoint URI. 
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================  custom access token
cachecom.box.sdk
-|Option |Type |Description
-
-|accessTokenCache |com.box.sdk.IAccessTokenCache |A custom access token cache. For production
applications it is recommended to use a distributed cache like Memcached or Redis, and to
implement this interface to store and retrieve access tokens appropriately for your environment;
when not set an internal access token cache is used; ONLY used when using App Enterprise or
User authentication.
-
-|clientId |String |Box application client ID
-
-|clientSecret |String |Box application client secret
-
-|encryptionAlgorithm |com.box.sdk.EncryptionAlgorithm |Algorithm used by OAuth 2.0 with JWT;
MUST be provided when using App Enterprise and User authentication
-
-|enterpriseId |String |The enterprise ID to use for requesting access token; MUST be provided
when using App Enterprise authentication
-
-|httpParams |java.util.Map |Custom HTTP params for settings like proxy host
-
-|maxCacheEntries |Integer |The maximum number of access tokens in cache; ONLY used when internal
access token cache is used
-
-|privateKeyFile |String |Path to file containing private key used to generate signature in
OAuth 2.0 with JWT; MUST be provided when using App Enterprise and User authentication
-
-|privateKeyPassword |String |Password for private key; only used for App Enterprise and User
authentication; MUST be provided when using App Enterprise and User authentication
-
-|publicKeyId |String |The ID of public key used to generate signature in OAuth 2.0 with JWT;
MUST be provided when using App Enterprise and User authentication 
-
-|userId |String |The user ID to use for an App user Authentication; MUST be provided when
using App User authentication
-
-|userName |String |Box user name for a Managed user; MUST be provided when using Standard
Authentication
-
-|userPassword |String |Box user password, MUST be provided when using Standard Authentication
and if authSecureStorage is not set, or
-returns null on first call
-|=======================================================================
 
 ### Producer Endpoints:
 
@@ -203,7 +164,7 @@ follows:
     box://collaborations/endpoint?[options]
 -------------------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 
@@ -226,7 +187,7 @@ follows:
 URI Options for _collaborations_
 
 
-[width="100%",cols="10%,90%",options="header",]
+[width="100%",cols="10%,90%",options="header"]
 |=======================================================================
 |Name |Type
 
@@ -255,7 +216,7 @@ follows:
     box://comments/endpoint?[options]
 -------------------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 
@@ -276,7 +237,7 @@ follows:
 URI Options for _collaborations_
 
 
-[width="100%",cols="10%,90%",options="header",]
+[width="100%",cols="10%,90%",options="header"]
 |=======================================================================
 |Name |Type
 
@@ -299,7 +260,7 @@ The following endpoints can be invoked with the prefix *`events`* as
follows:
   box://event-logs/endpoint?[options]
 ---------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 
@@ -309,7 +270,7 @@ The following endpoints can be invoked with the prefix *`events`* as
follows:
 [[Box-URIOptionsforevent-logs]]
 URI Options for _event-logs_
 
-[width="100%",cols="10%,90%",options="header",]
+[width="100%",cols="10%,90%",options="header"]
 |=======================================================================
 |Name |Type
 
@@ -334,7 +295,7 @@ prefix *`files`* as follows.
    box://files/endpoint?[options]
 ----------------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 
@@ -384,7 +345,7 @@ prefix *`files`* as follows.
 [[Box-URIOptionsforfiles]]
 URI Options for _files_
 
-[width="100%",cols="10%,90%",options="header",]
+[width="100%",cols="10%,90%",options="header"]
 |=======================================================================
 |Name |Type
 
@@ -455,7 +416,7 @@ The following endpoints can be invoked with the prefix
     box://folders/endpoint?[options]
 -------------------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 
@@ -485,7 +446,7 @@ The following endpoints can be invoked with the prefix
 [[Box-URIOptionsforfolders]]
 URI Options for _folders_
 
-[width="100%",cols="10%,90%",options="header",]
+[width="100%",cols="10%,90%",options="header"]
 |=======================================================================
 |Name |Type
 
@@ -530,7 +491,7 @@ follows:
     box://groups/endpoint?[options]
 -----------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 
@@ -558,7 +519,7 @@ follows:
 [[Box-URIOptionsforgroups]]
 URI Options for _groups_
 
-[width="100%",cols="10%,90%",options="header",]
+[width="100%",cols="10%,90%",options="header"]
 |=======================================================================
 |Name |Type
 
@@ -588,7 +549,7 @@ follows:
     box://search/endpoint?[options]
 -----------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 
@@ -598,7 +559,7 @@ follows:
 [[Box-URIOptionsforsearch]]
 URI Options for _search_
 
-[width="100%",cols="10%,90%",options="header",]
+[width="100%",cols="10%,90%",options="header"]
 |=======================================================================
 |Name |Type
 
@@ -619,7 +580,7 @@ follows:
     box://tasks/endpoint?[options]
 ----------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 
@@ -645,7 +606,7 @@ follows:
 [[Box-URIOptionsfortasks]]
 URI Options for _tasks_
 
-[width="100%",cols="10%,90%",options="header",]
+[width="100%",cols="10%,90%",options="header"]
 |=======================================================================
 |Name |Type
 
@@ -678,7 +639,7 @@ follows:
     box://users/endpoint?[options]
 ----------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 
@@ -704,7 +665,7 @@ follows:
 [[Box-URIOptionsforusers]]
 URI Options for _users_
 
-[width="100%",cols="10%,90%",options="header",]
+[width="100%",cols="10%,90%",options="header"]
 |=======================================================================
 |Name |Type
 
@@ -741,7 +702,7 @@ shown in the example next.
     box://events/endpoint?[options]
 ----------------------------------------
 
-[width="100%",cols="10%,10%,10%,70%",options="header",]
+[width="100%",cols="10%,10%,10%,70%",options="header"]
 |=======================================================================
 |Endpoint |Shorthand Alias |Options |Result Body Type
 

http://git-wip-us.apache.org/repos/asf/camel/blob/a6f10953/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
----------------------------------------------------------------------
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
index 3c28fe7..67fca07 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
+++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
@@ -57,11 +57,12 @@ public class PrepareCatalogMojo extends AbstractMojo {
 
     public static final int BUFFER_SIZE = 128 * 1024;
 
-    private static final String[] EXCLUDE_DOC_FILES = {"camel-core-osgi", "camel-core-xml",
"camel-hystrix",
-        "camel-http-common", "camel-jetty", "camel-jetty-common", "camel-jetty8", 
-        "camel-box", "camel-linkedin", "camel-olingo2", "camel-ribbon", "camel-salesforce",
"camel-spring-boot-starter",
-        "camel-spring-dm", "camel-test-karaf", "camel-test-spring", "camel-testng", "camel-test-spring3",

-        "camel-test-spring40", "camel-zipkin-starter"};
+    private static final String[] EXCLUDE_DOC_FILES = {
+        "camel-core-osgi", "camel-core-xml",
+        "camel-spring-dm",
+        "camel-http-common", "camel-jetty", "camel-jetty-common", "camel-jetty8",
+        "camel-test-karaf", "camel-test-spring", "camel-testng", "camel-test-spring3", "camel-test-spring40",
"camel-zipkin-starter"
+    };
 
     private static final Pattern LABEL_PATTERN = Pattern.compile("\\\"label\\\":\\s\\\"([\\w,]+)\\\"");
 
@@ -965,6 +966,17 @@ public class PrepareCatalogMojo extends AbstractMojo {
                     if (dir.isDirectory() && !"target".equals(dir.getName()) &&
!dir.getName().startsWith(".") && !excludeDocumentDir(dir.getName())) {
                         File target = new File(dir, "src/main/docs");
 
+                        // special for these as they are in sub dir
+                        if ("camel-salesforce".equals(dir.getName())) {
+                            target = new File(dir, "camel-salesforce-component/src/main/docs");
+                        } else if ("camel-linkedin".equals(dir.getName())) {
+                            target = new File(dir, "camel-linkedin-component/src/main/docs");
+                        } else if ("camel-olingo2".equals(dir.getName())) {
+                            target = new File(dir, "camel-olingo2-component/src/main/docs");
+                        } else if ("camel-box".equals(dir.getName())) {
+                            target = new File(dir, "camel-box-component/src/main/docs");
+                        }
+
                         int before = adocFiles.size();
                         findAsciiDocFilesRecursive(target, adocFiles, new CamelAsciiDocFileFilter());
                         int after = adocFiles.size();


Mime
View raw message