io.bootique.jetty.server

Class ServerFactory

java.lang.Object

io.bootique.jetty.server.ServerFactory

public class ServerFactory
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectorFactory	connector Deprecated.
protected List<ConnectorFactory>	connectors
protected String	context
protected Map<String,FilterFactory>	filters
protected int	idleThreadTimeout
protected int	maxQueuedRequests
protected int	maxThreads
protected int	minThreads
protected Map<String,ServletFactory>	servlets
protected boolean	sessions

Constructor Summary

Constructors

Constructor and Description
ServerFactory()

Method Summary

Modifier and Type	Method and Description
protected Collection<ConnectorFactory>	connectorFactories(org.eclipse.jetty.server.Server server)
protected org.eclipse.jetty.server.handler.gzip.GzipHandler	createGzipHandler()
protected org.eclipse.jetty.server.Handler	createHandler(Set<MappedServlet> servlets, Set<MappedFilter> filters, Set<EventListener> listeners)
protected void	createRequestLog(org.eclipse.jetty.server.Server server)
org.eclipse.jetty.server.Server	createServer(Set<MappedServlet> servlets, Set<MappedFilter> filters, Set<EventListener> listeners)
protected org.eclipse.jetty.util.thread.QueuedThreadPool	createThreadPool()
protected org.eclipse.jetty.util.thread.QueuedThreadPool	createThreadPool(BlockingQueue<Runnable> queue)
ConnectorFactory	getConnector() Deprecated. since 0.18 in favor of "connectors" property.
List<ConnectorFactory>	getConnectors()
String	getContext()
protected FilterFactory	getFilterFactory(String name)
int	getIdleThreadTimeout()
int	getMaxQueuedRequests()
int	getMaxThreads()
int	getMinThreads()
Map<String,String>	getParams()
protected ServletFactory	getServletFactory(String name)
io.bootique.resource.FolderResourceFactory	getStaticResourceBase()
protected void	installFilters(org.eclipse.jetty.servlet.ServletContextHandler handler, Set<MappedFilter> filters)
protected void	installListeners(org.eclipse.jetty.servlet.ServletContextHandler handler, Set<EventListener> listeners)
protected void	installServlets(org.eclipse.jetty.servlet.ServletContextHandler handler, Set<MappedServlet> servlets)
boolean	isCompression()
boolean	isSessions()
void	setCompression(boolean compression) Sets whether compression whether gzip compression should be supported.
void	setConnector(ConnectorFactory connector) Deprecated. since 0.18 in favor of "connectors" property.
void	setConnectors(List<ConnectorFactory> connectors) Sets a list of connector factories for this server.
void	setContext(String context)
void	setFilters(Map<String,FilterFactory> filters)
void	setIdleThreadTimeout(int idleThreadTimeout)
void	setMaxQueuedRequests(int maxQueuedRequests)
void	setMaxThreads(int maxConnectorThreads)
void	setMinThreads(int minThreads)
void	setParams(Map<String,String> params)
void	setServlets(Map<String,ServletFactory> servlets)
void	setSessions(boolean sessions)
void	setStaticResourceBase(io.bootique.resource.FolderResourceFactory staticResourceBase) Sets a base location for resources of the Jetty context.

Methods inherited from class java.lang.Object

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

Field Detail

connector

@Deprecated
protected ConnectorFactory connector

Deprecated.

connectors

protected List<ConnectorFactory> connectors

context

protected String context

idleThreadTimeout

protected int idleThreadTimeout

filters

protected Map<String,FilterFactory> filters

maxThreads

protected int maxThreads

minThreads

protected int minThreads

maxQueuedRequests

protected int maxQueuedRequests

servlets

protected Map<String,ServletFactory> servlets

sessions

protected boolean sessions

Constructor Detail

ServerFactory

public ServerFactory()

Method Detail

createServer

public org.eclipse.jetty.server.Server createServer(Set<MappedServlet> servlets,
                                                    Set<MappedFilter> filters,
                                                    Set<EventListener> listeners)

createHandler

protected org.eclipse.jetty.server.Handler createHandler(Set<MappedServlet> servlets,
                                                         Set<MappedFilter> filters,
                                                         Set<EventListener> listeners)

createGzipHandler

protected org.eclipse.jetty.server.handler.gzip.GzipHandler createGzipHandler()

installServlets

protected void installServlets(org.eclipse.jetty.servlet.ServletContextHandler handler,
                               Set<MappedServlet> servlets)

getServletFactory

protected ServletFactory getServletFactory(String name)

installFilters

protected void installFilters(org.eclipse.jetty.servlet.ServletContextHandler handler,
                              Set<MappedFilter> filters)

getFilterFactory

protected FilterFactory getFilterFactory(String name)

installListeners

protected void installListeners(org.eclipse.jetty.servlet.ServletContextHandler handler,
                                Set<EventListener> listeners)

connectorFactories

protected Collection<ConnectorFactory> connectorFactories(org.eclipse.jetty.server.Server server)

createThreadPool

protected org.eclipse.jetty.util.thread.QueuedThreadPool createThreadPool()

createThreadPool

protected org.eclipse.jetty.util.thread.QueuedThreadPool createThreadPool(BlockingQueue<Runnable> queue)

createRequestLog

protected void createRequestLog(org.eclipse.jetty.server.Server server)

getConnectors

public List<ConnectorFactory> getConnectors()

Returns:

a List of server connectors, each listening on its own unique port.

Since:

0.18

setConnectors

public void setConnectors(List<ConnectorFactory> connectors)

Sets a list of connector factories for this server. Each connectors would listen on its own unique port.

Parameters:

connectors - a list of preconfigured connector factories.

Since:

0.18

setServlets

public void setServlets(Map<String,ServletFactory> servlets)

setFilters

public void setFilters(Map<String,FilterFactory> filters)

getConnector

@Deprecated
public ConnectorFactory getConnector()

Deprecated. since 0.18 in favor of "connectors" property.

Returns:

an object containing properties of the web connector and acting as connector factory.

Since:

0.15

setConnector

@Deprecated
public void setConnector(ConnectorFactory connector)

Deprecated. since 0.18 in favor of "connectors" property.

Parameters:

connector - connector factory

getContext

public String getContext()

Returns:

web application context path.

Since:

0.15

setContext

public void setContext(String context)

getIdleThreadTimeout

public int getIdleThreadTimeout()

Returns:

a period in milliseconds specifying how long it takes until an idle thread is terminated.

Since:

0.15

setIdleThreadTimeout

public void setIdleThreadTimeout(int idleThreadTimeout)

getMaxQueuedRequests

public int getMaxQueuedRequests()

Returns:

a maximum number of requests to queue if the thread pool is busy.

Since:

0.15

setMaxQueuedRequests

public void setMaxQueuedRequests(int maxQueuedRequests)

getMaxThreads

public int getMaxThreads()

Returns:

a maximum number of request processing threads in the pool.

Since:

0.15

setMaxThreads

public void setMaxThreads(int maxConnectorThreads)

getMinThreads

public int getMinThreads()

Returns:

an initial number of request processing threads in the pool.

Since:

0.15

setMinThreads

public void setMinThreads(int minThreads)

getParams

public Map<String,String> getParams()

Returns:

a map of arbitrary key/value parameters that are used as "init" parameters of the ServletContext.

Since:

0.15

setParams

public void setParams(Map<String,String> params)

Parameters:

params - a map of context init parameters.

Since:

0.13

isSessions

public boolean isSessions()

Returns:

a boolean specifying whether servlet sessions should be supported by Jetty.

Since:

0.15

setSessions

public void setSessions(boolean sessions)

getStaticResourceBase

public io.bootique.resource.FolderResourceFactory getStaticResourceBase()

Returns:

a base location for resources of the Jetty context.

Since:

0.15

setStaticResourceBase

public void setStaticResourceBase(io.bootique.resource.FolderResourceFactory staticResourceBase)

Sets a base location for resources of the Jetty context. Used by static resource servlets, including the "default" servlet. The value can be a file path or a URL, as well as a special URL starting with "classpath:".

It can be optionally overridden by DefaultServlet configuration.

For security reasons this has to be set explicitly. There's no default.

Parameters:

staticResourceBase - A base location for resources of the Jetty context, that can be a file path or a URL, as well as a special URL starting with "classpath:".

Since:

0.13

See Also:

JettyModuleExtender.useDefaultServlet(), JettyModuleExtender.addStaticServlet(String, String...), DefaultServlet.

isCompression

public boolean isCompression()

Returns:

whether content compression is supported.

Since:

0.15

setCompression

public void setCompression(boolean compression)

Sets whether compression whether gzip compression should be supported. When true, responses will be compressed if a client requests it via "Accept-Encoding:" header. Default is true.

Parameters:

compression - whether gzip compression should be supported.

Since:

0.15