org.qi4j.library.http
Interface JettyConfiguration

All Superinterfaces:

Composite, ConfigurationComposite, EntityComposite, Identity

All Known Subinterfaces:

SecureJettyConfiguration

public interface JettyConfiguration
extends ConfigurationComposite

Configuration of the JettyService. The only mandatory property is port. Other properties are provided with a sensible default respecting the original Jetty defaults.

Nested Class Summary

Nested classes/interfaces inherited from interface org.qi4j.api.entity.Identity

Identity.IdentityMixin

Method Summary

Property<java.lang.String>	contextPath() url prefix of the JettyService.
Property<java.lang.Integer>	gracefullShutdownTimeout() Timeout use to wait for active requests to terminate on shutdown in milliseconds.
Property<java.lang.String>	hostName() Name or ip representing the interface on which the JettyService will bind the server socket.
Property<java.lang.Integer>	lowResourceMaxIdleTime()
Property<java.lang.Integer>	maxFormContentSize()
Property<java.lang.Integer>	maxIdleTime()
Property<java.lang.Integer>	port()
Property<java.lang.Integer>	requestBufferSize() Size of the content buffer for receiving requests in bytes.
Property<java.lang.Integer>	requestHeaderSize()
Property<java.lang.String>	resourcePath()
Property<java.lang.Integer>	responseBufferSize() Size of the content buffer for sending responses in bytes.
Property<java.lang.Integer>	responseHeaderSize()
Property<java.lang.Boolean>	sendDateHeader()
Property<java.lang.Boolean>	sendServerVersion()
Property<java.lang.Boolean>	statistics() Defaults to false.
Property<java.lang.String>	virtualHosts() Virtual hosts for this JettyService.
Property<java.lang.String>	welcomeFiles() Welcome files names for this JettyService.

Methods inherited from interface org.qi4j.api.entity.Identity

identity

Method Detail

port

Property<java.lang.Integer> port()

Returns:

Port on which the JettyService will listen for incomming requests.

hostName

@Optional
Property<java.lang.String> hostName()

Name or ip representing the interface on which the JettyService will bind the server socket. If not set the JettyService will be bound to all interfaces.

Returns:

Name or ip representing the interface on which the JettyService will bind the server socket.

statistics

@UseDefaults
Property<java.lang.Boolean> statistics()

Defaults to false.

Returns:

If the JettyService should collect statistics.

maxIdleTime

@Optional
Property<java.lang.Integer> maxIdleTime()

Returns:

Maximum Idle time for connections in milliseconds.

lowResourceMaxIdleTime

@Optional
Property<java.lang.Integer> lowResourceMaxIdleTime()

Returns:

Maximum Idle time for connections in milliseconds when resources are low.

requestHeaderSize

@Optional
Property<java.lang.Integer> requestHeaderSize()

Returns:

The size of the buffer to be used for request headers in bytes.

requestBufferSize

@Optional
Property<java.lang.Integer> requestBufferSize()

Size of the content buffer for receiving requests in bytes. These buffers are only used for active connections that have requests with bodies that will not fit within the header buffer.

Returns:

The size of the content buffer for receiving requests in bytes.

responseHeaderSize

@Optional
Property<java.lang.Integer> responseHeaderSize()

Returns:

The size of the buffer to be used for response headers in bytes.

responseBufferSize

@Optional
Property<java.lang.Integer> responseBufferSize()

Size of the content buffer for sending responses in bytes. These buffers are only used for active connections that are sending responses with bodies that will not fit within the header buffer.

Returns:

The size of the content buffer for sending responses in bytes.

contextPath

@Optional
Property<java.lang.String> contextPath()

url prefix of the JettyService. Defaulted to "/".

Returns:

The url prefix of the JettyService.

resourcePath

@Optional
Property<java.lang.String> resourcePath()

virtualHosts

@Optional
Property<java.lang.String> virtualHosts()

Virtual hosts for this JettyService. Coma separated list of hostnames.

Returns:

Virtual hosts for this JettyService.

welcomeFiles

@Optional
Property<java.lang.String> welcomeFiles()

Welcome files names for this JettyService. Coma separated list of welcome files. Defaulted to index.html.

Returns:

Welcome files names for this JettyService.

maxFormContentSize

@Optional
Property<java.lang.Integer> maxFormContentSize()

Returns:

Maximum Form content size.

sendDateHeader

@Optional
Property<java.lang.Boolean> sendDateHeader()

Returns:

If JettyService populates http header with server date.

sendServerVersion

@Optional
Property<java.lang.Boolean> sendServerVersion()

Returns:

If JettyService expose it's implementation version.

gracefullShutdownTimeout

@Optional
Property<java.lang.Integer> gracefullShutdownTimeout()

Timeout use to wait for active requests to terminate on shutdown in milliseconds. Jetty will stop gracefully only if this property is set.

Returns:

Timeout use to wait for active requests to terminate on shutdown in milliseconds.