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/05/16 09:51:09 UTC
[18/50] [abbrv] 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/b22e6051
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/b22e6051
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/b22e6051
Branch: refs/heads/kube-lb
Commit: b22e60514e7fcac2cfbdb255428c5926645aac0c
Parents: 24698f9
Author: Claus Ibsen <da...@apache.org>
Authored: Sat May 14 10:34:55 2016 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Mon May 16 09:59:33 2016 +0200
----------------------------------------------------------------------
.../src/main/docs/websocket.adoc | 24 +++++++++-------
.../component/websocket/WebsocketEndpoint.java | 22 +++++++-------
.../camel/component/xmpp/XmppEndpoint.java | 30 ++++++++++----------
3 files changed, 39 insertions(+), 37 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/b22e6051/components/camel-websocket/src/main/docs/websocket.adoc
----------------------------------------------------------------------
diff --git a/components/camel-websocket/src/main/docs/websocket.adoc b/components/camel-websocket/src/main/docs/websocket.adoc
index 9343521..21068b8 100644
--- a/components/camel-websocket/src/main/docs/websocket.adoc
+++ b/components/camel-websocket/src/main/docs/websocket.adoc
@@ -68,6 +68,7 @@ The Jetty Websocket component supports 12 options which are listed below.
+
// endpoint options: START
The Jetty Websocket component supports 20 endpoint options which are listed below:
@@ -78,28 +79,29 @@ The Jetty Websocket component supports 20 endpoint options which are listed belo
| host | common | 0.0.0.0 | String | The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default.
| port | common | 9292 | Integer | The port number. The default value is 9292. Setting this option on the component will use the component configured value as default.
| resourceUri | common | | String | *Required* Name of the websocket channel to use
-| allowedOrigins | common | | String | The CORS allowed origins. Use to allow all.
-| bufferSize | common | 8192 | Integer | Set the buffer size of the websocketServlet which is also the max frame byte size (default 8192)
-| crossOriginFilterOn | common | false | boolean | Whether to enable CORS
-| enableJmx | common | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
-| filterPath | common | | String | Context path for filtering CORS
| maxBinaryMessageSize | common | -1 | Integer | Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited)
-| maxIdleTime | common | 300000 | Integer | Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000)
-| maxTextMessageSize | common | | Integer | Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.
-| minVersion | common | 13 | Integer | Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version)
-| sessionSupport | common | false | boolean | Whether to enable session support which enables HttpSession for each http request.
-| sslContextParameters | common | | SSLContextParameters | To configure security using SSLContextParameters
-| staticResources | common | | String | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use.
| 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.
+| sessionSupport | consumer | false | boolean | Whether to enable session support which enables HttpSession for each http request.
+| staticResources | consumer | | String | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use.
| 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.
| sendToAll | producer | | Boolean | To send to all websocket subscribers. Can be used to configure on endpoint level instead of having to use the WebsocketConstants.SEND_TO_ALL header on the message.
+| bufferSize | advanced | 8192 | Integer | Set the buffer size of the websocketServlet which is also the max frame byte size (default 8192)
| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| maxIdleTime | advanced | 300000 | Integer | Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000)
+| maxTextMessageSize | advanced | | Integer | Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.
+| minVersion | advanced | 13 | Integer | Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version)
| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| allowedOrigins | cors | | String | The CORS allowed origins. Use to allow all.
+| crossOriginFilterOn | cors | false | boolean | Whether to enable CORS
+| filterPath | cors | | String | Context path for filtering CORS
+| enableJmx | monitoring | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
+| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters
|=======================================================================
{% endraw %}
// endpoint options: END
+
�
[[Websocket-MessageHeaders]]
http://git-wip-us.apache.org/repos/asf/camel/blob/b22e6051/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java b/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java
index a71eabc..11e1eba 100644
--- a/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java
+++ b/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java
@@ -54,29 +54,29 @@ public class WebsocketEndpoint extends DefaultEndpoint {
@UriParam(label = "producer")
private Boolean sendToAll;
- @UriParam
+ @UriParam(label = "monitoring")
private boolean enableJmx;
- @UriParam
+ @UriParam(label = "consumer")
private boolean sessionSupport;
- @UriParam
+ @UriParam(label = "cors")
private boolean crossOriginFilterOn;
- @UriParam
+ @UriParam(label = "security")
private SSLContextParameters sslContextParameters;
- @UriParam
+ @UriParam(label = "cors")
private String allowedOrigins;
- @UriParam
+ @UriParam(label = "cors")
private String filterPath;
- @UriParam
+ @UriParam(label = "consumer")
private String staticResources;
- @UriParam(defaultValue = "8192")
+ @UriParam(label = "advanced", defaultValue = "8192")
private Integer bufferSize;
- @UriParam(defaultValue = "300000")
+ @UriParam(label = "advanced", defaultValue = "300000")
private Integer maxIdleTime;
- @UriParam
+ @UriParam(label = "advanced")
private Integer maxTextMessageSize;
@UriParam(defaultValue = "-1")
private Integer maxBinaryMessageSize;
- @UriParam(defaultValue = "13")
+ @UriParam(label = "advanced", defaultValue = "13")
private Integer minVersion;
public WebsocketEndpoint(WebsocketComponent component, String uri, String resourceUri, Map<String, Object> parameters) {
http://git-wip-us.apache.org/repos/asf/camel/blob/b22e6051/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java b/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java
index 3146940..6fa7093 100644
--- a/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java
+++ b/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java
@@ -61,35 +61,35 @@ public class XmppEndpoint extends DefaultEndpoint implements HeaderFilterStrateg
private String host;
@UriPath @Metadata(required = "true")
private int port;
- @UriPath
+ @UriPath(label = "common")
private String participant;
- @UriParam
+ @UriParam(label = "security")
private String user;
- @UriParam
+ @UriParam(label = "security")
private String password;
- @UriParam(defaultValue = "Camel")
+ @UriParam(label = "common,advanced", defaultValue = "Camel")
private String resource = "Camel";
- @UriParam(defaultValue = "true")
+ @UriParam(label = "common", defaultValue = "true")
private boolean login = true;
- @UriParam
+ @UriParam(label = "common,advanced")
private boolean createAccount;
- @UriParam
+ @UriParam(label = "common")
private String room;
- @UriParam
+ @UriParam(label = "common")
private String nickname;
- @UriParam
+ @UriParam(label = "common")
private String serviceName;
- @UriParam
+ @UriParam(label = "common")
private boolean pubsub;
- @UriParam
+ @UriParam(label = "consumer")
private boolean doc;
- @UriParam(defaultValue = "true")
+ @UriParam(label = "common", defaultValue = "true")
private boolean testConnectionOnStartup = true;
- @UriParam(defaultValue = "10")
+ @UriParam(label = "consumer", defaultValue = "10")
private int connectionPollDelay = 10;
- @UriParam
+ @UriParam(label = "filter")
private HeaderFilterStrategy headerFilterStrategy = new DefaultHeaderFilterStrategy();
- @UriParam
+ @UriParam(label = "advanced")
private ConnectionConfiguration connectionConfig;
public XmppEndpoint() {