Class AbstractHttpTransport

java.lang.Object

org.cometd.common.AbstractTransport

org.cometd.server.AbstractServerTransport

org.cometd.server.http.AbstractHttpTransport

All Implemented Interfaces:

ServerTransport, Transport, org.eclipse.jetty.util.component.Dumpable

Direct Known Subclasses:

JSONHttpTransport, JSONPHttpTransport

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	Description
static interface	AbstractHttpTransport.HttpScheduler	A AbstractServerTransport.Scheduler for HTTP-based transports.
protected class	AbstractHttpTransport.Writer

Nested classes/interfaces inherited from class AbstractServerTransport

AbstractServerTransport.Scheduler, AbstractServerTransport.SchedulerCancelledException

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.Dumpable.DumpAppendable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROWSER_COOKIE_DOMAIN_OPTION
static final String	BROWSER_COOKIE_HTTP_ONLY_OPTION
static final String	BROWSER_COOKIE_MAX_AGE_OPTION
static final String	BROWSER_COOKIE_NAME_OPTION
static final String	BROWSER_COOKIE_PARTITIONED_OPTION
static final String	BROWSER_COOKIE_PATH_OPTION
static final String	BROWSER_COOKIE_SAME_SITE_OPTION
static final String	BROWSER_COOKIE_SECURE_OPTION
static final String	DUPLICATE_META_CONNECT_HTTP_RESPONSE_CODE_OPTION
static final String	HTTP2_MAX_SESSIONS_PER_BROWSER_OPTION
static final String	JSON_DEBUG_OPTION
static final String	MAX_SESSIONS_PER_BROWSER_OPTION
static final String	MESSAGE_PARAM
static final String	MULTI_SESSION_INTERVAL_OPTION
static final String	PREFIX
static final String	TRUST_CLIENT_SESSION_OPTION

Fields inherited from class AbstractServerTransport

ALLOW_MESSAGE_DELIVERY_DURING_HANDSHAKE, HANDSHAKE_RECONNECT_OPTION, INTERVAL_OPTION, JSON_CONTEXT_OPTION, MAX_INTERVAL_OPTION, MAX_LAZY_TIMEOUT_OPTION, MAX_MESSAGE_SIZE_OPTION, MAX_PROCESSING_OPTION, MAX_QUEUE_OPTION, META_CONNECT_DELIVERY_OPTION, TIMEOUT_OPTION

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

LEGEND

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
abstract boolean	accept(CometDRequest request)
void	decBrowserId(ServerSessionImpl session, boolean http2)
static AbstractHttpTransport	find(BayeuxServer bayeuxServer, CometDRequest request)
protected String	findBrowserId(TransportContext context)
protected Collection<ServerSessionImpl>	findCurrentSessions(CometDRequest request)
protected ServerSessionImpl	findSession(Collection<ServerSessionImpl> sessions, ServerMessage.Mutable message)
protected void	flush(TransportContext context)
protected String	getBrowserCookieDomain()
protected int	getBrowserCookieMaxAge()
protected String	getBrowserCookieName()
protected String	getBrowserCookiePath()
protected String	getBrowserCookieSameSite()
protected int	getDuplicateMetaConnectHttpResponseCode()
protected long	getMultiSessionInterval()
void	handle(BayeuxContext bayeuxContext, CometDRequest request, CometDResponse response, Promise<Void> promise)
protected abstract void	handle(TransportContext context)
protected void	handleMessage(TransportContext context, ServerMessage.Mutable message, Promise<ServerMessage.Mutable> promise)
boolean	incBrowserId(ServerSessionImpl session, boolean http2)	Increments the count of sessions for the given browser identifier.
void	init()	Initializes the transport, resolving default and direct options.
protected boolean	isBrowserCookieHttpOnly()
protected boolean	isBrowserCookiePartitioned()
protected boolean	isBrowserCookieSecure()
protected boolean	isHTTP2(CometDRequest request)
protected void	newBrowserCookie(StringBuilder builder, String name, String value, boolean secure)
protected AbstractHttpTransport.HttpScheduler	newHttpScheduler(TransportContext context, Promise<Void> promise, ServerMessage.Mutable reply, long timeout)
protected void	processMessages(TransportContext context, List<ServerMessage.Mutable> messages)
protected void	resume(TransportContext context, ServerMessage.Mutable message, Promise<Void> promise)
protected String	setBrowserId(TransportContext context)
protected AbstractHttpTransport.HttpScheduler	suspend(TransportContext context, Promise<Void> promise, ServerMessage.Mutable message, long timeout)
protected void	sweep()	Sweeps the transport for old Browser IDs
protected byte[]	toJSONBytes(ServerMessage msg)
protected void	write(TransportContext context, List<ServerMessage> messages)
protected void	writeBegin(CometDResponse.Output output, Promise<Void> promise)
protected void	writeComplete(TransportContext context, List<ServerMessage> messages)
protected void	writeEnd(CometDResponse.Output output, Promise<Void> promise)
protected void	writeMessage(CometDResponse.Output output, ServerMessage message, Promise<Void> promise)
protected void	writePrepare(TransportContext context, Promise<Void> promise)

Methods inherited from class AbstractServerTransport

allowMessageDeliveryDuringHandshake, destroy, dump, getBayeuxServer, getInterval, getJSONContextServer, getMaxInterval, getMaxLazyTimeout, getMaxMessageSize, getTimeout, isAllowMessageDeliveryDuringHandshake, isHandshakeReconnect, isMetaConnectDeliveryOnly, newMetaConnectCycle, parseMessages, processReply, scheduleExpiration, setAllowMessageDeliveryDuringHandshake, setHandshakeReconnect, setInterval, setMaxInterval, setMaxLazyTimeout, setMaxMessageSize, setMetaConnectDeliveryOnly, setTimeout, toJSON, toString

Methods inherited from class AbstractTransport

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

Methods inherited from class Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dump, dumpSelf

Methods inherited from interface Transport

getName, getOption, getOptionNames, getOptionPrefix

Field Details

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

BROWSER_COOKIE_MAX_AGE_OPTION

public static final String BROWSER_COOKIE_MAX_AGE_OPTION

See Also:

• Constant Field Values

BROWSER_COOKIE_SECURE_OPTION

public static final String BROWSER_COOKIE_SECURE_OPTION

See Also:

• Constant Field Values

BROWSER_COOKIE_HTTP_ONLY_OPTION

public static final String BROWSER_COOKIE_HTTP_ONLY_OPTION

See Also:

• Constant Field Values

BROWSER_COOKIE_SAME_SITE_OPTION

public static final String BROWSER_COOKIE_SAME_SITE_OPTION

See Also:

• Constant Field Values

BROWSER_COOKIE_PARTITIONED_OPTION

public static final String BROWSER_COOKIE_PARTITIONED_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

HTTP2_MAX_SESSIONS_PER_BROWSER_OPTION

public static final String HTTP2_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

TRUST_CLIENT_SESSION_OPTION

public static final String TRUST_CLIENT_SESSION_OPTION

See Also:

• Constant Field Values

DUPLICATE_META_CONNECT_HTTP_RESPONSE_CODE_OPTION

public static final String DUPLICATE_META_CONNECT_HTTP_RESPONSE_CODE_OPTION

See Also:

• Constant Field Values

Constructor Details

AbstractHttpTransport

protected AbstractHttpTransport(BayeuxServerImpl bayeux,
 String name)

Method Details

find

public static AbstractHttpTransport find(BayeuxServer bayeuxServer,
 CometDRequest request)

init

public void init()

Description copied from class: AbstractServerTransport

Initializes the transport, resolving default and direct options.

Overrides:

init in class AbstractServerTransport

getBrowserCookieName

protected String getBrowserCookieName()

getBrowserCookieDomain

protected String getBrowserCookieDomain()

getBrowserCookiePath

protected String getBrowserCookiePath()

getBrowserCookieMaxAge

protected int getBrowserCookieMaxAge()

isBrowserCookieSecure

protected boolean isBrowserCookieSecure()

isBrowserCookieHttpOnly

protected boolean isBrowserCookieHttpOnly()

getBrowserCookieSameSite

protected String getBrowserCookieSameSite()

isBrowserCookiePartitioned

protected boolean isBrowserCookiePartitioned()

getMultiSessionInterval

protected long getMultiSessionInterval()

getDuplicateMetaConnectHttpResponseCode

protected int getDuplicateMetaConnectHttpResponseCode()

accept

public abstract boolean accept(CometDRequest request)

handle

public void handle(BayeuxContext bayeuxContext,
 CometDRequest request,
 CometDResponse response,
 Promise<Void> promise)

handle

protected abstract void handle(TransportContext context)

suspend

protected AbstractHttpTransport.HttpScheduler suspend(TransportContext context,
 Promise<Void> promise,
 ServerMessage.Mutable message,
 long timeout)

newHttpScheduler

protected AbstractHttpTransport.HttpScheduler newHttpScheduler(TransportContext context,
 Promise<Void> promise,
 ServerMessage.Mutable reply,
 long timeout)

write

protected void write(TransportContext context,
 List<ServerMessage> messages)

processMessages

protected void processMessages(TransportContext context,
 List<ServerMessage.Mutable> messages)

findSession

protected ServerSessionImpl findSession(Collection<ServerSessionImpl> sessions,
 ServerMessage.Mutable message)

findCurrentSessions

protected Collection<ServerSessionImpl> findCurrentSessions(CometDRequest request)

isHTTP2

protected boolean isHTTP2(CometDRequest request)

flush

protected void flush(TransportContext context)

resume

protected void resume(TransportContext context,
 ServerMessage.Mutable message,
 Promise<Void> promise)

findBrowserId

protected String findBrowserId(TransportContext context)

setBrowserId

protected String setBrowserId(TransportContext context)

newBrowserCookie

protected void newBrowserCookie(StringBuilder builder,
 String name,
 String value,
 boolean secure)

incBrowserId

public boolean incBrowserId(ServerSessionImpl session,
 boolean http2)

Increments the count of sessions for the given browser identifier.

Parameters:

session - the session that increments the count

http2 - whether the HTTP protocol is HTTP/2

Returns:

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

See Also:

• decBrowserId(ServerSessionImpl, boolean)

decBrowserId

public void decBrowserId(ServerSessionImpl session,
 boolean http2)

handleMessage

protected void handleMessage(TransportContext context,
 ServerMessage.Mutable message,
 Promise<ServerMessage.Mutable> promise)

writePrepare

protected void writePrepare(TransportContext context,
 Promise<Void> promise)

writeBegin

protected void writeBegin(CometDResponse.Output output,
 Promise<Void> promise)

writeMessage

protected void writeMessage(CometDResponse.Output output,
 ServerMessage message,
 Promise<Void> promise)

writeEnd

protected void writeEnd(CometDResponse.Output output,
 Promise<Void> promise)

writeComplete

protected void writeComplete(TransportContext context,
 List<ServerMessage> messages)

sweep

protected void sweep()

Sweeps the transport for old Browser IDs

Overrides:

sweep in class AbstractServerTransport

toJSONBytes

protected byte[] toJSONBytes(ServerMessage msg)