org.atmosphere.websocket.protocol
Class SimpleHttpProtocol

java.lang.Object
  org.atmosphere.websocket.protocol.SimpleHttpProtocol

All Implemented Interfaces:

Serializable, WebSocketProtocol

public class SimpleHttpProtocol
extends Object
implements WebSocketProtocol, Serializable

Like the AsynchronousProcessor class, this class is responsible for dispatching WebSocket messages to the proper WebSocket implementation by wrapping the Websocket message's bytes within an HttpServletRequest.

The content-type is defined using ApplicationConfig.WEBSOCKET_CONTENT_TYPE property The method is defined using ApplicationConfig.WEBSOCKET_METHOD property

Author:

Jeanfrancois Arcand

See Also:

Serialized Form

Constructor Summary

SimpleHttpProtocol()

Method Summary

void	configure(AtmosphereServlet.AtmosphereConfig config) Allow an implementation to query the AtmosphereConfig of init-param, etc.
javax.servlet.http.HttpServletRequest	parseMessage(AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> resource, byte[] d, int offset, int length) Parse the WebSocket message, and delegate the processing to the AtmosphereServlet.cometSupport or to any existing technology.
javax.servlet.http.HttpServletRequest	parseMessage(AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> resource, String d) Parse the WebSocket message, and delegate the processing to the AtmosphereServlet.cometSupport or to any existing technology.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleHttpProtocol

public SimpleHttpProtocol()

Method Detail

configure

public void configure(AtmosphereServlet.AtmosphereConfig config)

Description copied from interface: WebSocketProtocol

Allow an implementation to query the AtmosphereConfig of init-param, etc.

Specified by:

configure in interface WebSocketProtocol

Parameters:

config - AtmosphereServlet.AtmosphereConfig

parseMessage

public javax.servlet.http.HttpServletRequest parseMessage(AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> resource,
                                                          String d)

Description copied from interface: WebSocketProtocol

Parse the WebSocket message, and delegate the processing to the AtmosphereServlet.cometSupport or to any existing technology. Invoking AtmosphereServlet.cometSupport will delegate the request processing to the AtmosphereHandler implementation. Returning null means this implementation will handle itself the processing/dispatching of the WebSocket's request;
As an example, this is how Websocket messages are delegated to the Jersey runtime.

Specified by:

parseMessage in interface WebSocketProtocol

Parameters:

resource - The AtmosphereResource associated with the WebSocket Handshake

d - The Websocket message

parseMessage

public javax.servlet.http.HttpServletRequest parseMessage(AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> resource,
                                                          byte[] d,
                                                          int offset,
                                                          int length)

Description copied from interface: WebSocketProtocol

Parse the WebSocket message, and delegate the processing to the AtmosphereServlet.cometSupport or to any existing technology. Invoking AtmosphereServlet.cometSupport will delegate the request processing to the AtmosphereHandler implementation. Returning null means this implementation will handle itself the processing/dispatching of the WebSocket's request;
As an example, this is how Websocket messages are delegated to the Jersey runtime.

Specified by:

parseMessage in interface WebSocketProtocol

Parameters:

resource - The AtmosphereResource associated with the WebSocket Handshake

d - The Websocket message

offset - offset message index

length - length of the message.