org.cometd.server.transport

Class LongPollingTransport

java.lang.Object

org.cometd.common.AbstractTransport

org.cometd.server.AbstractServerTransport

org.cometd.server.transport.HttpTransport

org.cometd.server.transport.LongPollingTransport

All Implemented Interfaces:

ServerTransport, Transport

Direct Known Subclasses:

JSONPTransport, JSONTransport

public abstract class LongPollingTransport
extends HttpTransport

Abstract Long Polling Transport.

Transports based on this class can be configured with servlet init parameters:

browserId

The Cookie name used to save a browser ID.

maxSessionsPerBrowser

The maximum number of long polling sessions allowed per browser.

multiSessionInterval

The polling interval to use once max session per browser is exceeded.

autoBatch

If true a batch will be automatically created to span the handling of messages received from a session.

allowMultiSessionsNoBrowser

Allows multiple sessions even when the browser identifier cannot be retrieved.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	LongPollingTransport.LongPollScheduler

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

AbstractServerTransport.OneTimeScheduler, AbstractServerTransport.Scheduler

Field Summary

Fields inherited from class org.cometd.server.transport.HttpTransport

_logger, ALLOW_MULTI_SESSIONS_NO_BROWSER_OPTION, AUTOBATCH_OPTION, BROWSER_COOKIE_DOMAIN_OPTION, BROWSER_COOKIE_NAME_OPTION, BROWSER_COOKIE_PATH_OPTION, JSON_DEBUG_OPTION, MAX_SESSIONS_PER_BROWSER_OPTION, MESSAGE_PARAM, MULTI_SESSION_INTERVAL_OPTION, 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	LongPollingTransport(BayeuxServerImpl bayeux, String name)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	finishWrite(PrintWriter writer, ServerSessionImpl session)
void	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected abstract boolean	isAlwaysFlushingAfterHandle()
protected LongPollingTransport.LongPollScheduler	newLongPollScheduler(ServerSessionImpl session, javax.servlet.AsyncContext asyncContext, ServerMessage.Mutable metaConnectReply, String browserId)
protected abstract ServerMessage.Mutable[]	parseMessages(javax.servlet.http.HttpServletRequest request)
protected ServerMessage.Mutable[]	parseMessages(String[] requestParameters)
protected void	process(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected abstract PrintWriter	writeMessage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, PrintWriter writer, ServerSessionImpl session, ServerMessage message)

Methods inherited from class org.cometd.server.transport.HttpTransport

accept, bayeuxServerHandle, decBrowserId, findBrowserId, getContext, getCurrentRequest, getMultiSessionInterval, handleJSONParseException, incBrowserId, init, isAllowMultiSessionsNoBrowser, isAutoBatch, metaConnectResumed, metaConnectSuspended, setBrowserId, setCurrentRequest, sweep

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

Constructor Detail

LongPollingTransport

protected LongPollingTransport(BayeuxServerImpl bayeux,
                    String name)

Method Detail

handle

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

Specified by:

handle in class HttpTransport

Throws:

IOException

javax.servlet.ServletException

process

protected void process(javax.servlet.http.HttpServletRequest request,
           javax.servlet.http.HttpServletResponse response)
                throws IOException,
                       javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

newLongPollScheduler

protected LongPollingTransport.LongPollScheduler newLongPollScheduler(ServerSessionImpl session,
                                                          javax.servlet.AsyncContext asyncContext,
                                                          ServerMessage.Mutable metaConnectReply,
                                                          String browserId)

parseMessages

protected ServerMessage.Mutable[] parseMessages(String[] requestParameters)
                                         throws IOException,
                                                ParseException

Throws:

IOException

ParseException

parseMessages

protected abstract ServerMessage.Mutable[] parseMessages(javax.servlet.http.HttpServletRequest request)
                                                  throws IOException,
                                                         ParseException

Throws:

IOException

ParseException

isAlwaysFlushingAfterHandle

protected abstract boolean isAlwaysFlushingAfterHandle()

Returns:

true if the transport always flushes at the end of a call to handle(HttpServletRequest, HttpServletResponse).

writeMessage

protected abstract PrintWriter writeMessage(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       PrintWriter writer,
                       ServerSessionImpl session,
                       ServerMessage message)
                                     throws IOException

Throws:

IOException

finishWrite

protected abstract void finishWrite(PrintWriter writer,
               ServerSessionImpl session)
                             throws IOException

Throws:

IOException