JettyOptions

Options for configuring Jetty.

join: If true, calls join() on Server instance (blocking till server shuts down)
host: The network interface connectors will bind to. If None or 0.0.0.0, binds to all interfaces.
httpPort: A ServerConnector will be created listening on this port.
maxThreads: Max threads in the threadpool used by connectors to run (eventually) the handler.
minThreads: Minimum threads to keep alive in the Jetty threadpool.
daemonThreads: If true, all threads in Jetty's threadpool will be daemon threads.
configFn: A function to mess around with the Server instance before start is called.
maxIdleTime: The max idle time for a connection (roughly Socket.setSoTimeout(int))
allowHttp: If true an HTTP connector is setup listening on port
allowSsl: If true an SSL connector is setup listing on sslPort
sslPort: The port to listen for SSL connections if enableSsl is true.
sendDateHeader: If true, include date in HTTP headers
outputBufferSize: The size of the buffer into which the response is aggregated before being sent to the client. Larger buffer is less likely to block content producer, but could increase from client's perspective.
requestHeaderSize: Max size of a request header. Larger sizes allow for more cookies or stuff encoded in a URL.
responseHeaderSize: Max size of a response header. Similar use cases as requestHeaderSize.
sendServerVersion: If true, send the Server header in responses.
keyStore: Specifies the keystore (private certs) to use for SSL connections
keyStorePassword: Password for keystore
trustStore: Specifies the keystore (public certs) to use for SSL connections
trustStorePassword: Password for trustStore
clientAuth: Policy for client SSL authentication (i.e. Need/Want).
excludeCiphers: Cipher suites to exclude when using SSL
excludeProtocols: Protocols to exclude when using SSL

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new JettyOptions(join: Boolean = true, host: Option[String] = None, httpPort: Int = 80, maxThreads: Int = 50, minThreads: Int = 8, daemonThreads: Boolean = false, configFn: (Server) ⇒ Unit = _ =>, maxIdleTime: Int = 200000, allowHttp: Boolean = true, allowSsl: Boolean = false, sslPort: Int = 443, sendDateHeader: Boolean = true, outputBufferSize: Int = 32768, requestHeaderSize: Int = 8192, responseHeaderSize: Int = 8192, sendServerVersion: Boolean = true, keyStore: Option[SslStoreConfig] = None, keyStorePassword: Option[String] = None, trustStore: Option[SslStoreConfig] = None, trustStorePassword: Option[String] = None, clientAuth: Option[ClientAuth] = None, excludeCiphers: Vector[String] = Vector.empty, excludeProtocols: Vector[String] = Vector.empty)

join
If true, calls join() on Server instance (blocking till server shuts down)
host
The network interface connectors will bind to. If None or 0.0.0.0, binds to all interfaces.
httpPort
A ServerConnector will be created listening on this port.
maxThreads
Max threads in the threadpool used by connectors to run (eventually) the handler.
minThreads
Minimum threads to keep alive in the Jetty threadpool.
daemonThreads
If true, all threads in Jetty's threadpool will be daemon threads.
configFn
A function to mess around with the Server instance before start is called.
maxIdleTime
The max idle time for a connection (roughly Socket.setSoTimeout(int))
allowHttp
If true an HTTP connector is setup listening on port
allowSsl
If true an SSL connector is setup listing on sslPort
sslPort
The port to listen for SSL connections if enableSsl is true.
sendDateHeader
If true, include date in HTTP headers
outputBufferSize
The size of the buffer into which the response is aggregated before being sent to the client. Larger buffer is less likely to block content producer, but could increase from client's perspective.
requestHeaderSize
Max size of a request header. Larger sizes allow for more cookies or stuff encoded in a URL.
responseHeaderSize
Max size of a response header. Similar use cases as requestHeaderSize.
sendServerVersion
If true, send the Server header in responses.
keyStore
Specifies the keystore (private certs) to use for SSL connections
keyStorePassword
Password for keystore
trustStore
Specifies the keystore (public certs) to use for SSL connections
trustStorePassword
Password for trustStore
clientAuth
Policy for client SSL authentication (i.e. Need/Want).
excludeCiphers
Cipher suites to exclude when using SSL
excludeProtocols
Protocols to exclude when using SSL

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val allowHttp: Boolean

If true an HTTP connector is setup listening on port
val allowSsl: Boolean

If true an SSL connector is setup listing on sslPort
final def asInstanceOf[T0]: T0

Definition Classes
Any
val clientAuth: Option[ClientAuth]

Policy for client SSL authentication (i.e.
Policy for client SSL authentication (i.e. Need/Want).
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val configFn: (Server) ⇒ Unit

A function to mess around with the Server instance before start is called.
val daemonThreads: Boolean

If true, all threads in Jetty's threadpool will be daemon threads.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val excludeCiphers: Vector[String]

Cipher suites to exclude when using SSL
val excludeProtocols: Vector[String]

Protocols to exclude when using SSL
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val host: Option[String]

The network interface connectors will bind to.
The network interface connectors will bind to. If None or 0.0.0.0, binds to all interfaces.
val httpPort: Int

A ServerConnector will be created listening on this port.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val join: Boolean

If true, calls join() on Server instance (blocking till server shuts down)
val keyStore: Option[SslStoreConfig]

Specifies the keystore (private certs) to use for SSL connections
val keyStorePassword: Option[String]

Password for keystore
val maxIdleTime: Int

The max idle time for a connection (roughly Socket.setSoTimeout(int))
val maxThreads: Int

Max threads in the threadpool used by connectors to run (eventually) the handler.
val minThreads: Int

Minimum threads to keep alive in the Jetty threadpool.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val outputBufferSize: Int

The size of the buffer into which the response is aggregated before being sent to the client.
The size of the buffer into which the response is aggregated before being sent to the client. Larger buffer is less likely to block content producer, but could increase from client's perspective.
val requestHeaderSize: Int

Max size of a request header.
Max size of a request header. Larger sizes allow for more cookies or stuff encoded in a URL.
val responseHeaderSize: Int

Max size of a response header.
Max size of a response header. Similar use cases as requestHeaderSize.
val sendDateHeader: Boolean

If true, include date in HTTP headers
val sendServerVersion: Boolean

If true, send the Server header in responses.
val sslPort: Int

The port to listen for SSL connections if enableSsl is true.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val trustStore: Option[SslStoreConfig]

Specifies the keystore (public certs) to use for SSL connections
val trustStorePassword: Option[String]

Password for trustStore
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object JettyOptions | package circlet

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowHttp: Boolean

val allowSsl: Boolean

final def asInstanceOf[T0]: T0

val clientAuth: Option[ClientAuth]

def clone(): AnyRef

val configFn: (Server) ⇒ Unit

val daemonThreads: Boolean

final def eq(arg0: AnyRef): Boolean

val excludeCiphers: Vector[String]

val excludeProtocols: Vector[String]

def finalize(): Unit

final def getClass(): Class[_]

val host: Option[String]

val httpPort: Int

final def isInstanceOf[T0]: Boolean

val join: Boolean

val keyStore: Option[SslStoreConfig]

val keyStorePassword: Option[String]

val maxIdleTime: Int

val maxThreads: Int

val minThreads: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val outputBufferSize: Int

val requestHeaderSize: Int

val responseHeaderSize: Int

val sendDateHeader: Boolean

val sendServerVersion: Boolean

val sslPort: Int

final def synchronized[T0](arg0: ⇒ T0): T0

val trustStore: Option[SslStoreConfig]

val trustStorePassword: Option[String]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped