| Element | Description | Class |
|---|
| bioConnector | Creates a BIO based socket connector | org.mortbay.jetty.bio.SocketConnector |
| blockingNioConnector | Creates a blocking NIO based socket connector | org.mortbay.jetty.nio.BlockingChannelConnector |
| contextHandler | Creates a basic HTTP context | org.mortbay.jetty.handler.ContextHandler |
| contexts | ContextHandlerCollection.
This {@link org.mortbay.jetty.handler.HandlerCollection} is creates a
{@link org.mortbay.jetty.servlet.PathMap} to it's contained handlers based
on the context path and virtual hosts of any contained {@link org.mortbay.jetty.handler.ContextHandler}s.
The contexts do not need to be directly contained, only children of the contained handlers.
Multiple contexts may have the same context path and they are called in order until one
handles the request. | org.mortbay.jetty.handler.ContextHandlerCollection |
| defaultHandler | Default Handler.
This handle will deal with unhandled requests in the server.
For requests for favicon.ico, the Jetty icon is served.
For reqests to '/' a 404 with a list of known contexts is served.
For all other requests a normal 404 is served.
TODO Implement OPTIONS and TRACE methods for the server. | org.mortbay.jetty.handler.DefaultHandler |
| handlerCollection | A collection of handlers.
For each request, all handler are called, regardless of
the response status or exceptions. | org.mortbay.jetty.handler.HandlerCollection |
| hotDeployer | Creates a hot deployer | org.mortbay.jetty.deployer.ContextDeployer |
| jaasUserRealm | Creates a UserRealm suitable for use with JAAS | org.mortbay.jetty.plus.jaas.JAASUserRealm |
| jetty | Creates an | org.mortbay.jetty.xbean.JettyFactoryBean |
| ncsaLog | This {@link RequestLog} implementation outputs logs in the pseudo-standard
NCSA common log format. Configuration options allow a choice between the
standard Common Log Format (as used in the 3 log format) and the Combined Log
Format (single log format). This log format can be output by most web
servers, and almost all web log analysis software can understand these
formats. | org.mortbay.jetty.NCSARequestLog |
| nioConnector | Creates an NIO based socket connector | org.mortbay.jetty.nio.SelectChannelConnector |
| requestLogHandler | RequestLogHandler.
This handler can be used to wrap an individual context for context logging. | org.mortbay.jetty.handler.RequestLogHandler |
| resourceHandler | Resource Handler.
This handle will serve static content and handle If-Modified-Since headers.
No caching is done.
Requests that cannot be handled are let pass (Eg no 404's) | org.mortbay.jetty.handler.ResourceHandler |
| server | Creates an embedded Jetty web server | org.mortbay.jetty.Server |
| sslConnector | Creates an NIO ssl connector | org.mortbay.jetty.ssl.SslSelectChannelConnector |
| sslSocketConnector | Creates an ssl socket connector | org.mortbay.jetty.ssl.SslSocketConnector |
| ssoJaasUserRealm | Creates a UserRealm suitable for use with JAAS w/ support of SSO | org.mortbay.jetty.plus.jaas.SSOJAASUserRealm |
| strictRoleCheckPolicy | Check only topmost role in stack of roles for user | org.mortbay.jetty.plus.jaas.StrictRoleCheckPolicy |
| webAppContext | Creates a servlet web application at a given context from a resource base | org.mortbay.jetty.webapp.WebAppContext |
| Attribute | Type | Description |
|---|
| acceptQueueSize | xs:integer | |
| acceptorPriorityOffset | xs:integer | Set the priority offset of the acceptor threads. The priority is adjusted by
this amount (default 0) to either favour the acceptance of new threads and newly active
connections or to favour the handling of already dispatched connections. |
| acceptors | xs:integer | |
| confidentialPort | xs:integer | |
| confidentialScheme | xs:string | |
| forwarded | xs:boolean | Is reverse proxy handling on? |
| forwardedForHeader | xs:string | |
| forwardedHostHeader | xs:string | |
| forwardedServerHeader | xs:string | |
| headerBufferSize | xs:integer | |
| host | xs:string | |
| hostHeader | xs:string | Set a forced valued for the host header to control what is returned
by {@link ServletRequest#getServerName()} and {@link ServletRequest#getServerPort()}.
This value is only used if {@link #isForwarded()} is true. |
| integralPort | xs:integer | |
| integralScheme | xs:string | |
| lowResourceMaxIdleTime | xs:integer | |
| maxIdleTime | xs:integer | Set the maximum Idle time for a connection, which roughly translates
to the {@link Socket#setSoTimeout(int)} call, although with NIO
implementations other mechanisms may be used to implement the timeout.
The max idle time is applied:
- When waiting for a new request to be received on a connection
- When reading the headers and content of a request
- When writing the headers and content of a response
Jetty interprets this value as the maximum time between some progress being
made on the connection. So if a single byte is read or written, then the
timeout (if implemented by jetty) is reset. However, in many instances,
the reading/writing is delegated to the JVM, and the semantic is more
strictly enforced as the maximum time a single read/write operation can
take. Note, that as Jetty supports writes of memory mapped file buffers,
then a write may take many 10s of seconds for large content written to a
slow device.
Previously, Jetty supported separate idle timeouts and IO operation timeouts,
however the expense of changing the value of soTimeout was significant, so
these timeouts were merged. With the advent of NIO, it may be possible to
again differentiate these values (if there is demand). |
| name | xs:string | |
| port | xs:integer | |
| requestBufferSize | xs:integer | |
| resolveNames | xs:boolean | |
| responseBufferSize | xs:integer | |
| reuseAddress | xs:boolean | |
| soLingerTime | xs:integer | |
| statsOn | xs:boolean | |
| Attribute | Type | Description |
|---|
| acceptQueueSize | xs:integer | |
| acceptorPriorityOffset | xs:integer | Set the priority offset of the acceptor threads. The priority is adjusted by
this amount (default 0) to either favour the acceptance of new threads and newly active
connections or to favour the handling of already dispatched connections. |
| acceptors | xs:integer | |
| confidentialPort | xs:integer | |
| confidentialScheme | xs:string | |
| forwarded | xs:boolean | Is reverse proxy handling on? |
| forwardedForHeader | xs:string | |
| forwardedHostHeader | xs:string | |
| forwardedServerHeader | xs:string | |
| headerBufferSize | xs:integer | |
| host | xs:string | |
| hostHeader | xs:string | Set a forced valued for the host header to control what is returned
by {@link ServletRequest#getServerName()} and {@link ServletRequest#getServerPort()}.
This value is only used if {@link #isForwarded()} is true. |
| integralPort | xs:integer | |
| integralScheme | xs:string | |
| lowResourceMaxIdleTime | xs:integer | |
| maxIdleTime | xs:integer | Set the maximum Idle time for a connection, which roughly translates
to the {@link Socket#setSoTimeout(int)} call, although with NIO
implementations other mechanisms may be used to implement the timeout.
The max idle time is applied:
- When waiting for a new request to be received on a connection
- When reading the headers and content of a request
- When writing the headers and content of a response
Jetty interprets this value as the maximum time between some progress being
made on the connection. So if a single byte is read or written, then the
timeout (if implemented by jetty) is reset. However, in many instances,
the reading/writing is delegated to the JVM, and the semantic is more
strictly enforced as the maximum time a single read/write operation can
take. Note, that as Jetty supports writes of memory mapped file buffers,
then a write may take many 10s of seconds for large content written to a
slow device.
Previously, Jetty supported separate idle timeouts and IO operation timeouts,
however the expense of changing the value of soTimeout was significant, so
these timeouts were merged. With the advent of NIO, it may be possible to
again differentiate these values (if there is demand). |
| name | xs:string | |
| port | xs:integer | |
| requestBufferSize | xs:integer | |
| resolveNames | xs:boolean | |
| responseBufferSize | xs:integer | |
| reuseAddress | xs:boolean | |
| soLingerTime | xs:integer | |
| statsOn | xs:boolean | |
| useDirectBuffers | xs:boolean | |
| Attribute | Type | Description |
|---|
| acceptQueueSize | xs:integer | |
| acceptorPriorityOffset | xs:integer | Set the priority offset of the acceptor threads. The priority is adjusted by
this amount (default 0) to either favour the acceptance of new threads and newly active
connections or to favour the handling of already dispatched connections. |
| acceptors | xs:integer | |
| confidentialPort | xs:integer | |
| confidentialScheme | xs:string | |
| forwarded | xs:boolean | Is reverse proxy handling on? |
| forwardedForHeader | xs:string | |
| forwardedHostHeader | xs:string | |
| forwardedServerHeader | xs:string | |
| headerBufferSize | xs:integer | |
| host | xs:string | |
| hostHeader | xs:string | Set a forced valued for the host header to control what is returned
by {@link ServletRequest#getServerName()} and {@link ServletRequest#getServerPort()}.
This value is only used if {@link #isForwarded()} is true. |
| integralPort | xs:integer | |
| integralScheme | xs:string | |
| lowResourceMaxIdleTime | xs:integer | Set the period in ms that a connection is allowed to be idle when this there are more
than {@link #getLowResourcesConnections()} connections. This allows the server to rapidly close idle connections
in order to gracefully handle high load situations. |
| lowResourcesConnections | xs:long | Set the number of connections, which if exceeded places this manager in low resources state.
This is not an exact measure as the connection count is averaged over the select sets. |
| lowResourcesMaxIdleTime | xs:long | Set the period in ms that a connection is allowed to be idle when this there are more
than {@link #getLowResourcesConnections()} connections. This allows the server to rapidly close idle connections
in order to gracefully handle high load situations. |
| maxIdleTime | xs:integer | |
| name | xs:string | |
| port | xs:integer | |
| requestBufferSize | xs:integer | |
| resolveNames | xs:boolean | |
| responseBufferSize | xs:integer | |
| reuseAddress | xs:boolean | |
| soLingerTime | xs:integer | |
| statsOn | xs:boolean | |
| useDirectBuffers | xs:boolean | |
| Attribute | Type | Description |
|---|
| acceptQueueSize | xs:integer | |
| acceptorPriorityOffset | xs:integer | Set the priority offset of the acceptor threads. The priority is adjusted by
this amount (default 0) to either favour the acceptance of new threads and newly active
connections or to favour the handling of already dispatched connections. |
| acceptors | xs:integer | |
| algorithm | xs:string | |
| confidentialPort | xs:integer | |
| confidentialScheme | xs:string | |
| forwarded | xs:boolean | Is reverse proxy handling on? |
| forwardedForHeader | xs:string | |
| forwardedHostHeader | xs:string | |
| forwardedServerHeader | xs:string | |
| headerBufferSize | xs:integer | |
| host | xs:string | |
| hostHeader | xs:string | Set a forced valued for the host header to control what is returned
by {@link ServletRequest#getServerName()} and {@link ServletRequest#getServerPort()}.
This value is only used if {@link #isForwarded()} is true. |
| integralPort | xs:integer | |
| integralScheme | xs:string | |
| keyPassword | xs:string | |
| keystore | xs:string | |
| keystoreType | xs:string | |
| lowResourceMaxIdleTime | xs:integer | Set the period in ms that a connection is allowed to be idle when this there are more
than {@link #getLowResourcesConnections()} connections. This allows the server to rapidly close idle connections
in order to gracefully handle high load situations. |
| lowResourcesConnections | xs:long | Set the number of connections, which if exceeded places this manager in low resources state.
This is not an exact measure as the connection count is averaged over the select sets. |
| lowResourcesMaxIdleTime | xs:long | Set the period in ms that a connection is allowed to be idle when this there are more
than {@link #getLowResourcesConnections()} connections. This allows the server to rapidly close idle connections
in order to gracefully handle high load situations. |
| maxIdleTime | xs:integer | |
| name | xs:string | |
| needClientAuth | xs:boolean | Set the value of the needClientAuth property |
| password | xs:string | |
| port | xs:integer | |
| protocol | xs:string | |
| provider | xs:string | |
| requestBufferSize | xs:integer | |
| resolveNames | xs:boolean | |
| responseBufferSize | xs:integer | |
| reuseAddress | xs:boolean | |
| secureRandomAlgorithm | xs:string | |
| soLingerTime | xs:integer | |
| sslKeyManagerFactoryAlgorithm | xs:string | |
| sslTrustManagerFactoryAlgorithm | xs:string | |
| statsOn | xs:boolean | |
| trustPassword | xs:string | |
| truststore | xs:string | |
| truststoreType | xs:string | |
| useDirectBuffers | xs:boolean | |
| wantClientAuth | xs:boolean | |
| Attribute | Type | Description |
|---|
| acceptQueueSize | xs:integer | |
| acceptorPriorityOffset | xs:integer | Set the priority offset of the acceptor threads. The priority is adjusted by
this amount (default 0) to either favour the acceptance of new threads and newly active
connections or to favour the handling of already dispatched connections. |
| acceptors | xs:integer | |
| confidentialPort | xs:integer | |
| confidentialScheme | xs:string | |
| forwarded | xs:boolean | Is reverse proxy handling on? |
| forwardedForHeader | xs:string | |
| forwardedHostHeader | xs:string | |
| forwardedServerHeader | xs:string | |
| handshakeTimeout | xs:integer | Set the time in milliseconds for so_timeout during ssl handshaking |
| headerBufferSize | xs:integer | |
| host | xs:string | |
| hostHeader | xs:string | Set a forced valued for the host header to control what is returned
by {@link ServletRequest#getServerName()} and {@link ServletRequest#getServerPort()}.
This value is only used if {@link #isForwarded()} is true. |
| integralPort | xs:integer | |
| integralScheme | xs:string | |
| keyPassword | xs:string | |
| keystore | xs:string | |
| keystoreType | xs:string | |
| lowResourceMaxIdleTime | xs:integer | |
| maxIdleTime | xs:integer | Set the maximum Idle time for a connection, which roughly translates
to the {@link Socket#setSoTimeout(int)} call, although with NIO
implementations other mechanisms may be used to implement the timeout.
The max idle time is applied:
- When waiting for a new request to be received on a connection
- When reading the headers and content of a request
- When writing the headers and content of a response
Jetty interprets this value as the maximum time between some progress being
made on the connection. So if a single byte is read or written, then the
timeout (if implemented by jetty) is reset. However, in many instances,
the reading/writing is delegated to the JVM, and the semantic is more
strictly enforced as the maximum time a single read/write operation can
take. Note, that as Jetty supports writes of memory mapped file buffers,
then a write may take many 10s of seconds for large content written to a
slow device.
Previously, Jetty supported separate idle timeouts and IO operation timeouts,
however the expense of changing the value of soTimeout was significant, so
these timeouts were merged. With the advent of NIO, it may be possible to
again differentiate these values (if there is demand). |
| name | xs:string | |
| needClientAuth | xs:boolean | Set the value of the needClientAuth property |
| password | xs:string | |
| port | xs:integer | |
| protocol | xs:string | |
| provider | xs:string | |
| requestBufferSize | xs:integer | |
| resolveNames | xs:boolean | |
| responseBufferSize | xs:integer | |
| reuseAddress | xs:boolean | |
| secureRandomAlgorithm | xs:string | |
| soLingerTime | xs:integer | |
| sslKeyManagerFactoryAlgorithm | xs:string | |
| sslTrustManagerFactoryAlgorithm | xs:string | |
| statsOn | xs:boolean | |
| trustPassword | xs:string | |
| truststore | xs:string | |
| truststoreType | xs:string | |
| wantClientAuth | xs:boolean | Set the value of the _wantClientAuth property. This property is used when
{@link #newServerSocket(SocketAddress, int) opening server sockets}. |
| Attribute | Type | Description |
|---|
| aliases | xs:boolean | |
| allowNullPathInfo | xs:boolean | |
| compactPath | xs:boolean | |
| contextPath | xs:string | |
| copyWebDir | xs:boolean | |
| defaultsDescriptor | xs:string | The default descriptor is a web.xml format file that is applied to the context before the standard WEB-INF/web.xml |
| descriptor | xs:string | |
| displayName | xs:string | |
| distributable | xs:boolean | |
| extraClasspath | xs:string | |
| extractWAR | xs:boolean | |
| logUrlOnStart | xs:boolean | Sets whether or not the web app name and URL is logged on startup |
| maxFormContentSize | xs:integer | |
| overrideDescriptor | xs:string | The override descriptor is a web.xml format file that is applied to the context after the standard WEB-INF/web.xml |
| parentLoaderPriority | xs:boolean | |
| resourceBase | xs:string | |
| shutdown | xs:boolean | Set shutdown status.
This field allows for graceful shutdown of a context. A started context may be put into non accepting state so
that existing requests can complete, but no new requests are accepted. |
| tempDirectory | xs:string | Get a temporary directory in which to unpack the war etc etc.
The algorithm for determining this is to check these alternatives
in the order shown:
A. Try to use an explicit directory specifically for this webapp:
-
Iff an explicit directory is set for this webapp, use it. Do NOT set
delete on exit.
-
Iff javax.servlet.context.tempdir context attribute is set for
this webapp && exists && writeable, then use it. Do NOT set delete on exit.
B. Create a directory based on global settings. The new directory
will be called "Jetty_"+host+"_"+port+"__"+context+"_"+virtualhost
Work out where to create this directory:
-
Iff $(jetty.home)/work exists create the directory there. Do NOT
set delete on exit. Do NOT delete contents if dir already exists.
-
Iff WEB-INF/work exists create the directory there. Do NOT set
delete on exit. Do NOT delete contents if dir already exists.
-
Else create dir in $(java.io.tmpdir). Set delete on exit. Delete
contents if dir already exists.
|
| war | xs:string | |
| webApp | xs:string | The URL or filename of the webapp directory or war file. |
| Element | Type | Description |
|---|
| attributes | contextHandler | jetty | server | webAppContext | |
| baseResource | <spring:bean/> | |
| classLoader | <spring:bean/> | |
| configurationClasses | (<spring:bean/>)* | |
| configurations | (<spring:bean/>)* | |
| connectorNames | (<spring:bean/>)* | Set the names of accepted connectors.
Names are either "host:port" or a specific configured name for a connector. |
| errorHandler | <spring:bean/> | |
| eventListeners | (<spring:bean/>)* | |
| handler | contextHandler | contexts | defaultHandler | handlerCollection | jetty | requestLogHandler | resourceHandler | server | webAppContext | |
| hosts | (<spring:bean/>)* | Get the hosts for the context. |
| initParams | <spring:bean/> | |
| logger | <spring:bean/> | |
| mimeTypes | <spring:bean/> | |
| parent | contextHandler | contexts | handlerCollection | jetty | requestLogHandler | server | webAppContext | The parent HandlerContainer. |
| permissions | <spring:bean/> | |
| resourceAliases | <spring:bean/> | |
| securityHandler | <spring:bean/> | |
| server | jetty | server | |
| serverClasses | (<spring:bean/>)* | Set the server classes patterns.
Server classes/packages are classes used to implement the server and are hidden
from the context. If the context needs to load these classes, it must have its
own copy of them in WEB-INF/lib or WEB-INF/classes.
A class pattern is a string of one of the forms:
- org.package.Classname
- Match a specific class
- org.package.
- Match a specific package hierarchy
- -org.package.Classname
- Exclude a specific class
- -org.package.
- Exclude a specific package hierarchy
|
| servletHandler | <spring:bean/> | |
| sessionHandler | <spring:bean/> | |
| systemClasses | (<spring:bean/>)* | Set the system classes patterns.
System classes/packages are classes provided by the JVM and that
cannot be replaced by classes of the same name from WEB-INF,
regardless of the value of {@link #setParentLoaderPriority(boolean)}.
A class pattern is a string of one of the forms:
- org.package.Classname
- Match a specific class
- org.package.
- Match a specific package hierarchy
- -org.package.Classname
- Exclude a specific class
- -org.package.
- Exclude a specific package hierarchy
|
| virtualHosts | (<spring:bean/>)* | Get the virtual hosts for the context.
Only requests that have a matching host header or fully qualified
URL will be passed to that context with a virtual host name.
A context with no virtual host names or a null virtual host name is
available to all requests that are not served by a context with a
matching virtual host name. |
| welcomeFiles | (<spring:bean/>)* | |