Package org.eclipse.jetty.server
Class Server
- java.lang.Object
-
- 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
-
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
-
-
Constructor Summary
Constructors Constructor Description Server()
Server(int port)
Convenience constructor Creates server and aServerConnector
at the passed port.Server(java.net.InetSocketAddress addr)
Convenience constructorServer(ThreadPool pool)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addBeanToAllConnectors(java.lang.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(java.lang.Appendable out, java.lang.String indent)
Dump this object (and children) into an Appendable using the provided indent after any new lines.java.lang.Object
getAttribute(java.lang.String name)
java.util.Enumeration<java.lang.String>
getAttributeNames()
java.util.Set<java.lang.String>
getAttributeNameSet()
Connector[]
getConnectors()
HttpField
getDateField()
ErrorHandler
getErrorHandler()
RequestLog
getRequestLog()
SessionIdManager
getSessionIdManager()
boolean
getStopAtShutdown()
ThreadPool
getThreadPool()
java.net.URI
getURI()
static java.lang.String
getVersion()
void
handle(HttpChannel channel)
void
handleAsync(HttpChannel channel)
protected void
handleOptions(Request request, Response response)
boolean
isDumpAfterStart()
boolean
isDumpBeforeStop()
void
join()
static void
main(java.lang.String... args)
void
removeAttribute(java.lang.String name)
void
removeConnector(Connector connector)
Convenience method which callsgetConnectors()
andsetConnectors(Connector[])
to remove a connector.void
setAttribute(java.lang.String name, java.lang.Object attribute)
void
setConnectors(Connector[] connectors)
Set the connectors for this server.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)
Set a graceful stop time.protected void
start(LifeCycle l)
Starts the given lifecycle.java.lang.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
doShutdown, 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, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, stop, unmanage, updateBean, updateBean, updateBeans
-
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, 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.Dumpable.DumpableContainer
isDumpable
-
Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
-
-
-
-
Constructor Detail
-
Server
public Server()
-
Server
public Server(@Name("port") int port)
Convenience constructor Creates server and aServerConnector
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") java.net.InetSocketAddress addr)
Convenience constructorCreates 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 Detail
-
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 java.lang.String getVersion()
-
getStopAtShutdown
public boolean getStopAtShutdown()
-
setStopTimeout
public void setStopTimeout(long stopTimeout)
Set a graceful stop time. TheStatisticsHandler
must be configured so that open connections can be tracked for a graceful shutdown.- Overrides:
setStopTimeout
in classContainerLifeCycle
- See Also:
ContainerLifeCycle.setStopTimeout(long)
-
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 callsgetConnectors()
andsetConnectors(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(java.lang.Object bean)
Add a bean to all connectors on the server. If the bean is an instance ofConnection.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 ifContainerLifeCycle.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 ifContainerLifeCycle.dumpStdErr()
is called before stopping
-
getDateField
public HttpField getDateField()
-
doStart
protected void doStart() throws java.lang.Exception
Description copied from class:ContainerLifeCycle
Starts the managed lifecycle beans in the order they were added.- Overrides:
doStart
in classAbstractHandler
- Throws:
java.lang.Exception
-
start
protected void start(LifeCycle l) throws java.lang.Exception
Description copied from class:ContainerLifeCycle
Starts the given lifecycle.- Overrides:
start
in classContainerLifeCycle
- Parameters:
l
- the lifecycle to start- Throws:
java.lang.Exception
- if unable to start lifecycle
-
doStop
protected void doStop() throws java.lang.Exception
Description copied from class:ContainerLifeCycle
Stops the managed lifecycle beans in the reverse order they were added.- Overrides:
doStop
in classAbstractHandler
- Throws:
java.lang.Exception
-
handle
public void handle(HttpChannel channel) throws java.io.IOException, javax.servlet.ServletException
- Throws:
java.io.IOException
javax.servlet.ServletException
-
handleOptions
protected void handleOptions(Request request, Response response) throws java.io.IOException
- Throws:
java.io.IOException
-
handleAsync
public void handleAsync(HttpChannel channel) throws java.io.IOException, javax.servlet.ServletException
- Throws:
java.io.IOException
javax.servlet.ServletException
-
join
public void join() throws java.lang.InterruptedException
- Throws:
java.lang.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 interfaceAttributes
-
getAttribute
public java.lang.Object getAttribute(java.lang.String name)
- Specified by:
getAttribute
in interfaceAttributes
-
getAttributeNames
public java.util.Enumeration<java.lang.String> getAttributeNames()
- Specified by:
getAttributeNames
in interfaceAttributes
-
getAttributeNameSet
public java.util.Set<java.lang.String> getAttributeNameSet()
- Specified by:
getAttributeNameSet
in interfaceAttributes
-
removeAttribute
public void removeAttribute(java.lang.String name)
- Specified by:
removeAttribute
in interfaceAttributes
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.Object attribute)
- Specified by:
setAttribute
in interfaceAttributes
-
getURI
public java.net.URI getURI()
- Returns:
- The URI of the first
NetworkConnector
and firstContextHandler
, or null
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractLifeCycle
-
dump
public void dump(java.lang.Appendable out, java.lang.String indent) throws java.io.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 interfaceDumpable
- Overrides:
dump
in classContainerLifeCycle
- Parameters:
out
- The appendable to dump toindent
- The indent to apply after any new lines.- Throws:
java.io.IOException
- if unable to write to Appendable
-
main
public static void main(java.lang.String... args) throws java.lang.Exception
- Throws:
java.lang.Exception
-
-