org.eclipse.jetty.osgi.equinoxtools.console

Class EquinoxConsoleWebSocketServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.websocket.WebSocketServlet

org.eclipse.jetty.osgi.equinoxtools.console.EquinoxConsoleWebSocketServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig, WebConsoleWriterOutputStream.OnFlushListener, WebSocketFactory.Acceptor

public class EquinoxConsoleWebSocketServlet
extends WebSocketServlet
implements WebConsoleWriterOutputStream.OnFlushListener

Websocket version of the Chat with equinox. Ported from jetty's example 'WebSocketChatServlet'

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EquinoxConsoleWebSocketServlet()
EquinoxConsoleWebSocketServlet(WebConsoleSession consoleSession, EquinoxChattingSupport support)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
protected void	doGet(HttpServletRequest request, HttpServletResponse response)
WebSocket	doWebSocketConnect(HttpServletRequest request, String protocol) Factory method that applications needs to implement to return a WebSocket object.
void	init()
void	onFlush() Called right after the flush method on the output stream has been executed.

Methods inherited from class org.eclipse.jetty.websocket.WebSocketServlet

checkOrigin, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

EquinoxConsoleWebSocketServlet

public EquinoxConsoleWebSocketServlet()

EquinoxConsoleWebSocketServlet

public EquinoxConsoleWebSocketServlet(WebConsoleSession consoleSession,
                              EquinoxChattingSupport support)

Method Detail

init

public void init()
          throws ServletException

Overrides:

init in class WebSocketServlet

Throws:

ServletException

See Also:

GenericServlet.init()

destroy

public void destroy()

Specified by:

destroy in interface Servlet

Overrides:

destroy in class WebSocketServlet

doGet

protected void doGet(HttpServletRequest request,
         HttpServletResponse response)
              throws ServletException,
                     IOException

Overrides:

doGet in class HttpServlet

Throws:

ServletException

IOException

doWebSocketConnect

public WebSocket doWebSocketConnect(HttpServletRequest request,
                           String protocol)

Description copied from interface: WebSocketFactory.Acceptor

Factory method that applications needs to implement to return a WebSocket object.

Specified by:

doWebSocketConnect in interface WebSocketFactory.Acceptor

Parameters:

request - the incoming HTTP upgrade request

protocol - the websocket sub protocol

Returns:

a new WebSocket object that will handle websocket events.

onFlush

public void onFlush()

Called right after the flush method on the output stream has been executed.

Specified by:

onFlush in interface WebConsoleWriterOutputStream.OnFlushListener