org.cometd.server.transport

Class AbstractHttpTransport

java.lang.Object

org.cometd.common.AbstractTransport

org.cometd.server.AbstractServerTransport

org.cometd.server.transport.AbstractHttpTransport

All Implemented Interfaces:

ServerTransport, Transport

Direct Known Subclasses:

AbstractStreamHttpTransport, AsyncJSONTransport

public abstract class AbstractHttpTransport
extends AbstractServerTransport

HTTP ServerTransport base class, used by ServerTransports that use HTTP as transport or to initiate a transport connection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractHttpTransport.HttpScheduler
protected class	AbstractHttpTransport.LongPollScheduler

Nested classes/interfaces inherited from class org.cometd.server.AbstractServerTransport

AbstractServerTransport.Scheduler

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	_logger
static String	ALLOW_MULTI_SESSIONS_NO_BROWSER_OPTION
static String	AUTOBATCH_OPTION
static String	BROWSER_COOKIE_DOMAIN_OPTION
static String	BROWSER_COOKIE_NAME_OPTION
static String	BROWSER_COOKIE_PATH_OPTION
static String	JSON_DEBUG_OPTION
static String	MAX_SESSIONS_PER_BROWSER_OPTION
static String	MESSAGE_PARAM
static String	MULTI_SESSION_INTERVAL_OPTION
static String	PREFIX

Fields inherited from class org.cometd.server.AbstractServerTransport

INTERVAL_OPTION, JSON_CONTEXT_OPTION, MAX_INTERVAL_OPTION, MAX_LAZY_TIMEOUT_OPTION, MAX_QUEUE_OPTION, META_CONNECT_DELIVERY_OPTION, TIMEOUT_OPTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpTransport(BayeuxServerImpl bayeux, String name)

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	accept(javax.servlet.http.HttpServletRequest request)
protected ServerMessage.Mutable	bayeuxServerHandle(ServerSessionImpl session, ServerMessage.Mutable message)
protected void	decBrowserId(String browserId, ServerSession session)
protected void	error(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.AsyncContext asyncContext, int responseCode)
protected String	findBrowserId(javax.servlet.http.HttpServletRequest request)
protected void	flush(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ServerSessionImpl session, boolean sendQueue, boolean startInterval, ServerMessage.Mutable... replies)
BayeuxContext	getContext()
javax.servlet.http.HttpServletRequest	getCurrentRequest()
protected long	getMultiSessionInterval()
abstract void	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	handleJSONParseException(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String json, Throwable exception)
protected boolean	incBrowserId(String browserId, ServerSession session) Increment the browser ID count.
void	init() Initialise the transport, resolving default and direct options.
protected boolean	isAllowMultiSessionsNoBrowser()
protected boolean	isAutoBatch()
protected void	metaConnectResumed(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.AsyncContext asyncContext, ServerSession session)
protected void	metaConnectSuspended(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.AsyncContext asyncContext, ServerSession session)
protected void	processMessages(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ServerMessage.Mutable[] messages)
protected ServerMessage.Mutable	processMetaConnect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ServerSessionImpl session, ServerMessage.Mutable message)
protected ServerMessage.Mutable	processMetaHandshake(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ServerSessionImpl session, ServerMessage.Mutable message)
protected ServerMessage.Mutable	processReply(ServerSessionImpl session, ServerMessage.Mutable reply)
protected void	resume(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.AsyncContext asyncContext, ServerSessionImpl session, ServerMessage.Mutable reply)
protected String	setBrowserId(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setCurrentRequest(javax.servlet.http.HttpServletRequest request)
protected abstract AbstractHttpTransport.HttpScheduler	suspend(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ServerSessionImpl session, ServerMessage.Mutable reply, String browserId, long timeout)
protected void	sweep() Sweeps the transport for old Browser IDs
protected abstract void	write(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ServerSessionImpl session, boolean startInterval, List<ServerMessage> messages, ServerMessage.Mutable[] replies)

Methods inherited from class org.cometd.server.AbstractServerTransport

destroy, getAdvice, getBayeux, getInterval, getMaxInterval, getMaxLazyTimeout, getTimeout, isMetaConnectDeliveryOnly, parseMessages, parseMessages, setAdvice, setInterval, setMaxInterval, setMaxLazyTimeout, setMetaConnectDeliveryOnly, setTimeout

Methods inherited from class org.cometd.common.AbstractTransport

getName, getOption, getOption, getOption, getOption, getOption, getOptionNames, getOptionPrefix, setOption, setOptionPrefix

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cometd.bayeux.Transport

getName, getOption, getOptionNames, getOptionPrefix

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

JSON_DEBUG_OPTION

public static final String JSON_DEBUG_OPTION

See Also:

Constant Field Values

MESSAGE_PARAM

public static final String MESSAGE_PARAM

See Also:

Constant Field Values

BROWSER_COOKIE_NAME_OPTION

public static final String BROWSER_COOKIE_NAME_OPTION

See Also:

Constant Field Values

BROWSER_COOKIE_DOMAIN_OPTION

public static final String BROWSER_COOKIE_DOMAIN_OPTION

See Also:

Constant Field Values

BROWSER_COOKIE_PATH_OPTION

public static final String BROWSER_COOKIE_PATH_OPTION

See Also:

Constant Field Values

MAX_SESSIONS_PER_BROWSER_OPTION

public static final String MAX_SESSIONS_PER_BROWSER_OPTION

See Also:

Constant Field Values

MULTI_SESSION_INTERVAL_OPTION

public static final String MULTI_SESSION_INTERVAL_OPTION

See Also:

Constant Field Values

AUTOBATCH_OPTION

public static final String AUTOBATCH_OPTION

See Also:

Constant Field Values

ALLOW_MULTI_SESSIONS_NO_BROWSER_OPTION

public static final String ALLOW_MULTI_SESSIONS_NO_BROWSER_OPTION

See Also:

Constant Field Values

_logger

protected final org.slf4j.Logger _logger

Constructor Detail

AbstractHttpTransport

protected AbstractHttpTransport(BayeuxServerImpl bayeux,
                     String name)

Method Detail

init

public void init()

Description copied from class: AbstractServerTransport

Initialise the transport, resolving default and direct options.

Overrides:

init in class AbstractServerTransport

getMultiSessionInterval

protected long getMultiSessionInterval()

isAutoBatch

protected boolean isAutoBatch()

isAllowMultiSessionsNoBrowser

protected boolean isAllowMultiSessionsNoBrowser()

setCurrentRequest

public void setCurrentRequest(javax.servlet.http.HttpServletRequest request)

getCurrentRequest

public javax.servlet.http.HttpServletRequest getCurrentRequest()

accept

public abstract boolean accept(javax.servlet.http.HttpServletRequest request)

handle

public abstract void handle(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
                     throws IOException,
                            javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

suspend

protected abstract AbstractHttpTransport.HttpScheduler suspend(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response,
                                          ServerSessionImpl session,
                                          ServerMessage.Mutable reply,
                                          String browserId,
                                          long timeout)

write

protected abstract void write(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response,
         ServerSessionImpl session,
         boolean startInterval,
         List<ServerMessage> messages,
         ServerMessage.Mutable[] replies)

processMessages

protected void processMessages(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   ServerMessage.Mutable[] messages)
                        throws IOException

Throws:

IOException

processMetaHandshake

protected ServerMessage.Mutable processMetaHandshake(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response,
                                         ServerSessionImpl session,
                                         ServerMessage.Mutable message)

processMetaConnect

protected ServerMessage.Mutable processMetaConnect(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       ServerSessionImpl session,
                                       ServerMessage.Mutable message)

processReply

protected ServerMessage.Mutable processReply(ServerSessionImpl session,
                                 ServerMessage.Mutable reply)

flush

protected void flush(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response,
         ServerSessionImpl session,
         boolean sendQueue,
         boolean startInterval,
         ServerMessage.Mutable... replies)

resume

protected void resume(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response,
          javax.servlet.AsyncContext asyncContext,
          ServerSessionImpl session,
          ServerMessage.Mutable reply)

getContext

public BayeuxContext getContext()

findBrowserId

protected String findBrowserId(javax.servlet.http.HttpServletRequest request)

setBrowserId

protected String setBrowserId(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)

incBrowserId

protected boolean incBrowserId(String browserId,
                   ServerSession session)

Increment the browser ID count.

Parameters:

browserId - the browser ID to increment the count for

session - the session that cause the browser ID increment

Returns:

true if the browser ID count is below the max sessions per browser value. If false is returned, the count is not incremented.

decBrowserId

protected void decBrowserId(String browserId,
                ServerSession session)

handleJSONParseException

protected void handleJSONParseException(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            String json,
                            Throwable exception)
                                 throws IOException

Throws:

IOException

error

protected void error(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response,
         javax.servlet.AsyncContext asyncContext,
         int responseCode)

bayeuxServerHandle

protected ServerMessage.Mutable bayeuxServerHandle(ServerSessionImpl session,
                                       ServerMessage.Mutable message)

metaConnectSuspended

protected void metaConnectSuspended(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        javax.servlet.AsyncContext asyncContext,
                        ServerSession session)

metaConnectResumed

protected void metaConnectResumed(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      javax.servlet.AsyncContext asyncContext,
                      ServerSession session)

sweep

protected void sweep()

Sweeps the transport for old Browser IDs

Overrides:

sweep in class AbstractServerTransport