You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by ja...@apache.org on 2014/03/10 15:57:01 UTC
svn commit: r1575957 -
/felix/site/trunk/content/documentation/subprojects/apache-felix-http-service.mdtext
Author: jawi
Date: Mon Mar 10 14:57:00 2014
New Revision: 1575957
URL: http://svn.apache.org/r1575957
Log:
Minor updates.
Modified:
felix/site/trunk/content/documentation/subprojects/apache-felix-http-service.mdtext
Modified: felix/site/trunk/content/documentation/subprojects/apache-felix-http-service.mdtext
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/subprojects/apache-felix-http-service.mdtext?rev=1575957&r1=1575956&r2=1575957&view=diff
==============================================================================
--- felix/site/trunk/content/documentation/subprojects/apache-felix-http-service.mdtext (original)
+++ felix/site/trunk/content/documentation/subprojects/apache-felix-http-service.mdtext Mon Mar 10 14:57:00 2014
@@ -270,6 +270,7 @@ HttpContext service properties:
`getResource` at all or be registered as service factories to ensure no access to foreign bundle
resources is not allowed through this backdoor.
+
## Using the Servlet Bridge
The servlet bridge is used if you want to use the HTTP service inside a WAR deployed on a 3rd part
@@ -284,6 +285,7 @@ applicaiton server. A little setup is ne
A detailed example can be found [here](http://svn.apache.org/repos/asf/felix/trunk/http/samples/bridge).
+
## Using the all-in-one bundle
The all-in-one bundle combines the the Jetty server, the whiteboard implementation, the servlet bridge and the
@@ -291,56 +293,58 @@ CometD functionality in a single, easy t
meaning that the Jetty, Whiteboard and CometD features are *disabled*. To *enable* these features, you need to supply
one or more configuration properties as described in the [next section](#configuration-properties).
+
## Configuration Properties
The service can both be configured using OSGi environment properties and using Configuration Admin. The service PID for this service is `"org.apache.felix.http"`. If you use both methods, Configuration Admin takes precedence. The following properties can be used (some legacy property names still exist but are not documented here on purpose):
| Property | Description |
|--|--|
-| `org.apache.felix.http.debug` | Flag to enable debugging for this service implementation. The default is `false` |
-| `org.apache.felix.http.host` | Host name or IP Address of the interface to listen on. The default is `null` causing Jetty to listen on all interfaces |
-| `org.osgi.service.http.port` | The port used for servlets and resources available via HTTP. The default is `80`. A negative port number has the same effect as setting `org.apache.felix.http.enable` to `false` |
-| `org.osgi.service.http.port.secure` | The port used for servlets and resources available via HTTPS. The default is `443`. A negative port number has the same effect as setting `org.apache.felix.https.enable` to `false` |
-| `org.apache.felix.http.context_path` | The Servlet Context Path to use for the Http Service. If this property is not configured it defaults to "/". This must be a valid path starting with a slash and not ending with a slash (unless it is the root context) |
-| `org.apache.felix.http.timeout` | Connection timeout in milliseconds. The default is 60000 (60 seconds) |
-| `org.apache.felix.http.session.timeout` | Allows for the specification of the Session life time as a number of minutes. This property serves the same purpose as the `session-timeout` element in a Web Application descriptor. The default is zero for no timeout at all |
-| `org.apache.felix.http.nio` | Flag to enable the use of NIO instead of traditional IO for HTTP. One consequence of using NIO with HTTP is that the bundle needs at least a Java 5 runtime. The default is `true` |
-| `org.apache.felix.https.nio` | Flag to enable the use of NIO instead of traditional IO for HTTPS. One consequence of using NIO with HTTPS is that the bundle needs at least a Java 5 runtime. If this property is not set the (default) value of the `org.apache.felix.http.nio` property is used |
-| `org.apache.felix.http.enable` | Flag to enable the use of HTTP. The default is `true` |
-| `org.apache.felix.https.enable` | Flag to enable the user of HTTPS. The default is `false` |
-| `org.apache.felix.https.keystore` | The name of the file containing the keystore |
-| `org.apache.felix.https.keystore.password` | The password for the keystore |
-| `org.apache.felix.https.keystore.key.password` | The password for the key in the keystore |
-| `org.apache.felix.https.truststore` | The name of the file containing the truststore |
-| `org.apache.felix.https.truststore.type` | The type of truststore to use. The default is `JKS` |
-| `org.apache.felix.https.truststore.password` | The password for the truststore |
-| `org.apache.felix.https.clientcertificate` | Flag to determine if the HTTPS protocol requires, wants or does not use client certificates. Legal values are `needs`, `wants` and `none`. The default is `none` |
-| `org.mortbay.jetty.servlet.SessionCookie` | Name of the cookie used to transport the Session ID. The default is `JSESSIONID` |
-| `org.mortbay.jetty.servlet.SessionURL` | Name of the request parameter to transport the Session ID. The default is `jsessionid` |
-| `org.mortbay.jetty.servlet.SessionDomain` | Domain to set on the session cookie. The default is `null` |
-| `org.mortbay.jetty.servlet.SessionPath` | The path to set on the session cookie. The default is the configured session context path (`/`) |
-| `org.mortbay.jetty.servlet.MaxAge` | The maximum age value to set on the cookie. The default is `-1` |
-| `org.apache.felix.http.jetty.headerBufferSize` | Size of the buffer for request and response headers. Default is 16 KB |
-| `org.apache.felix.http.jetty.requestBufferSize` | Size of the buffer for requests not fitting the header buffer. Default is 8 KB |
-| `org.apache.felix.http.jetty.responseBufferSize` | Size of the buffer for responses. Default is 24 KB |
-| `org.apache.felix.http.jetty.maxFormSize` | The maximum size accepted for a form post. Defaults to 200 KB |
-| `org.apache.felix.https.jetty.cipersuites.excluded` | Configures comma-separated list of cipher suites to *exclude*. Default is `null`, meaning that no cipher suite is excluded |
-| `org.apache.felix.https.jetty.cipersuites.included` | Configures comma-separated list of cipher suites to *include*. Default is `null`, meaning that the default cipher suites are used |
-| `org.apache.felix.http.mbeans` | If `true`, enables the MBean server functionality. The default is `false` |
+| `org.apache.felix.http.debug` | Flag to enable debugging for this service implementation. The default is `false`. |
+| `org.apache.felix.http.host` | Host name or IP Address of the interface to listen on. The default is `null` causing Jetty to listen on all interfaces. |
+| `org.osgi.service.http.port` | The port used for servlets and resources available via HTTP. The default is `80`. A negative port number has the same effect as setting `org.apache.felix.http.enable` to `false`. |
+| `org.osgi.service.http.port.secure` | The port used for servlets and resources available via HTTPS. The default is `443`. A negative port number has the same effect as setting `org.apache.felix.https.enable` to `false`. |
+| `org.apache.felix.http.context_path` | The Servlet Context Path to use for the Http Service. If this property is not configured it defaults to "/". This must be a valid path starting with a slash and not ending with a slash (unless it is the root context). |
+| `org.apache.felix.http.timeout` | Connection timeout in milliseconds. The default is 60000 (60 seconds). |
+| `org.apache.felix.http.session.timeout` | Allows for the specification of the Session life time as a number of minutes. This property serves the same purpose as the `session-timeout` element in a Web Application descriptor. The default is `0` (zero) for no timeout at all. |
+| `org.apache.felix.http.nio` | Flag to enable the use of NIO instead of traditional IO for HTTP. One consequence of using NIO with HTTP is that the bundle needs at least a Java 5 runtime. The default is `true`. |
+| `org.apache.felix.https.nio` | Flag to enable the use of NIO instead of traditional IO for HTTPS. One consequence of using NIO with HTTPS is that the bundle needs at least a Java 5 runtime. If this property is not set the (default) value of the `org.apache.felix.http.nio` property is used. |
+| `org.apache.felix.http.enable` | Flag to enable the use of HTTP. The default is `true`. |
+| `org.apache.felix.https.enable` | Flag to enable the user of HTTPS. The default is `false`. |
+| `org.apache.felix.https.keystore` | The name of the file containing the keystore. |
+| `org.apache.felix.https.keystore.password` | The password for the keystore. |
+| `org.apache.felix.https.keystore.key.password` | The password for the key in the keystore. |
+| `org.apache.felix.https.truststore` | The name of the file containing the truststore. |
+| `org.apache.felix.https.truststore.type` | The type of truststore to use. The default is `JKS`. |
+| `org.apache.felix.https.truststore.password` | The password for the truststore. |
+| `org.apache.felix.https.jetty.ciphersuites.excluded` | Configures comma-separated list of SSL cipher suites to *exclude*. Default is `null`, meaning that no cipher suite is excluded. |
+| `org.apache.felix.https.jetty.ciphersuites.included` | Configures comma-separated list of SSL cipher suites to *include*. Default is `null`, meaning that the default cipher suites are used. |
+| `org.apache.felix.https.clientcertificate` | Flag to determine if the HTTPS protocol requires, wants or does not use client certificates. Legal values are `needs`, `wants` and `none`. The default is `none`. |
+| `org.apache.felix.http.jetty.headerBufferSize` | Size of the buffer for request and response headers. Default is 16 KB. |
+| `org.apache.felix.http.jetty.requestBufferSize` | Size of the buffer for requests not fitting the header buffer. Default is 8 KB. |
+| `org.apache.felix.http.jetty.responseBufferSize` | Size of the buffer for responses. Default is 24 KB. |
+| `org.apache.felix.http.jetty.maxFormSize` | The maximum size accepted for a form post. Defaults to 200 KB. |
+| `org.apache.felix.http.mbeans` | If `true`, enables the MBean server functionality. The default is `false`. |
+| `org.eclipse.jetty.servlet.SessionCookie` | Name of the cookie used to transport the Session ID. The default is `JSESSIONID`. |
+| `org.eclipse.jetty.servlet.SessionURL` | Name of the request parameter to transport the Session ID. The default is `jsessionid`. |
+| `org.eclipse.jetty.servlet.SessionDomain` | Domain to set on the session cookie. The default is `null`. |
+| `org.eclipse.jetty.servlet.SessionPath` | The path to set on the session cookie. The default is the configured session context path (`/`). |
+| `org.eclipse.jetty.servlet.MaxAge` | The maximum age value to set on the cookie. The default is `-1`. |
Additionally, the all-in-one bundle uses the following environment properties:
| Property | Description |
|--|--|
-| `org.apache.felix.http.jettyEnabled` | If `true`, the embedded Jetty server is used as HTTP container. The default is `false` |
-| `org.apache.felix.http.whiteboardEnabled` | If `true`, the whiteboard-style registration of servlets and filters is enabled. The default is `false` |
-| `org.apache.felix.http.cometdEnabled` | If `true` the CometD/Ajax Push feature is enabled. The default is `false` |
+| `org.apache.felix.http.jettyEnabled` | If `true`, the embedded Jetty server is used as HTTP container. The default is `false`. |
+| `org.apache.felix.http.whiteboardEnabled` | If `true`, the whiteboard-style registration of servlets and filters is enabled. The default is `false`. |
+| `org.apache.felix.http.cometdEnabled` | If `true` the CometD/Ajax Push feature is enabled. The default is `false`. |
The CometD bundle supports the following configuration options:
| Property | Description |
|--|--|
-| `org.apache.felix.http.cometd.path` | Defines the path for the CometD endpoint. Default is `/system/cometd` |
+| `org.apache.felix.http.cometd.path` | Defines the path for the CometD endpoint. Default is `/system/cometd`. |
+
## Servlet API Events