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 2016/06/12 07:45:42 UTC
[3/3] camel git commit: Component docs
Component docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/1c73dfc5
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/1c73dfc5
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/1c73dfc5
Branch: refs/heads/master
Commit: 1c73dfc5e383a2d3182ea66c5e2ccfd056124458
Parents: 6b15b65
Author: Claus Ibsen <da...@apache.org>
Authored: Sun Jun 12 09:00:42 2016 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Sun Jun 12 09:45:13 2016 +0200
----------------------------------------------------------------------
components/camel-irc/src/main/docs/irc.adoc | 8 +++++---
.../camel/component/jms/JmsEndpointConfigurationTest.java | 4 ++--
components/camel-servicenow/src/main/docs/servicenow.adoc | 8 +++++---
components/camel-stomp/src/main/docs/stomp.adoc | 6 ++++--
4 files changed, 16 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/1c73dfc5/components/camel-irc/src/main/docs/irc.adoc
----------------------------------------------------------------------
diff --git a/components/camel-irc/src/main/docs/irc.adoc b/components/camel-irc/src/main/docs/irc.adoc
index 0de8ef3..7635d91 100644
--- a/components/camel-irc/src/main/docs/irc.adoc
+++ b/components/camel-irc/src/main/docs/irc.adoc
@@ -46,6 +46,7 @@ The IRC component has no options.
+
// endpoint options: START
The IRC component supports 26 endpoint options which are listed below:
@@ -58,11 +59,8 @@ The IRC component supports 26 endpoint options which are listed below:
| autoRejoin | common | true | boolean | Whether to auto re-join when being kicked
| namesOnJoin | common | false | boolean | Sends NAMES command to channel after joining it. link onReply has to be true in order to process the result which will have the header value irc.num = '353'.
| nickname | common | | String | The nickname used in chat.
-| nickPassword | common | | String | Your IRC server nickname password.
-| password | common | | String | The IRC server password.
| persistent | common | true | boolean | Use persistent messages.
| realname | common | | String | The IRC user's actual name.
-| username | common | | String | The IRC server user name.
| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
| colors | advanced | true | boolean | Whether or not the server supports color codes.
@@ -77,8 +75,11 @@ The IRC component supports 26 endpoint options which are listed below:
| onQuit | filter | true | boolean | Handle user quit events.
| onReply | filter | false | boolean | Whether or not to handle general responses to commands or informational messages.
| onTopic | filter | true | boolean | Handle topic change events.
+| nickPassword | security | | String | Your IRC server nickname password.
+| password | security | | String | The IRC server password.
| sslContextParameters | security | | SSLContextParameters | Used for configuring security using SSL. Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option.
| trustManager | security | | SSLTrustManager | The trust manager used to verify the SSL server's certificate.
+| username | security | | String | The IRC server user name.
|=======================================================================
{% endraw %}
// endpoint options: END
@@ -87,6 +88,7 @@ The IRC component supports 26 endpoint options which are listed below:
+
[[IRC-SSLSupport]]
SSL Support
^^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/1c73dfc5/components/camel-jms/src/test/java/org/apache/camel/component/jms/JmsEndpointConfigurationTest.java
----------------------------------------------------------------------
diff --git a/components/camel-jms/src/test/java/org/apache/camel/component/jms/JmsEndpointConfigurationTest.java b/components/camel-jms/src/test/java/org/apache/camel/component/jms/JmsEndpointConfigurationTest.java
index 2b74366..8274d45 100644
--- a/components/camel-jms/src/test/java/org/apache/camel/component/jms/JmsEndpointConfigurationTest.java
+++ b/components/camel-jms/src/test/java/org/apache/camel/component/jms/JmsEndpointConfigurationTest.java
@@ -95,14 +95,14 @@ public class JmsEndpointConfigurationTest extends CamelTestSupport {
resolveMandatoryEndpoint("jms:topic:Foo.Bar?username=James");
fail("Expect the exception here");
} catch (ResolveEndpointFailedException refe) {
- assertEquals("Failed to resolve endpoint: jms://topic:Foo.Bar?username=James due to: The JmsComponent's username or password is null", refe.getMessage());
+ // expected
}
try {
resolveMandatoryEndpoint("jms:topic:Foo.Bar?password=ABC");
fail("Expect the exception here");
} catch (ResolveEndpointFailedException refe) {
- assertEquals("Failed to resolve endpoint: jms://topic:Foo.Bar?password=ABC due to: The JmsComponent's username or password is null", refe.getMessage());
+ // expected
}
}
http://git-wip-us.apache.org/repos/asf/camel/blob/1c73dfc5/components/camel-servicenow/src/main/docs/servicenow.adoc
----------------------------------------------------------------------
diff --git a/components/camel-servicenow/src/main/docs/servicenow.adoc b/components/camel-servicenow/src/main/docs/servicenow.adoc
index 25d4839..4abe9ce 100644
--- a/components/camel-servicenow/src/main/docs/servicenow.adoc
+++ b/components/camel-servicenow/src/main/docs/servicenow.adoc
@@ -40,6 +40,7 @@ The ServiceNow component has no options.
+
// endpoint options: START
The ServiceNow component supports 17 endpoint options which are listed below:
@@ -52,23 +53,24 @@ The ServiceNow component supports 17 endpoint options which are listed below:
| excludeReferenceLink | producer | | Boolean | True to exclude Table API links for reference fields (default: false)
| inputDisplayValue | producer | | Boolean | True to set raw value of input fields (default: false)
| models | producer | | String | Defines the default model to use for a table
-| password | producer | | String | *Required* ServiceNow account password MUST be provided
| resource | producer | | String | The default resource can be overridden by header CamelServiceNowResource
| suppressAutoSysField | producer | | Boolean | True to suppress auto generation of system fields (default: false)
| table | producer | | String | The default table can be overridden by header CamelServiceNowTable
-| userName | producer | | String | *Required* ServiceNow user account name MUST be provided
-| apiUrl | advanced | | String | The ServiceNow REST API url
| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
| mapper | advanced | | ObjectMapper | Sets Jackson's ObjectMapper to use for request/reply
| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| apiUrl | security | | String | The ServiceNow REST API url
| oauthClientId | security | | String | OAuth2 ClientID
| oauthClientSecret | security | | String | OAuth2 ClientSecret
| oauthTokenUrl | security | | String | OAuth token Url
+| password | security | | String | *Required* ServiceNow account password MUST be provided
+| userName | security | | String | *Required* ServiceNow user account name MUST be provided
|=======================================================================
{% endraw %}
// endpoint options: END
+
[[ServiceNow-Headers]]
Headers
^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/1c73dfc5/components/camel-stomp/src/main/docs/stomp.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stomp/src/main/docs/stomp.adoc b/components/camel-stomp/src/main/docs/stomp.adoc
index 7278411..4d6bf26 100644
--- a/components/camel-stomp/src/main/docs/stomp.adoc
+++ b/components/camel-stomp/src/main/docs/stomp.adoc
@@ -58,6 +58,7 @@ The Stomp component supports 5 options which are listed below.
+
// endpoint options: START
The Stomp component supports 10 endpoint options which are listed below:
@@ -68,18 +69,19 @@ The Stomp component supports 10 endpoint options which are listed below:
| destination | common | | String | *Required* Name of the queue
| brokerURL | common | tcp://localhost:61613 | String | *Required* The URI of the Stomp broker to connect to
| host | common | | String | The virtual host name
-| login | common | | String | The username
-| passcode | common | | String | The password
| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| login | security | | String | The username
+| passcode | security | | String | The password
| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters
|=======================================================================
{% endraw %}
// endpoint options: END
+
You can append query options to the URI in the following format,
`?option=value&option=value&...`