; Thu, 13 Aug 2015 11:19:35 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r961710 [6/6] - in /websites/production/camel/content: book-component-appendix.html book-in-one-page.html cache/main.pageCache camel-2160-release.html http.html http4.html jetty.html Date: Thu, 13 Aug 2015 11:19:34 -0000 To: commits@camel.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20150813111935.2E299AC1B56@hades.apache.org> Modified: websites/production/camel/content/jetty.html ============================================================================== --- websites/production/camel/content/jetty.html (original) +++ websites/production/camel/content/jetty.html Thu Aug 13 11:19:33 2015 @@ -97,7 +97,7 @@

URI format

You can append query options to the URI in the following format, ?option=value&option=value&...

Options

matchOnUriPrefix

Name	Default Value	Description
`sessionSupport`	`false`	Specifies whether to enable the session manager on the server side of Jetty.
`httpClient.XXX`	`null`	Configuration of Jetty's HttpClient. For example, setting `httpClient.idleTimeout=30000` sets the idle timeout to 30 seconds. And `httpClient.timeout=30000` sets the request timeout to 30 seconds, in case you want to timeout sooner if you have long running request/response calls.
`httpClient`	`null`	To use a shared `org.eclipse.jetty.client.HttpClient` for all producers created by this endpoint. This option should only be used in special circumstances.
`httpClientMinThreads`	`null`	Camel 2.11: Producer only: To set a value for minimum number of threads in `HttpClient` thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to min 8 threads used in Jettys thread pool.
`httpClientMaxThreads`	`null`	Camel 2.11: Producer only: To set a value for maximum number of threads in `HttpClient` thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to max 254 threads used in Jettys thread pool.
`httpBindingRef`	`null`	Reference to an `org.apache.camel.component.http.HttpBinding` in the Registry. `HttpBinding` can be used to customize how a response should be written for the consumer.
`jettyHttpBindingRef`	`null`	Camel 2.6.0+: Reference to an `org.apache.camel.component.jetty.JettyHttpBinding` in the Registry. `JettyHttpBinding` can be used to customize how a response should be written for the producer.
`false`	Whether or not the `CamelServlet` should try to find a target consumer by matching the URI prefix if no exact match is found. See here How do I let Jetty match wildcards.
`handlers`	`null`	Specifies a comma-delimited set of `org.mortbay.jetty.Handler` instances in your Registry (such as your Spring `ApplicationContext`). These handlers are added to the Jetty servlet context (for example, to add security). Important : You can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers.
`chunked`	`true`	Camel 2.2: If this option is false Jetty servlet will disable the HTTP streaming and set the content-length header on the response
`enableJmx`	`false`	Camel 2.3: If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support< /a> for more details.
`disableStreamCache`	`false`	Camel 2.3: Determines whether or not the raw input stream from Jetty is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Jetty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to `true` when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is `false` to support reading the stream multiple ti mes. If you use Jetty to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times.
`throwExceptionOnFailure`	`true`	Option to disable throwing the `HttpOperationFailedException` in case of failed responses from the remote server. This allows you to get all responses regardles of the HTTP status code.
`transferException`	`false`	Camel 2.6: If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a `application/x-java-serialized-object` content type. On the producer side the exception will be deserialized and thrown as is, instead of the `HttpOperationFailedException`. The caused exception is required to be serialized.
`bridgeEndpoint`	`false`	Camel 2.1: If the option is true , HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. Camel 2.3: If the option is true, HttpProducer and CamelServlet w ill skip the gzip processing if the content-encoding is "gzip". Also consider setting disableStreamCache to true to optimize when bridging.
`enableMultipartFilter`	`true`	Camel 2.5: Whether Jetty `org.eclipse.jetty.servlets.MultiPartFilter` is enabled or not. You should set this value to `false` when bridging endpoints, to ensure multipart requests is proxied/bridged as well.
`multipartFilterRef`	`null`	Camel 2.6: Allows using a custom multipart filter. Note: setting `multipartFilterRef` forces the value of `enableMultipartFilter` to `true`.
`filtersRef`	`null`	Camel 2.9: Allows using a custom filters which is putted into a list and can be find in the Registry
`continuationTimeout`	`null`	Camel 2.6: Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of `<= 0` to never expire. If a timeout occurs then the request will be expired and Je tty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine.
`useContinuation`	`true`	Camel 2.6: Whether or not to use Jetty continuations for the Jetty Server.
`sslContextParametersRef`	`null`	Camel 2.8: Reference to a `org.apache.camel.util.jsse. SSLContextParameters` in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility.
`traceEnabled`	`false`	Specifies whether to enable HTTP TRACE for this Jetty consumer. By default TRACE is turned off.
`headerFilterStrategy`	`null`	Camel 2.11: Reference to a instance of `org.apache.camel.spi.HeaderFilterStrategy` in the Registry. It will be used to apply the custom headerFilterStrategy on the new create HttpJettyEndpoint.
`httpMethodRestrict`	`null`	Camel 2.11: Consumer only: Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. From Camel 2.15 onwards multiple methods can be specified separated by comma.
`urlRewrite`	`null`	Camel 2.11: Producer only Refers to a custom `org.apache.camel.component.http.UrlRewrite` which allows you to rewrite urls when you bridge/proxy endpoints. See more details at UrlRewrite and How to use Camel as a HTTP proxy between a client and server.
`responseBufferSize`	`null`	Camel 2.12: To use a custom buffer size on the `javax.servlet.ServletResponse`.
`proxyHost`	`null`	Camel 2.11: Producer only The http proxy Host url which will be used by Jetty client.< /p>
`proxyPort`	`null`	Camel 2.11: Producer only The http proxy port which will be used by Jetty client.
`sendServerVersion`	`true`	Camel 2.13: if the option is true, jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected.
`sendDateHeader`	`false`	Camel 2.14: if the option is true, jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected.
`enableCORS`	`false`	Camel 2.15: if the option is true, Jetty server will setup the CrossOriginFilter which supports the CORS out of box.

Message Headers

Camel uses the same message headers as the HTTP component.
From Camel 2.2, it also uses (Exchange.HTTP_CHUNKED,CamelHttpChunked) header to turn on or turn off the chuched encoding on the camel-jetty consumer.

Camel also populates all request.parameter and request.headers. For example, given a client request with the URL, http://myserver/myserver?orderid=123, the exchange will contain a header named orderid with the value 123.

Starting with Camel 2.2.0, you can get the request.parameter from the message header not only from Get Method, but also other HTTP method.

Usage

The Jetty component supports both consumer and producer endpoints. Another option for producing to other HTTP endpoints, is to use the HTTP Component

Component Options

The JettyHttpComponent provides the following options:

Name	Default Value	Description
`enableJmx`	`false`	Camel 2.3: If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
`sslKeyPassword`	`null`	Consumer only: The password for the keystore when using SSL.
`sslPassword`	`null`	Consumer only: The password when using SSL.
`sslKeystore`	`null`	Consumer only: The path to the keystore.
`minThreads`	`null`	Camel 2.5 Consumer only: To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured.
`maxThreads`	`null`	Camel 2.5 Consumer only: To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured.
`threadPool`	`null`	Camel 2.5 Consumer only: To use a custom thread pool f or the server. This option should only be used in special circumstances.
`sslSocketConnectors`	`null`	Camel 2.3 Consumer only: A map which contains per port number specific SSL connectors. See section SSL support for more details.
`socketConnectors`	`null`	Camel 2.5 Consumer only: A map which contains per port number specific HTTP connectors. Uses the same principle as `sslSocketConnectors` and therefore see section SSL support for more details.
`sslSocketConnectorProperties`	`null`	Camel 2.5 Consumer only. A map which contains general SSL connector properties. See section SSL support for more details.
`socketConnectorProperties`	`null`	Camel 2.5 Consumer only. A map which contains general HTTP connector properties. Uses the same principle as `sslSocketConnectorProperties` and therefore see section SSL support for more details.
`httpClient`	`null`	Deprecated: Producer only: To use a custom `HttpClient` with the jetty producer. This option is removed from Camel 2.11 onwards, instead you can set the option on the endpoint instead.
`httpClientMinThreads`	`null`	Producer only: To set a value for minimum number of threads in `HttpClient` thread pool. Notice that both a min and max size must be configured.
`httpClientMaxThreads`	`null`	Producer only: To set a value for maximum number of threads in `HttpClient` thread pool. Notice that both a min and max size must be configured.
`httpClientThreadPool`	`null`	Deprecated: Producer only: To use a custom thread pool for the client. This option is removed from Camel 2.11 onwards.
`sslContextParameters`	`null`	Camel 2.8: To configure a custom SSL/TLS configuration options at the component level. See Usi ng the JSSE Configuration Utility for more details.
`requestBufferSize`	`null`	Camel 2.11.2: Allows to configure a custom value of the request buffer size on the Jetty connectors.
`requestHeaderSize`	`null`	Camel 2.11.2: Allows to configure a custom value of the request header size on the Jetty connectors.
`responseBufferSize`	`null`	Camel 2.11.2: Allows to configure a custom value of the response buffer size on the Jetty connectors.
`responseHeaderSize`	`null`	Camel 2.11.2: Allows to configure a custom value of the response header size on the Jetty connectors.
`proxyHost`	`null`	Camel 2.12.2/2.11.3 To use a http proxy.
`proxyPort`	`null`	Camel 2.12.2/2.11.3: To use a http proxy.
`errorHandler`	`null`	Camel 2.15: This option is used to set the ErrorHandler that Jetty server uses.

Producer Example

The following is a basic example of how to send an HTTP request to an existing HTTP endpoint.

in Java DSL

You can append query options to the URI in the following format, ?option=value&option=value&...

Options

matchOnUriPrefix

Name	Default Value	Description
`sessionSupport`	`false`	Specifies whether to enable the session manager on the server side of Jetty.
`httpClient.XXX`	`null`	Configuration of Jetty's HttpClient. For example, setting `httpClient.idleTimeout=30000` sets the idle timeout to 30 seconds. And `httpClient.timeout=30000` sets the request timeout to 30 seconds, in case you want to timeout sooner if you have long running request/response calls.
`httpClient`	`null`	To use a shared `org.eclipse.jetty.client.HttpClient` for all producers created by this endpoint. This option should only be used in special circumstances.
`httpClientMinThreads`	`null`	Camel 2.11: Producer only: To set a value for minimum number of threads in `HttpClient` thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to min 8 threads used in Jettys thread pool.
`httpClientMaxThreads`	`null`	Camel 2.11: Producer only: To set a value for maximum number of threads in `HttpClient` thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to max 254 threads used in Jettys thread pool.
`httpBindingRef`	`null`	Reference to an `org.apache.camel.component.http.HttpBinding` in the Registry. `HttpBinding` can be used to customize how a response should be written for the consumer.
`jettyHttpBindingRef`	`null`	Camel 2.6.0+: Reference to an `org.apache.camel.component.jetty.JettyHttpBinding` in the Registry. `JettyHttpBinding` can be used to customize how a response should be written for the producer.
`false`	Whether or not the `CamelServlet` should try to find a target consumer by matching the URI prefix if no exact match is found. See here How do I let Jetty match wildcards.
`handlers`	`null`	Specifies a comma-delimited set of `org.mortbay.jetty.Handler` instances in your Registry (such as your Spring `ApplicationContext`). These handlers are added to the Jetty servlet context (for example, to add security). Important : You can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers.
`chunked`	`true`	Camel 2.2: If this option is false Jetty servlet will disable the HTTP streaming and set the content-length header on the response
`enableJmx`	`false`	Camel 2.3: If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support< /a> for more details.
`disableStreamCache`	`false`	Camel 2.3: Determines whether or not the raw input stream from Jetty is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Jetty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to `true` when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is `false` to support reading the stream multiple ti mes. If you use Jetty to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times.
`throwExceptionOnFailure`	`true`	Option to disable throwing the `HttpOperationFailedException` in case of failed responses from the remote server. This allows you to get all responses regardles of the HTTP status code.
`transferException`	`false`	Camel 2.6: If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a `application/x-java-serialized-object` content type. On the producer side the exception will be deserialized and thrown as is, instead of the `HttpOperationFailedException`. The caused exception is required to be serialized.
`bridgeEndpoint`	`false`	Camel 2.1: If the option is true , HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. Camel 2.3: If the option is true, HttpProducer and CamelServlet w ill skip the gzip processing if the content-encoding is "gzip". Also consider setting disableStreamCache to true to optimize when bridging.
`enableMultipartFilter`	`true`	Camel 2.5: Whether Jetty `org.eclipse.jetty.servlets.MultiPartFilter` is enabled or not. You should set this value to `false` when bridging endpoints, to ensure multipart requests is proxied/bridged as well.
`multipartFilterRef`	`null`	Camel 2.6: Allows using a custom multipart filter. Note: setting `multipartFilterRef` forces the value of `enableMultipartFilter` to `true`.
`filtersRef`	`null`	Camel 2.9: Allows using a custom filters which is putted into a list and can be find in the Registry
`continuationTimeout`	`null`	Camel 2.6: Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of `<= 0` to never expire. If a timeout occurs then the request will be expired and Je tty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine.
`useContinuation`	`true`	Camel 2.6: Whether or not to use Jetty continuations for the Jetty Server.
`sslContextParametersRef`	`null`	Camel 2.8: Reference to a `org.apache.camel.util.jsse. SSLContextParameters` in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility.
`traceEnabled`	`false`	Specifies whether to enable HTTP TRACE for this Jetty consumer. By default TRACE is turned off.
`headerFilterStrategy`	`null`	Camel 2.11: Reference to a instance of `org.apache.camel.spi.HeaderFilterStrategy` in the Registry. It will be used to apply the custom headerFilterStrategy on the new create HttpJettyEndpoint.
`httpMethodRestrict`	`null`	Camel 2.11: Consumer only: Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. From Camel 2.15 onwards multiple methods can be specified separated by comma.
`urlRewrite`	`null`	Camel 2.11: Producer only Refers to a custom `org.apache.camel.component.http.UrlRewrite` which allows you to rewrite urls when you bridge/proxy endpoints. See more details at UrlRewrite and How to use Camel as a HTTP proxy between a client and server.
`responseBufferSize`	`null`	Camel 2.12: To use a custom buffer size on the `javax.servlet.ServletResponse`.
`proxyHost`	`null`	Camel 2.11: Producer only The http proxy Host url which will be used by Jetty client.< /p>
`proxyPort`	`null`	Camel 2.11: Producer only The http proxy port which will be used by Jetty client.
`sendServerVersion`	`true`	Camel 2.13: if the option is true, jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected.
`sendDateHeader`	`false`	Camel 2.14: if the option is true, jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected.
`enableCORS`	`false`	Camel 2.15: if the option is true, Jetty server will setup the CrossOriginFilter which supports the CORS out of box.
`okStatusCodeRange`	`200-299`	Camel 2.16: Producer only The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.

Message Headers

Starting with Camel 2.2.0, you can get the request.parameter from the message header not only from Get Method, but also other HTTP method.

Usage

The Jetty component supports both consumer and producer endpoints. Another option for producing to other HTTP endpoints, is to use the HTTP Component

Component Options

The JettyHttpComponent provides the following options:

Name	Default Value	Description
`enableJmx`	`false`	Camel 2.3: If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
`sslKeyPassword`	`null`	Consumer only: The password for the keystore when using SSL.
`sslPassword`	`null`	Consumer only: The password when using SSL.
`sslKeystore`	`null`	Consumer only: The path to the keystore.
`minThreads`	`null`	Camel 2.5 Consumer only: To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured.
`maxThreads`	`null`	Camel 2.5 Consumer only: To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured.
`threadPool`	`null`	Camel 2.5 Consumer only: To use a custom thread pool for the server. This option should only be used in special circumstances.
`sslSocketConnectors`	`null`	Camel 2.3 Consumer only: A map which contains per port number specific SSL connectors. See section SSL support for more details.
`socketConnectors`	`null`	Camel 2.5 Consumer only: A map which contains per port number specific HTTP connectors. Uses the same principle as `sslSocketConnectors` and therefore see section SSL support for more details.
`sslSocketConnectorProperties`	`null`	Camel 2.5 Consumer only. A map which contains general SSL connector properties. See section SSL support for more details.
`socketConnectorProperties`	`null`	Camel 2.5 Consumer only. A map which contains general HTTP connector properties. Uses the same principle as `sslSocketConnectorProperties` and therefore see section SSL support for more details.
`httpClient`	`null`	Deprecated: Producer only: To use a custom `HttpClient` with the jetty producer. This option is removed from Camel 2.11 onwards, instead you can set the option on the endpoint instead.
`httpClientMinThreads`	`null`	Producer only: To set a value for minimum number of threads in `HttpClient` thread pool. Notice that both a min and max size must be configured.
`httpClientMaxThreads`	`null`	Producer only: To set a value for maximum number of threads in `HttpClient` thread pool. Notice that both a min and max size must be configured.
`httpClientThreadPool`	`null`	Deprecated: Producer only: To use a custom thread pool for the client. This option is removed from Camel 2.11 onwards.
`sslContextParameters`	`null`	Camel 2.8: To configure a custom SSL/TLS configuration options at the component level. See Using the JSSE Configuration Utility for more details.
`requestBufferSize`	`null`	Camel 2.11.2: Allows to configure a custom value of the request buffer size on the Jetty connectors.
`requestHeaderSize`	`null`	Camel 2.11.2: Allows to configure a custom value of the request header size on the Jetty connectors.
`responseBufferSize`	`null`	Camel 2.11.2: Allows to configure a custom value of the response buffer size on the Jetty connectors.
`responseHeaderSize`	`null`	Camel 2.11.2: Allows to configure a custom value of the response header size on the Jetty connectors.
proxyHost	`null`	Camel 2.12.2/2.11.3 To use a http proxy.
`proxyPort`	`null`	Camel 2.12.2/2.11.3: To use a http proxy.
`errorHandler`	`null`	Camel 2.15: This option is used to set the ErrorHandler that Jetty server uses.

Producer Example

The following is a basic example of how to send an HTTP request to an existing HTTP endp oint.

in Java DSL

or in Spring XML

@@ -129,7 +129,7 @@ public class MyBookService implements Pr
     }
 }
 ]]>
-

The following sample shows a content-based route that routes all requests containing the URI parameter, one, to the endpoint, mock:one, and all others to mock:other.

So if a client sends the HTTP request, http://serverUri?one=hello, the Jetty component will copy the HTTP request parameter, one to the exchange's in.header. We can then use the simple language to route exchanges that contain this header to a specific endpoint and all others to another. If we used a language more powerful than Simple (such as EL or OGNL) we could also test for the parameter value and do routing based on the header value as well.

Session Support

The session support option, sessionSupport, can be used to enable a HttpSession object and access the session object while processing the exchange. For example, the following route enabl es sessions:

Session Support

We can then create an instance of our binding and register it in the Spring registry as follows:

And then we can reference this binding when we define the route: