Package org.eclipse.jetty.server
Class 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 ClassesNested 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
FieldsModifier and TypeFieldDescriptionprivate final AttributeContainerMap
private Server.DateField
private final Locker
private boolean
private boolean
private ErrorHandler
private RequestLog
private SessionIdManager
private boolean
private final ThreadPool
private static final Logger
Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper
_handler
-
Constructor Summary
ConstructorsConstructorDescriptionServer()
Server
(int port) Convenience constructor Creates server and aServerConnector
at the passed port.Server
(InetSocketAddress addr) Convenience constructorServer
(ThreadPool pool) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addBeanToAllConnectors
(Object bean) Add a bean to all connectors on the server.void
addConnector
(Connector connector) void
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.getAttribute
(String name) boolean
getURI()
static String
void
handle
(HttpChannel channel) void
handleAsync
(HttpChannel channel) protected void
handleOptions
(Request request, Response response) boolean
boolean
void
join()
static void
void
removeAttribute
(String name) void
removeConnector
(Connector connector) Convenience method which callsgetConnectors()
andsetConnectors(Connector[])
to remove a connector.void
setAttribute
(String name, 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
Starts the given lifecycle.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
-
Field Details
-
LOG
-
_attributes
-
_threadPool
-
_connectors
-
_sessionIdManager
-
_stopAtShutdown
private boolean _stopAtShutdown -
_dumpAfterStart
private boolean _dumpAfterStart -
_dumpBeforeStop
private boolean _dumpBeforeStop -
_errorHandler
-
_requestLog
-
_dateLocker
-
_dateField
-
-
Constructor Details
-
Server
public Server() -
Server
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:
-
Server
Convenience constructorCreates server and a
ServerConnector
at the passed address.- Parameters:
addr
- the inet socket address to create the connector from
-
Server
-
-
Method Details
-
getRequestLog
-
getErrorHandler
-
setRequestLog
-
setErrorHandler
-
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:
-
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:
-
getConnectors
@ManagedAttribute(value="connectors for this server", readonly=true) public Connector[] getConnectors()- Returns:
- Returns the connectors.
-
addConnector
-
removeConnector
Convenience method which callsgetConnectors()
andsetConnectors(Connector[])
to remove a connector.- Parameters:
connector
- The connector to remove.
-
setConnectors
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
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
- Returns:
- Returns the threadPool.
-
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
- 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
-
doStart
Description copied from class:ContainerLifeCycle
Starts the managed lifecycle beans in the order they were added.- Overrides:
doStart
in classAbstractHandler
- Throws:
Exception
-
start
Description copied from class:ContainerLifeCycle
Starts the given lifecycle.- Overrides:
start
in classContainerLifeCycle
- Parameters:
l
- the lifecycle to start- Throws:
Exception
- if unable to start lifecycle
-
doStop
Description copied from class:ContainerLifeCycle
Stops the managed lifecycle beans in the reverse order they were added.- Overrides:
doStop
in classAbstractHandler
- Throws:
Exception
-
handle
- Throws:
IOException
javax.servlet.ServletException
-
handleOptions
- Throws:
IOException
-
handleAsync
- Throws:
IOException
javax.servlet.ServletException
-
join
- Throws:
InterruptedException
-
getSessionIdManager
- Returns:
- Returns the sessionIdManager.
-
setSessionIdManager
- Parameters:
sessionIdManager
- The sessionIdManager to set.
-
clearAttributes
public void clearAttributes()- Specified by:
clearAttributes
in interfaceAttributes
-
getAttribute
- Specified by:
getAttribute
in interfaceAttributes
-
getAttributeNames
- Specified by:
getAttributeNames
in interfaceAttributes
-
getAttributeNameSet
- Specified by:
getAttributeNameSet
in interfaceAttributes
-
removeAttribute
- Specified by:
removeAttribute
in interfaceAttributes
-
setAttribute
- Specified by:
setAttribute
in interfaceAttributes
-
getURI
- Returns:
- The URI of the first
NetworkConnector
and firstContextHandler
, or null
-
toString
- Overrides:
toString
in classAbstractLifeCycle
-
dump
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:
IOException
- if unable to write to Appendable
-
main
- Throws:
Exception
-