org.eclipse.jetty.server
Class Server

java.lang.Object
  extended by org.eclipse.jetty.util.component.AbstractLifeCycle
      extended by org.eclipse.jetty.server.handler.AbstractHandler
          extended by org.eclipse.jetty.server.handler.AbstractHandlerContainer
              extended by org.eclipse.jetty.server.handler.HandlerWrapper
                  extended by org.eclipse.jetty.server.Server
All Implemented Interfaces:
Handler, HandlerContainer, Attributes, LifeCycle

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
static interface Server.Graceful
           
 
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
_listeners, FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING
 
Constructor Summary
Server()
           
Server(int port)
          Convenience constructor Creates server and a SocketConnector at the passed port.
 
Method Summary
 void addBean(Object o)
          Add an associated bean.
 void addConnector(Connector connector)
           
 void addLifeCycle(LifeCycle c)
          Deprecated. Use #addBean(LifeCycle)
 void clearAttributes()
           
protected  void doStart()
           
protected  void doStop()
           
 Object getAttribute(String name)
           
 Enumeration getAttributeNames()
           
<T> List<T>
getBeans(Class<T> clazz)
          Get dependent beans of a specific class
 Connector[] getConnectors()
           
 Container getContainer()
           
 int getGracefulShutdown()
           
 boolean getSendDateHeader()
           
 boolean getSendServerVersion()
           
 SessionIdManager getSessionIdManager()
           
 boolean getStopAtShutdown()
           
 ThreadPool getThreadPool()
           
static String getVersion()
           
 void handle(HttpConnection connection)
           
 void handleAsync(HttpConnection connection)
           
 void join()
           
static void main(String[] args)
           
 void removeAttribute(String name)
           
 void removeBean(Object o)
          Remove an associated bean.
 void removeConnector(Connector connector)
          Conveniance method which calls getConnectors() and setConnectors(Connector[]) to remove a connector.
 void removeLifeCycle(LifeCycle c)
          Deprecated. Use removeBean(Object)
 void setAttribute(String name, Object attribute)
           
 void setConnectors(Connector[] connectors)
          Set the connectors for this server.
 void setGracefulShutdown(int timeoutMS)
          Set graceful shutdown timeout.
 void setSendDateHeader(boolean sendDateHeader)
           
 void setSendServerVersion(boolean sendServerVersion)
           
 void setSessionIdManager(SessionIdManager sessionIdManager)
           
 void setStopAtShutdown(boolean stop)
           
 void setThreadPool(ThreadPool threadPool)
           
 String toString()
           
 
Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper
expandChildren, getHandler, getHandlers, handle, setHandler, setServer
 
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer
dump, expandHandler, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass
 
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler
destroy, dump, getServer
 
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, 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.LifeCycle
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
 

Constructor Detail

Server

public Server()

Server

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

Method Detail

getVersion

public static String getVersion()

getContainer

public Container getContainer()
Returns:
Returns the container.

getStopAtShutdown

public boolean getStopAtShutdown()

setStopAtShutdown

public void setStopAtShutdown(boolean stop)

getConnectors

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

addConnector

public void addConnector(Connector connector)

removeConnector

public void removeConnector(Connector connector)
Conveniance 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.

getThreadPool

public ThreadPool getThreadPool()
Returns:
Returns the threadPool.

setThreadPool

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

doStart

protected void doStart()
                throws Exception
Overrides:
doStart in class HandlerWrapper
Throws:
Exception

doStop

protected void doStop()
               throws Exception
Overrides:
doStop in class HandlerWrapper
Throws:
Exception

handle

public void handle(HttpConnection connection)
            throws IOException,
                   ServletException
Throws:
IOException
ServletException

handleAsync

public void handleAsync(HttpConnection connection)
                 throws IOException,
                        ServletException
Throws:
IOException
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.

setSendServerVersion

public void setSendServerVersion(boolean sendServerVersion)

getSendServerVersion

public boolean getSendServerVersion()

setSendDateHeader

public void setSendDateHeader(boolean sendDateHeader)
Parameters:
sendDateHeader -

getSendDateHeader

public boolean getSendDateHeader()

addLifeCycle

public void addLifeCycle(LifeCycle c)
Deprecated. Use #addBean(LifeCycle)

Add a LifeCycle object to be started/stopped along with the Server.

Parameters:
c -

addBean

public void addBean(Object o)
Add an associated bean. The bean will be added to the servers Container and if it is a LifeCycle instance, it will be started/stopped along with the Server.

Parameters:
c -

getBeans

public <T> List<T> getBeans(Class<T> clazz)
Get dependent beans of a specific class

Parameters:
clazz -
Returns:
List of beans.
See Also:
addBean(Object)

removeLifeCycle

public void removeLifeCycle(LifeCycle c)
Deprecated. Use removeBean(Object)

Remove a LifeCycle object to be started/stopped along with the Server


removeBean

public void removeBean(Object o)
Remove an associated bean.


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 getAttributeNames()
Specified by:
getAttributeNames 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

getGracefulShutdown

public int getGracefulShutdown()
Returns:
the graceful

setGracefulShutdown

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 Server.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 - the milliseconds to wait for existing request to complete before stopping the server.

toString

public String toString()
Overrides:
toString in class AbstractHandler

main

public static void main(String[] args)


Copyright © 1995-2009 Mort Bay Consulting. All Rights Reserved.