Package org.eclipse.jetty.server

Class Server

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.server.Server

All Implemented Interfaces:

Handler, HandlerContainer, Attributes, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

@ManagedObject("Jetty HTTP Servlet server")
public class Server
extends HandlerWrapper
implements Attributes

Jetty HTTP Servlet Server. This class is the main class for the Jetty HTTP Servlet server. It aggregates Connectors (HTTP request receivers) and request Handlers. The server is itself a handler and a ThreadPool. Connectors use the ThreadPool methods to run jobs that will eventually call the handle method.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Attributes

Attributes.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

_handler

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
Server()
Server(int port)	Convenience constructor Creates server and a ServerConnector at the passed port.
Server(InetSocketAddress addr)	Convenience constructor
Server(ThreadPool pool)

Method Summary

Modifier and Type	Method	Description
void	addBeanToAllConnectors(Object bean)	Add a bean to all connectors on the server.
void	addConnector(Connector connector)
void	clearAttributes()
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
protected void	doStop()	Stops the managed lifecycle beans in the reverse order they were added.
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
Set<String>	getAttributeNameSet()
Connector[]	getConnectors()
HttpField	getDateField()
ErrorHandler	getErrorHandler()
RequestLog	getRequestLog()
SessionIdManager	getSessionIdManager()
boolean	getStopAtShutdown()
long	getStopTimeout()
ThreadPool	getThreadPool()
URI	getURI()
static String	getVersion()
void	handle(HttpChannel channel)
void	handleAsync(HttpChannel channel)
protected void	handleOptions(Request request, Response response)
boolean	isDryRun()
boolean	isDumpAfterStart()
boolean	isDumpBeforeStop()
void	join()
static void	main(String... args)
void	removeAttribute(String name)
void	removeConnector(Connector connector)	Convenience method which calls getConnectors() and setConnectors(Connector[]) to remove a connector.
void	setAttribute(String name, Object attribute)
void	setConnectors(Connector[] connectors)	Set the connectors for this server.
void	setDryRun(boolean dryRun)
void	setDumpAfterStart(boolean dumpAfterStart)
void	setDumpBeforeStop(boolean dumpBeforeStop)
void	setErrorHandler(ErrorHandler errorHandler)
void	setRequestLog(RequestLog requestLog)
void	setSessionIdManager(SessionIdManager sessionIdManager)
void	setStopAtShutdown(boolean stop)	Set stop server at shutdown behaviour.
void	setStopTimeout(long stopTimeout)
protected void	start(LifeCycle l)	Starts the given lifecycle.
String	toString()

Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

destroy, expandChildren, getHandler, getHandlers, handle, insertHandler, setHandler

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doError, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Container

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Constructor Details

Server

public Server()

Server

public Server(@Name("port")
 int port)

Convenience constructor Creates server and a ServerConnector at the passed port.

Parameters:

port - The port of a network HTTP connector (or 0 for a randomly allocated port).

See Also:

• NetworkConnector.getLocalPort()

Server

public Server(@Name("address")
 InetSocketAddress addr)

Convenience constructor

Creates server and a ServerConnector at the passed address.

Parameters:

addr - the inet socket address to create the connector from

Server

public Server(@Name("threadpool")
 ThreadPool pool)

Method Details

isDryRun

public boolean isDryRun()

setDryRun

public void setDryRun(boolean dryRun)

getRequestLog

public RequestLog getRequestLog()

getErrorHandler

public ErrorHandler getErrorHandler()

setRequestLog

public void setRequestLog(RequestLog requestLog)

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

getVersion

@ManagedAttribute("version of this server")
public static String getVersion()

setStopTimeout

public void setStopTimeout(long stopTimeout)

getStopTimeout

public long getStopTimeout()

getStopAtShutdown

public boolean getStopAtShutdown()

setStopAtShutdown

public void setStopAtShutdown(boolean stop)

Set stop server at shutdown behaviour.

Parameters:

stop - If true, this server instance will be explicitly stopped when the JVM is shutdown. Otherwise the JVM is stopped with the server running.

See Also:

• Runtime.addShutdownHook(Thread)
• ShutdownThread

getConnectors

@ManagedAttribute(value="connectors for this server",
                  readonly=true)
public Connector[] getConnectors()

Returns:

Returns the connectors.

addConnector

public void addConnector(Connector connector)

removeConnector

public void removeConnector(Connector connector)

Convenience method which calls getConnectors() and setConnectors(Connector[]) to remove a connector.

Parameters:

connector - The connector to remove.

setConnectors

public void setConnectors(Connector[] connectors)

Set the connectors for this server. Each connector has this server set as it's ThreadPool and its Handler.

Parameters:

connectors - The connectors to set.

addBeanToAllConnectors

public void addBeanToAllConnectors(Object bean)

Add a bean to all connectors on the server. If the bean is an instance of Connection.Listener it will also be registered as a listener on all connections accepted by the connectors.

Parameters:

bean - the bean to be added.

getThreadPool

@ManagedAttribute("the server thread pool")
public ThreadPool getThreadPool()

Returns:

Returns the threadPool.

isDumpAfterStart

@ManagedAttribute("dump state to stderr after start")
public boolean isDumpAfterStart()

Returns:

true if ContainerLifeCycle.dumpStdErr() is called after starting

setDumpAfterStart

public void setDumpAfterStart(boolean dumpAfterStart)

Parameters:

dumpAfterStart - true if ContainerLifeCycle.dumpStdErr() is called after starting

isDumpBeforeStop

@ManagedAttribute("dump state to stderr before stop")
public boolean isDumpBeforeStop()

Returns:

true if ContainerLifeCycle.dumpStdErr() is called before stopping

setDumpBeforeStop

public void setDumpBeforeStop(boolean dumpBeforeStop)

Parameters:

dumpBeforeStop - true if ContainerLifeCycle.dumpStdErr() is called before stopping

getDateField

public HttpField getDateField()

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class AbstractHandler

Throws:

AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.

Exception - If there was a problem starting. Will cause a transition to FAILED state

start

protected void start(LifeCycle l)
              throws Exception

Description copied from class: ContainerLifeCycle

Starts the given lifecycle.

Overrides:

start in class ContainerLifeCycle

Parameters:

l - the lifecycle to start

Throws:

Exception - if unable to start lifecycle

doStop

protected void doStop()
               throws Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class AbstractHandler

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state

handle

public void handle(HttpChannel channel)
            throws IOException,
javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

handleOptions

protected void handleOptions(Request request,
 Response response)
                      throws IOException

Throws:

IOException

handleAsync

public void handleAsync(HttpChannel channel)
                 throws IOException,
javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

join

public void join()
          throws InterruptedException

Throws:

InterruptedException

getSessionIdManager

public SessionIdManager getSessionIdManager()

Returns:

Returns the sessionIdManager.

setSessionIdManager

public void setSessionIdManager(SessionIdManager sessionIdManager)

Parameters:

sessionIdManager - The sessionIdManager to set.

clearAttributes

public void clearAttributes()

Specified by:

clearAttributes in interface Attributes

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface Attributes

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface Attributes

getAttributeNameSet

public Set<String> getAttributeNameSet()

Specified by:

getAttributeNameSet in interface Attributes

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface Attributes

setAttribute

public void setAttribute(String name,
 Object attribute)

Specified by:

setAttribute in interface Attributes

getURI

public URI getURI()

Returns:

The URI of the first NetworkConnector and first ContextHandler, or null

toString

public String toString()

Overrides:

toString in class AbstractLifeCycle

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

main

public static void main(String... args)
                 throws Exception

Throws:

Exception