Package com.blackrook.small.jetty

Class DefaultSmallJettyConfiguration

java.lang.Object

com.blackrook.small.jetty.DefaultSmallJettyConfiguration

All Implemented Interfaces:

SmallJettyConfiguration, com.blackrook.small.SmallConfiguration

public class DefaultSmallJettyConfiguration
extends Object
implements SmallJettyConfiguration

Configuration builder for the Jetty bootstrap.

Defaults:

• serverPort: 8080
• secureServerPort: null
• contextPath: "/"
• tempPath: null
• servletPaths: ["/*"]
• applicationPackageRoots: [ ]
• allowOptions: false
• allowTrace: false
• allowWebSockets: true
• autoParseMultipart: true
• attributes: NONE
• maxThreads: 20
• idleConnectionTimeout: 30000
• headerCacheSize: 8192
• outputBufferSize: 32768
• requestHeaderSize: 8192
• responseHeaderSize: 8192
• sendServerVersion: false
• sendDateHeader: false
• sendXPoweredBy: false
• servletContextOptions: 0
• sslConfiguration: null
• gzipConfiguration: null

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultSmallJettyConfiguration.GZipConfigurationBuilder
static class	DefaultSmallJettyConfiguration.SSLConfigurationBuilder

Nested classes/interfaces inherited from interface com.blackrook.small.jetty.SmallJettyConfiguration

SmallJettyConfiguration.GZipConfiguration, SmallJettyConfiguration.SSLConfiguration

Method Summary

Modifier and Type	Method	Description
boolean	allowOptions()
boolean	allowTrace()
boolean	allowWebSockets()
boolean	autoParseMultipart()
static DefaultSmallJettyConfiguration	configure()
String[]	getApplicationPackageRoots()
<T> T	getAttribute(String attributeName, T def)
String	getContextPath()
SmallJettyConfiguration.GZipConfiguration	getGZipCompression()
int	getHeaderCacheSize()
int	getIdleConnectionTimeout()
int	getMaxThreads()
int	getOutputBufferSize()
int	getRequestHeaderSize()
int	getResponseHeaderSize()
Integer	getSecureServerPort()
boolean	getSendDateHeader()
boolean	getSendServerVersion()
boolean	getSendXPoweredBy()
int	getServerPort()
int	getServletContextOptions()
String[]	getServletPaths()
SmallJettyConfiguration.SSLConfiguration	getSSLConfiguration()
String	getTempPath()
DefaultSmallJettyConfiguration	setAllowOptions(boolean value)
DefaultSmallJettyConfiguration	setAllowTrace(boolean value)
DefaultSmallJettyConfiguration	setAllowWebSockets(boolean value)
DefaultSmallJettyConfiguration	setApplicationPackageRoots(String... value)
DefaultSmallJettyConfiguration	setAttribute(String attributeName, Object value)
DefaultSmallJettyConfiguration	setAutoParseMultipart(boolean value)
DefaultSmallJettyConfiguration	setContextPath(String value)
DefaultSmallJettyConfiguration	setGZip(SmallJettyConfiguration.GZipConfiguration gzip)	Sets the GZip handler configuration for this application.
DefaultSmallJettyConfiguration	setHeaderCacheSize(int value)
DefaultSmallJettyConfiguration	setIdleConnectionTimeout(int value)
DefaultSmallJettyConfiguration	setMaxThreads(int value)
DefaultSmallJettyConfiguration	setOutputBufferSize(int value)
DefaultSmallJettyConfiguration	setRequestHeaderSize(int value)
DefaultSmallJettyConfiguration	setResponseHeaderSize(int value)
DefaultSmallJettyConfiguration	setSecureServerPort(Integer value)
DefaultSmallJettyConfiguration	setSendDateHeader(boolean value)
DefaultSmallJettyConfiguration	setSendServerVersion(boolean value)
DefaultSmallJettyConfiguration	setSendXPoweredBy(boolean value)
DefaultSmallJettyConfiguration	setServerPort(int value)
DefaultSmallJettyConfiguration	setServletPaths(String... value)
DefaultSmallJettyConfiguration	setTempPath(String value)
DefaultSmallJettyConfiguration	useSSL(int port, String keyStorePath, String keyStorePassword)	Sets the HTTPS port and the keystore/truststore file and password.
DefaultSmallJettyConfiguration	useSSL(int port, String keyStoreType, String keyStorePath, String keyStorePassword)	Sets the HTTPS port and the keystore/truststore file and password.
DefaultSmallJettyConfiguration	useSSL(int port, String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword)	Sets the HTTPS port and the keystore/truststore file and password.
DefaultSmallJettyConfiguration	useSSL(int port, String keyStoreType, String keyStorePath, String keyStorePassword, String trustStoreType, String trustStorePath, String trustStorePassword)	Sets the HTTPS port and the keystore/truststore file and password.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.blackrook.small.SmallConfiguration

getAttribute

Method Details

configure

public static DefaultSmallJettyConfiguration configure()

Returns:

a new configuration builder.

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface com.blackrook.small.SmallConfiguration

getSecureServerPort

public Integer getSecureServerPort()

Specified by:

getSecureServerPort in interface com.blackrook.small.SmallConfiguration

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface com.blackrook.small.SmallConfiguration

getTempPath

public String getTempPath()

Specified by:

getTempPath in interface com.blackrook.small.SmallConfiguration

getServletPaths

public String[] getServletPaths()

Specified by:

getServletPaths in interface com.blackrook.small.SmallConfiguration

getApplicationPackageRoots

public String[] getApplicationPackageRoots()

Specified by:

getApplicationPackageRoots in interface com.blackrook.small.SmallConfiguration

allowOptions

public boolean allowOptions()

Specified by:

allowOptions in interface com.blackrook.small.SmallConfiguration

allowTrace

public boolean allowTrace()

Specified by:

allowTrace in interface com.blackrook.small.SmallConfiguration

allowWebSockets

public boolean allowWebSockets()

Specified by:

allowWebSockets in interface com.blackrook.small.SmallConfiguration

autoParseMultipart

public boolean autoParseMultipart()

Specified by:

autoParseMultipart in interface com.blackrook.small.SmallConfiguration

getMaxThreads

public int getMaxThreads()

Specified by:

getMaxThreads in interface SmallJettyConfiguration

Returns:

the maximum amount of connector threads.

getIdleConnectionTimeout

public int getIdleConnectionTimeout()

Specified by:

getIdleConnectionTimeout in interface SmallJettyConfiguration

Returns:

the amount of time in milliseconds before an open HTTP connection times out.

getHeaderCacheSize

public int getHeaderCacheSize()

Specified by:

getHeaderCacheSize in interface SmallJettyConfiguration

Returns:

the header cache size in bytes.

getOutputBufferSize

public int getOutputBufferSize()

Specified by:

getOutputBufferSize in interface SmallJettyConfiguration

Returns:

the output buffer cache size in bytes.

getRequestHeaderSize

public int getRequestHeaderSize()

Specified by:

getRequestHeaderSize in interface SmallJettyConfiguration

Returns:

the request header cache size in bytes.

getResponseHeaderSize

public int getResponseHeaderSize()

Specified by:

getResponseHeaderSize in interface SmallJettyConfiguration

Returns:

the response header cache size in bytes.

getSendServerVersion

public boolean getSendServerVersion()

Specified by:

getSendServerVersion in interface SmallJettyConfiguration

Returns:

true if the server version should be sent in headers/default pages, false if not.

getSendDateHeader

public boolean getSendDateHeader()

Specified by:

getSendDateHeader in interface SmallJettyConfiguration

Returns:

true if the server date should be sent in headers/default pages, false if not.

getSendXPoweredBy

public boolean getSendXPoweredBy()

Specified by:

getSendXPoweredBy in interface SmallJettyConfiguration

Returns:

true if the server name should be sent in headers/default pages, false if not.

getServletContextOptions

public int getServletContextOptions()

Specified by:

getServletContextOptions in interface SmallJettyConfiguration

Returns:

the Jetty options to pass to the servlet context handler.

See Also:

ServletContextHandler.SESSIONS, ServletContextHandler.SECURITY, ServletContextHandler.GZIP

getSSLConfiguration

public SmallJettyConfiguration.SSLConfiguration getSSLConfiguration()

Specified by:

getSSLConfiguration in interface SmallJettyConfiguration

Returns:

the SSL configuration to use for SSL, or null for no secure socket setup.

getGZipCompression

public SmallJettyConfiguration.GZipConfiguration getGZipCompression()

Specified by:

getGZipCompression in interface SmallJettyConfiguration

Returns:

the GZip configuration to use, or null for no compression scheme.

getAttribute

public <T> T getAttribute(String attributeName, T def)

Specified by:

getAttribute in interface com.blackrook.small.SmallConfiguration

setServerPort

public DefaultSmallJettyConfiguration setServerPort(int value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getServerPort()

setSecureServerPort

public DefaultSmallJettyConfiguration setSecureServerPort(Integer value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getSecureServerPort()

setContextPath

public DefaultSmallJettyConfiguration setContextPath(String value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getContextPath()

setTempPath

public DefaultSmallJettyConfiguration setTempPath(String value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getTempPath()

setServletPaths

public DefaultSmallJettyConfiguration setServletPaths(String... value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getServletPaths()

setApplicationPackageRoots

public DefaultSmallJettyConfiguration setApplicationPackageRoots(String... value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getApplicationPackageRoots()

setAllowOptions

public DefaultSmallJettyConfiguration setAllowOptions(boolean value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

allowOptions()

setAllowTrace

public DefaultSmallJettyConfiguration setAllowTrace(boolean value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

allowTrace()

setAllowWebSockets

public DefaultSmallJettyConfiguration setAllowWebSockets(boolean value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

allowWebSockets()

setAutoParseMultipart

public DefaultSmallJettyConfiguration setAutoParseMultipart(boolean value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

autoParseMultipart()

setMaxThreads

public DefaultSmallJettyConfiguration setMaxThreads(int value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getMaxThreads()

setIdleConnectionTimeout

public DefaultSmallJettyConfiguration setIdleConnectionTimeout(int value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getIdleConnectionTimeout()

setHeaderCacheSize

public DefaultSmallJettyConfiguration setHeaderCacheSize(int value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getHeaderCacheSize()

setOutputBufferSize

public DefaultSmallJettyConfiguration setOutputBufferSize(int value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getOutputBufferSize()

setRequestHeaderSize

public DefaultSmallJettyConfiguration setRequestHeaderSize(int value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getRequestHeaderSize()

setResponseHeaderSize

public DefaultSmallJettyConfiguration setResponseHeaderSize(int value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getResponseHeaderSize()

setSendServerVersion

public DefaultSmallJettyConfiguration setSendServerVersion(boolean value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getSendServerVersion()

setSendDateHeader

public DefaultSmallJettyConfiguration setSendDateHeader(boolean value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getSendDateHeader()

setSendXPoweredBy

public DefaultSmallJettyConfiguration setSendXPoweredBy(boolean value)

Parameters:

value - the value to set.

Returns:

this builder, for chaining.

See Also:

getSendXPoweredBy()

setAttribute

public DefaultSmallJettyConfiguration setAttribute(String attributeName, Object value)

Parameters:

attributeName - the attribute name.

value - the value to set.

Returns:

this builder, for chaining.

See Also:

SmallConfiguration.getAttribute(String), getAttribute(String, Object)

useSSL

public DefaultSmallJettyConfiguration useSSL(int port, String keyStorePath, String keyStorePassword)

Sets the HTTPS port and the keystore/truststore file and password. Assumes that the store is in JKS format.

Parameters:

port - the secure HTTP server port.

keyStorePath - the keystore/truststore path.

keyStorePassword - the keystore/truststore password.

Returns:

this builder, for chaining.

See Also:

setSecureServerPort(Integer)

useSSL

public DefaultSmallJettyConfiguration useSSL(int port, String keyStoreType, String keyStorePath, String keyStorePassword)

Sets the HTTPS port and the keystore/truststore file and password.

Parameters:

port - the secure HTTP server port.

keyStoreType - the keystore/truststore type.

keyStorePath - the keystore/truststore path.

keyStorePassword - the keystore/truststore password.

Returns:

this builder, for chaining.

See Also:

setSecureServerPort(Integer)

useSSL

public DefaultSmallJettyConfiguration useSSL(int port, String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword)

Sets the HTTPS port and the keystore/truststore file and password.

Parameters:

port - the secure HTTP server port.

keyStorePath - the keystore path.

keyStorePassword - the keystore password.

trustStorePath - the truststore path.

trustStorePassword - the truststore password.

Returns:

this builder, for chaining.

See Also:

setSecureServerPort(Integer)

useSSL

public DefaultSmallJettyConfiguration useSSL(int port, String keyStoreType, String keyStorePath, String keyStorePassword, String trustStoreType, String trustStorePath, String trustStorePassword)

Sets the HTTPS port and the keystore/truststore file and password.

Parameters:

port - the secure HTTP server port.

keyStoreType - the keystore type.

keyStorePath - the keystore path.

keyStorePassword - the keystore password.

trustStoreType - the truststore type.

trustStorePath - the truststore path.

trustStorePassword - the truststore password.

Returns:

this builder, for chaining.

See Also:

setSecureServerPort(Integer)

setGZip

public DefaultSmallJettyConfiguration setGZip(SmallJettyConfiguration.GZipConfiguration gzip)

Sets the GZip handler configuration for this application.

Parameters:

gzip - the GZip configuration.

Returns:

this builder, for chaining.