Modifier and Type	Class and Description
public static interface	Server.Graceful
private static class	Server.ShutdownHookThread ShutdownHook thread for stopping all servers.

Modifier and Type	Field and Description
private AttributesMap	_attributes
private Connector[]	_connectors
private Container	_container
private List<E>	_dependentLifeCycles
private int	_graceful
private UserRealm[]	_realms
private boolean	_sendDateHeader
private boolean	_sendServerVersion
private SessionIdManager	_sessionIdManager
private ThreadPool	_threadPool
private static String	_version
private static Server.ShutdownHookThread	hookThread

Access	Constructor and Description
public	Server()
public	Server(int port) Convenience constructor Creates server and a `SocketConnector` at the passed port.

Method Summary

Modifier and Type	Method and Description
public void	addConnector(Connector connector)
public void	addHandler(Handler handler) Overrides org.mortbay.jetty.handler.HandlerWrapper.addHandler. Implements org.mortbay.jetty.HandlerContainer.addHandler. Add a handler.
public void	addLifeCycle(LifeCycle c) Add a LifeCycle object to be started/stopped along with the Server.
public void	addUserRealm(UserRealm realm)
public void	clearAttributes() Implements org.mortbay.util.Attributes.clearAttributes.
protected void	doStart() Overrides org.mortbay.jetty.handler.HandlerWrapper.doStart.
protected void	doStop() Overrides org.mortbay.jetty.handler.HandlerWrapper.doStop.
public Object	getAttribute(String name) Implements org.mortbay.util.Attributes.getAttribute.
public Enumeration<E>	getAttributeNames() Implements org.mortbay.util.Attributes.getAttributeNames.
public Connector[]	Returns: Returns the connectors. getConnectors()
public Container	Returns: Returns the container. getContainer()
public int	Returns: the graceful getGracefulShutdown()
public Handler[]	getHandlers()
public boolean	getSendDateHeader()
public boolean	getSendServerVersion()
public SessionIdManager	Returns: Returns the sessionIdManager. getSessionIdManager()
public boolean	getStopAtShutdown()
public ThreadPool	Returns: Returns the threadPool. getThreadPool()
public UserRealm[]	Returns: Map of realm name to UserRealm instances. getUserRealms()
public static String	getVersion()
public void	handle(HttpConnection connection)
public void	join()
public void	removeAttribute(String name) Implements org.mortbay.util.Attributes.removeAttribute.
public void	removeConnector(Connector The connector to remove. connector) Conveniance method which calls `getConnectors()` and `setConnectors(Connector[])` to remove a connector.
public void	removeHandler(Handler handler) Overrides org.mortbay.jetty.handler.HandlerWrapper.removeHandler. Implements org.mortbay.jetty.HandlerContainer.removeHandler.
public void	removeLifeCycle(LifeCycle c) Remove a LifeCycle object to be started/stopped along with the Server
public void	removeUserRealm(UserRealm realm)
public void	setAttribute(String name, Object attribute) Implements org.mortbay.util.Attributes.setAttribute.
public void	setConnectors(Connector[] The connectors to set. connectors) Set the connectors for this server.
public void	setGracefulShutdown(int the milliseconds to wait for existing request to complete before stopping the server. timeoutMS) Set graceful shutdown timeout.
public void	setHandlers(Handler[] handlers)
public void	setSendDateHeader(boolean sendDateHeader)
public void	setSendServerVersion(boolean sendServerVersion)
public void	setSessionIdManager(SessionIdManager The sessionIdManager to set. sessionIdManager)
public void	setStopAtShutdown(boolean stop)
public void	setThreadPool(ThreadPool The threadPool to set. threadPool)
public void	setUserRealms(UserRealm[] Map of realm name to UserRealm instances. realms)
public String	toString() Overrides org.mortbay.jetty.handler.AbstractHandler.toString. Returns a string representation of the object.

Inherited from org.mortbay.jetty.handler.HandlerWrapper:: expandChildren getHandler handle setHandler setServer

Field Detail

_attributes	back to summary
private AttributesMap _attributes

_connectors	back to summary
private Connector[] _connectors

_container	back to summary
private Container _container

_dependentLifeCycles	back to summary
private List<E> _dependentLifeCycles

_graceful	back to summary
private int _graceful

_realms	back to summary
private UserRealm[] _realms

_sendDateHeader	back to summary
private boolean _sendDateHeader

_sendServerVersion	back to summary
private boolean _sendServerVersion

_sessionIdManager	back to summary
private SessionIdManager _sessionIdManager

_threadPool	back to summary
private ThreadPool _threadPool

_version	back to summary
private static String _version

hookThread	back to summary
private static Server.ShutdownHookThread hookThread

Constructor Detail

Server	back to summary
public Server()

Server	back to summary
public Server(int port) Convenience constructor Creates server and a `SocketConnector` at the passed port.

Method Detail

addConnector	back to summary
public void addConnector(Connector connector)

addHandler	back to summary
public void addHandler(Handler handler) Overrides org.mortbay.jetty.handler.HandlerWrapper.addHandler. Implements org.mortbay.jetty.HandlerContainer.addHandler. Doc from org.mortbay.jetty.handler.HandlerWrapper.addHandler. Add a handler. This implementation of addHandler calls setHandler with the passed handler. If this HandlerWrapper had a previous wrapped handler, then it is passed to a call to addHandler on the passed handler. Thus this call can add a handler in a chain of wrapped handlers.

addHandler

back to summary

public void addHandler(Handler handler)

Overrides org.mortbay.jetty.handler.HandlerWrapper.addHandler.

Implements org.mortbay.jetty.HandlerContainer.addHandler.

Doc from org.mortbay.jetty.handler.HandlerWrapper.addHandler.

Add a handler. This implementation of addHandler calls setHandler with the passed handler. If this HandlerWrapper had a previous wrapped handler, then it is passed to a call to addHandler on the passed handler. Thus this call can add a handler in a chain of wrapped handlers.

addLifeCycle	back to summary
public void addLifeCycle(LifeCycle c) Add a LifeCycle object to be started/stopped along with the Server.

addUserRealm	back to summary
public void addUserRealm(UserRealm realm)

clearAttributes	back to summary
public void clearAttributes() Implements org.mortbay.util.Attributes.clearAttributes.

doStart	back to summary
protected void doStart() throws Exception Overrides org.mortbay.jetty.handler.HandlerWrapper.doStart.

doStop	back to summary
protected void doStop() throws Exception Overrides org.mortbay.jetty.handler.HandlerWrapper.doStop.

getAttribute	back to summary
public Object getAttribute(String name) Implements org.mortbay.util.Attributes.getAttribute.

getAttributeNames	back to summary
public Enumeration<E> getAttributeNames() Implements org.mortbay.util.Attributes.getAttributeNames.

getConnectors	back to summary
public Connector[] getConnectors() Returns:Connector[] Returns the connectors.

getContainer	back to summary
public Container getContainer() Returns:Container Returns the container.

getGracefulShutdown	back to summary
public int getGracefulShutdown() Returns:int the graceful

getHandlers	back to summary
public Handler[] getHandlers()

getSendDateHeader	back to summary
public boolean getSendDateHeader()

getSendServerVersion	back to summary
public boolean getSendServerVersion()

getSessionIdManager	back to summary
public SessionIdManager getSessionIdManager() Returns:SessionIdManager Returns the sessionIdManager.

getStopAtShutdown	back to summary
public boolean getStopAtShutdown()

getThreadPool	back to summary
public ThreadPool getThreadPool() Returns:ThreadPool Returns the threadPool.

getUserRealms	back to summary
public UserRealm[] getUserRealms() Returns:UserRealm[] Map of realm name to UserRealm instances.

getVersion	back to summary
public static String getVersion()

handle	back to summary
public void handle(HttpConnection connection) throws IOException, ServletException

join	back to summary
public void join() throws InterruptedException

removeAttribute	back to summary
public void removeAttribute(String name) Implements org.mortbay.util.Attributes.removeAttribute.

removeConnector back to summary

removeConnector	back to summary
public void removeConnector(Connector connector) Conveniance method which calls `getConnectors()` and `setConnectors(Connector[])` to remove a connector. Parameters connector:Connector The connector to remove.

public void removeConnector(Connector connector)

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

Parameters

connector:Connector: The connector to remove.

removeHandler	back to summary
public void removeHandler(Handler handler) Overrides org.mortbay.jetty.handler.HandlerWrapper.removeHandler. Implements org.mortbay.jetty.HandlerContainer.removeHandler.

removeHandler

back to summary

public void removeHandler(Handler handler)

Overrides org.mortbay.jetty.handler.HandlerWrapper.removeHandler.

Implements org.mortbay.jetty.HandlerContainer.removeHandler.

removeLifeCycle	back to summary
public void removeLifeCycle(LifeCycle c) Remove a LifeCycle object to be started/stopped along with the Server

removeUserRealm	back to summary
public void removeUserRealm(UserRealm realm)

setAttribute	back to summary
public void setAttribute(String name, Object attribute) Implements org.mortbay.util.Attributes.setAttribute.

setConnectors	back to summary
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:Connector[] The connectors to set.

setConnectors

back to summary

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:Connector[]: The connectors to set.

setGracefulShutdown back to summary

setGracefulShutdown	back to summary
public void setGracefulShutdown(int timeoutMS) Set graceful shutdown timeout. If set, the `doStop()` method will not immediately stop the server. Instead, all `Connector`s will be closed so that new connections will not be accepted and all handlers that implement `Graceful` will be put into the shutdown mode so that no new requests will be accepted, but existing requests can complete. The server will then wait the configured timeout before stopping. Parameters timeoutMS:int the milliseconds to wait for existing request to complete before stopping the server.

public void setGracefulShutdown(int timeoutMS)

Set graceful shutdown timeout. If set, the doStop() method will not immediately stop the server. Instead, all Connectors will be closed so that new connections will not be accepted and all handlers that implement Graceful will be put into the shutdown mode so that no new requests will be accepted, but existing requests can complete. The server will then wait the configured timeout before stopping.

Parameters

timeoutMS:int: the milliseconds to wait for existing request to complete before stopping the server.

setHandlers	back to summary
public void setHandlers(Handler[] handlers)

setSendDateHeader	back to summary
public void setSendDateHeader(boolean sendDateHeader)

setSendServerVersion	back to summary
public void setSendServerVersion(boolean sendServerVersion)

setSessionIdManager	back to summary
public void setSessionIdManager(SessionIdManager sessionIdManager) Parameters sessionIdManager:SessionIdManager The sessionIdManager to set.

setStopAtShutdown	back to summary
public void setStopAtShutdown(boolean stop)

setThreadPool	back to summary
public void setThreadPool(ThreadPool threadPool) Parameters threadPool:ThreadPool The threadPool to set.

setUserRealms	back to summary
public void setUserRealms(UserRealm[] realms) Parameters realms:UserRealm[] Map of realm name to UserRealm instances.

toString

back to summary

public String toString()

Overrides org.mortbay.jetty.handler.AbstractHandler.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

org.mortbay.jetty back to summary

public Interface Server.Graceful

Known Direct Implementers: org.mortbay.jetty.handler.ContextHandler

Method Summary

Modifier and Type	Method and Description
public void	setShutdown(boolean shutdown)

Method Detail

setShutdown	back to summary
public void setShutdown(boolean shutdown)

org.mortbay.jetty back to summary

private Class Server.ShutdownHookThread

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
org.mortbay.jetty.Server.ShutdownHookThread

ShutdownHook thread for stopping all servers. Thread is hooked first time list of servers is changed.

Field Summary

Modifier and Type	Field and Description
private boolean	hooked
private ArrayList<E>	servers

Inherited from java.lang.Thread:: MAX_PRIORITY MIN_PRIORITY NORM_PRIORITY

Constructor Summary

Access	Constructor and Description
private	ShutdownHookThread()

Method Summary

Modifier and Type	Method and Description
public boolean	add(Server server) Add Server to servers list.
public boolean	addAll(Collection<E> c) Append all Servers from Collection
public void	clear() Clear list of Servers.
public boolean	contains(Server server) Contains Server in servers list?
private void	createShutdownHook() Hooks this thread for shutdown.
public boolean	remove(Server server) Remove Server from list.
public boolean	removeAll(Collection<E> c) Remove all Servers in Collection from list.
public void	run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. Stop all Servers in list.

Field Detail

hooked	back to summary
private boolean hooked

servers	back to summary
private ArrayList<E> servers

Constructor Detail

ShutdownHookThread	back to summary
private ShutdownHookThread()

Method Detail

add	back to summary
public boolean add(Server server) Add Server to servers list.

addAll	back to summary
public boolean addAll(Collection<E> c) Append all Servers from Collection

clear	back to summary
public void clear() Clear list of Servers.

contains	back to summary
public boolean contains(Server server) Contains Server in servers list?

createShutdownHook back to summary

private void createShutdownHook()

Hooks this thread for shutdown.

See Also: java.lang.Runtime#addShutdownHook(java.lang.Thread)

remove	back to summary
public boolean remove(Server server) Remove Server from list.

removeAll	back to summary
public boolean removeAll(Collection<E> c) Remove all Servers in Collection from list.

run

back to summary

public void run()

Overrides java.lang.Thread.run.

Implements java.lang.Runnable.run.

Stop all Servers in list.

public Class Server

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Server.Graceful

Method Summary

Method Detail

private Class Server.ShutdownHookThread

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail