A B C D E G H I L M N O P Q R S T U V

A

addExtension(ClientSession.Extension) - Method in interface org.cometd.bayeux.client.ClientSession

Adds an extension to this session.

addExtension(BayeuxServer.Extension) - Method in interface org.cometd.bayeux.server.BayeuxServer

Adds the given extension to this Bayeux object.

addExtension(ServerSession.Extension) - Method in interface org.cometd.bayeux.server.ServerSession

Adds the given extension to this session.

addListener(ClientSessionChannel.ClientSessionChannelListener) - Method in interface org.cometd.bayeux.client.ClientSessionChannel

addListener(BayeuxServer.BayeuxServerListener) - Method in interface org.cometd.bayeux.server.BayeuxServer

Adds a listener to this Bayeux object.

addListener(ServerChannel.ServerChannelListener) - Method in interface org.cometd.bayeux.server.ConfigurableServerChannel

addListener(ServerSession.ServerSessionListener) - Method in interface org.cometd.bayeux.server.ServerSession

Adds the given listener to this session.

ADVICE_FIELD - Static variable in interface org.cometd.bayeux.Message

asImmutable() - Method in interface org.cometd.bayeux.server.ServerMessage.Mutable

asMutable() - Method in interface org.cometd.bayeux.server.ServerMessage

ATTRIBUTE - Static variable in interface org.cometd.bayeux.server.BayeuxServer

ServletContext attribute name used to obtain the Bayeux object

B

batch(Runnable) - Method in interface org.cometd.bayeux.Session

Executes the given command in a batch so that any Bayeux message sent by the command (via the Bayeux API) is queued up until the end of the command and then all messages are sent at once.

Bayeux - Interface in org.cometd.bayeux

The Bayeux interface is the common API for both client-side and server-side configuration and usage of the Bayeux object.

Bayeux.BayeuxListener - Interface in org.cometd.bayeux

The common base interface for Bayeux listeners.

BayeuxServer - Interface in org.cometd.bayeux.server

The server-side Bayeux interface.

BayeuxServer.BayeuxServerListener - Interface in org.cometd.bayeux.server

Common base interface for all server-side Bayeux listeners

BayeuxServer.ChannelListener - Interface in org.cometd.bayeux.server

Specialized listener for ServerChannel events.

BayeuxServer.Extension - Interface in org.cometd.bayeux.server

Extension API for BayeuxServer.

BayeuxServer.SessionListener - Interface in org.cometd.bayeux.server

Specialized listener for ServerSession events.

BayeuxServer.SubscriptionListener - Interface in org.cometd.bayeux.server

Specialized listener for ServerChannel subscription events.

C

canCreate(BayeuxServer, ServerSession, String, ServerMessage) - Method in interface org.cometd.bayeux.server.SecurityPolicy

Checks if a message should be allowed to create a new channel.

canHandshake(BayeuxServer, ServerSession, ServerMessage) - Method in interface org.cometd.bayeux.server.SecurityPolicy

Checks if a handshake message should be accepted.

canPublish(BayeuxServer, ServerSession, ServerChannel, ServerMessage) - Method in interface org.cometd.bayeux.server.SecurityPolicy

Checks if a client can publish a message to a channel.

canSubscribe(BayeuxServer, ServerSession, ServerChannel, ServerMessage) - Method in interface org.cometd.bayeux.server.SecurityPolicy

Checks if a client is allowed to subscribe to a channel.

Channel - Interface in org.cometd.bayeux

A Bayeux channel is the primary message routing mechanism within Bayeux: both Bayeux clients and Bayeux server use channels to group listeners that are interested in receiving messages with that channel.

CHANNEL_FIELD - Static variable in interface org.cometd.bayeux.Message

channelAdded(ServerChannel) - Method in interface org.cometd.bayeux.server.BayeuxServer.ChannelListener

Callback invoked when a ServerChannel has been added to a BayeuxServer object.

channelRemoved(String) - Method in interface org.cometd.bayeux.server.BayeuxServer.ChannelListener

Callback invoked when a ServerChannel has been removed from a BayeuxServer object.

CLIENT_ID_FIELD - Static variable in interface org.cometd.bayeux.Message

ClientSession - Interface in org.cometd.bayeux.client

This interface represents the client side Bayeux session.

ClientSession.Extension - Interface in org.cometd.bayeux.client

Extension API for client session.

ClientSessionChannel - Interface in org.cometd.bayeux.client

A client side channel representation.

ClientSessionChannel.ClientSessionChannelListener - Interface in org.cometd.bayeux.client

Represents a listener on a ClientSessionChannel.

ClientSessionChannel.MessageListener - Interface in org.cometd.bayeux.client

A listener for messages on a ClientSessionChannel.

ConfigurableServerChannel - Interface in org.cometd.bayeux.server

A ConfigurableServerChannel offers an API that can be used to configure ServerChannels at creation time.

ConfigurableServerChannel.Initializer - Interface in org.cometd.bayeux.server

A listener interface by means of which listeners can atomically set the initial configuration of a channel.

configureChannel(ConfigurableServerChannel) - Method in interface org.cometd.bayeux.server.ConfigurableServerChannel.Initializer

Callback invoked when a channel is created and needs to be configured

CONNECTION_TYPE_FIELD - Static variable in interface org.cometd.bayeux.Message

createIfAbsent(String, ConfigurableServerChannel.Initializer...) - Method in interface org.cometd.bayeux.server.BayeuxServer

Creates a ServerChannel and initializes it atomically.

D

DATA_FIELD - Static variable in interface org.cometd.bayeux.Message

deliver(Session, ServerMessage) - Method in interface org.cometd.bayeux.server.ServerSession

Delivers the given message to this session.

deliver(Session, String, Object, String) - Method in interface org.cometd.bayeux.server.ServerSession

Delivers the given information to this session.

deQueue(ServerSession, Queue<ServerMessage>) - Method in interface org.cometd.bayeux.server.ServerSession.DeQueueListener

Callback invoked to notify that the queue of messages is about to be sent to the remote client.

disconnect() - Method in interface org.cometd.bayeux.Session

Disconnects this session, ending the link between the client and the server peers.

E

endBatch() - Method in interface org.cometd.bayeux.Session

Deprecated. use Session.batch(Runnable)

ERROR_FIELD - Static variable in interface org.cometd.bayeux.Message

EXT_FIELD - Static variable in interface org.cometd.bayeux.Message

G

getAdvice() - Method in interface org.cometd.bayeux.Message

Convenience method to retrieve the Message.ADVICE_FIELD

getAdvice(boolean) - Method in interface org.cometd.bayeux.Message.Mutable

Convenience method to retrieve the Message.ADVICE_FIELD and create it if it does not exist

getAdvice() - Method in interface org.cometd.bayeux.server.ServerTransport

The advice that this transport sends to inform the client about transport (re)connection.

getAllowedTransports() - Method in interface org.cometd.bayeux.Bayeux

getAssociated() - Method in interface org.cometd.bayeux.server.ServerMessage

getAttribute(String) - Method in interface org.cometd.bayeux.Session

Retrieves the value of named session attribute.

getAttributeNames() - Method in interface org.cometd.bayeux.Session

getChannel(String) - Method in interface org.cometd.bayeux.client.ClientSession

Returns a client side channel scoped by this session.

getChannel() - Method in interface org.cometd.bayeux.Message

Convenience method to retrieve the Message.CHANNEL_FIELD.

getChannel(String) - Method in interface org.cometd.bayeux.server.BayeuxServer

getClientId() - Method in interface org.cometd.bayeux.Message

Convenience method to retrieve the Message.CLIENT_ID_FIELD

getCurrentLocalAddress() - Method in interface org.cometd.bayeux.server.ServerTransport

getCurrentRemoteAddress() - Method in interface org.cometd.bayeux.server.ServerTransport

getCurrentTransport() - Method in interface org.cometd.bayeux.server.BayeuxServer

getData() - Method in interface org.cometd.bayeux.Message

Convenience method to retrieve the Message.DATA_FIELD

getDataAsMap() - Method in interface org.cometd.bayeux.Message

getDataAsMap(boolean) - Method in interface org.cometd.bayeux.Message.Mutable

Convenience method to retrieve the Message.DATA_FIELD and create it if it does not exist

getExt() - Method in interface org.cometd.bayeux.Message

Convenience method to retrieve the Message.EXT_FIELD

getExt(boolean) - Method in interface org.cometd.bayeux.Message.Mutable

Convenience method to retrieve the Message.EXT_FIELD and create it if it does not exist

getId() - Method in interface org.cometd.bayeux.Channel

getId() - Method in interface org.cometd.bayeux.Message

Convenience method to retrieve the Message.ID_FIELD

getId() - Method in interface org.cometd.bayeux.Session

The clientId of the session.

getInterval() - Method in interface org.cometd.bayeux.server.ServerTransport

getJSON() - Method in interface org.cometd.bayeux.Message

getKnownTransportNames() - Method in interface org.cometd.bayeux.Bayeux

getLocalSession() - Method in interface org.cometd.bayeux.server.ServerSession

getMaxInterval() - Method in interface org.cometd.bayeux.server.ServerTransport

getMaxLazyTimeout() - Method in interface org.cometd.bayeux.server.ServerTransport

getName() - Method in interface org.cometd.bayeux.Transport

getOption(String) - Method in interface org.cometd.bayeux.Bayeux

getOption(String) - Method in interface org.cometd.bayeux.Transport

getOptionNames() - Method in interface org.cometd.bayeux.Bayeux

getOptionNames() - Method in interface org.cometd.bayeux.Transport

getOptionPrefix() - Method in interface org.cometd.bayeux.Transport

Specifies an option prefix made of string segments separated by the "." character, used to override more generic configuration entries.

getSecurityPolicy() - Method in interface org.cometd.bayeux.server.BayeuxServer

getServerSession() - Method in interface org.cometd.bayeux.server.LocalSession

getSession() - Method in interface org.cometd.bayeux.client.ClientSessionChannel

getSession(String) - Method in interface org.cometd.bayeux.server.BayeuxServer

getSubscribers() - Method in interface org.cometd.bayeux.server.ServerChannel

getTimeout() - Method in interface org.cometd.bayeux.server.ServerTransport

getTransport(String) - Method in interface org.cometd.bayeux.Bayeux

getUserAgent() - Method in interface org.cometd.bayeux.server.ServerSession

Get the clients user agent

H

handshake() - Method in interface org.cometd.bayeux.client.ClientSession

Equivalent to handshake(null).

handshake(Map<String, Object>) - Method in interface org.cometd.bayeux.client.ClientSession

Initiates the bayeux protocol handshake with the server(s).

I

ID_FIELD - Static variable in interface org.cometd.bayeux.Message

INTERVAL_FIELD - Static variable in interface org.cometd.bayeux.Message

isBroadcast() - Method in interface org.cometd.bayeux.server.ServerChannel

A broadcasting channel is a channel that is neither a meta channel not a service channel.

isConnected() - Method in interface org.cometd.bayeux.Session

A connected session is a session where the link between the client and the server has been established.

isDeepWild() - Method in interface org.cometd.bayeux.Channel

isHandshook() - Method in interface org.cometd.bayeux.Session

A handshook session is a session where the handshake has successfully completed>

isLazy() - Method in interface org.cometd.bayeux.server.ConfigurableServerChannel

isLazy() - Method in interface org.cometd.bayeux.server.ServerMessage

isLocalSession() - Method in interface org.cometd.bayeux.server.ServerSession

isMeta() - Method in interface org.cometd.bayeux.Channel

isMeta() - Method in interface org.cometd.bayeux.Message

A messages that has a meta channel is dubbed a "meta message".

isMetaConnectDeliveryOnly() - Method in interface org.cometd.bayeux.server.ServerTransport

isPersistent() - Method in interface org.cometd.bayeux.server.ConfigurableServerChannel

isService() - Method in interface org.cometd.bayeux.Channel

isSuccessful() - Method in interface org.cometd.bayeux.Message

Convenience method to retrieve the Message.SUCCESSFUL_FIELD

isWild() - Method in interface org.cometd.bayeux.Channel

L

LocalSession - Interface in org.cometd.bayeux.server

A LocalSession is a ClientSession within the server.

M

Message - Interface in org.cometd.bayeux

The Bayeux protocol exchange information by means of messages.

Message.Mutable - Interface in org.cometd.bayeux

The mutable version of a Message

META - Static variable in interface org.cometd.bayeux.Channel

Constant representing the meta prefix

META_CONNECT - Static variable in interface org.cometd.bayeux.Channel

Constant representing the connect meta channel

META_DISCONNECT - Static variable in interface org.cometd.bayeux.Channel

Constant representing the disconnect meta channel

META_HANDSHAKE - Static variable in interface org.cometd.bayeux.Channel

Constant representing the handshake meta channel.

META_SUBSCRIBE - Static variable in interface org.cometd.bayeux.Channel

Constant representing the subscribe meta channel

META_UNSUBSCRIBE - Static variable in interface org.cometd.bayeux.Channel

Constant representing the unsubscribe meta channel

MIN_VERSION_FIELD - Static variable in interface org.cometd.bayeux.Message

N

newLocalSession(String) - Method in interface org.cometd.bayeux.server.BayeuxServer

Creates a new LocalSession.

newMessage() - Method in interface org.cometd.bayeux.server.BayeuxServer

O

onMessage(ClientSessionChannel, Message) - Method in interface org.cometd.bayeux.client.ClientSessionChannel.MessageListener

Callback invoked when a message is received on the given channel.

onMessage(ServerSession, ServerChannel, ServerMessage.Mutable) - Method in interface org.cometd.bayeux.server.ServerChannel.MessageListener

Callback invoked when a message is being published.

onMessage(ServerSession, ServerSession, ServerMessage) - Method in interface org.cometd.bayeux.server.ServerSession.MessageListener

Callback invoked when a message is received.

org.cometd.bayeux - package org.cometd.bayeux

org.cometd.bayeux.client - package org.cometd.bayeux.client

org.cometd.bayeux.server - package org.cometd.bayeux.server

P

publish(Object) - Method in interface org.cometd.bayeux.client.ClientSessionChannel

Equivalent to publish(data, null).

publish(Object, String) - Method in interface org.cometd.bayeux.client.ClientSessionChannel

Publishes the given data to this channel, optionally specifying the messageId to set on the publish message.

publish(Session, ServerMessage) - Method in interface org.cometd.bayeux.server.ServerChannel

Publishes the given message to this channel, delivering the message to all the ServerSessions subscribed to this channel.

publish(Session, Object, String) - Method in interface org.cometd.bayeux.server.ServerChannel

Publishes the given information to this channel.

Q

queueMaxed(ServerSession, Session, Message) - Method in interface org.cometd.bayeux.server.ServerSession.MaxQueueListener

Callback invoked to notify when the message queue is exceeding the value configured for the transport with the option "maxQueue".

R

rcv(ClientSession, Message.Mutable) - Method in interface org.cometd.bayeux.client.ClientSession.Extension

Callback method invoked every time a normal message is received.

rcv(ServerSession, ServerMessage.Mutable) - Method in interface org.cometd.bayeux.server.BayeuxServer.Extension

Callback method invoked every time a normal message is incoming.

rcv(ServerSession, ServerMessage.Mutable) - Method in interface org.cometd.bayeux.server.ServerSession.Extension

Callback method invoked every time a normal message is incoming.

rcvMeta(ClientSession, Message.Mutable) - Method in interface org.cometd.bayeux.client.ClientSession.Extension

Callback method invoked every time a meta message is received.

rcvMeta(ServerSession, ServerMessage.Mutable) - Method in interface org.cometd.bayeux.server.BayeuxServer.Extension

Callback method invoked every time a meta message is incoming.

rcvMeta(ServerSession, ServerMessage.Mutable) - Method in interface org.cometd.bayeux.server.ServerSession.Extension

Callback method invoked every time a meta message is incoming.

RECONNECT_FIELD - Static variable in interface org.cometd.bayeux.Message

RECONNECT_HANDSHAKE_VALUE - Static variable in interface org.cometd.bayeux.Message

RECONNECT_NONE_VALUE - Static variable in interface org.cometd.bayeux.Message

RECONNECT_RETRY_VALUE - Static variable in interface org.cometd.bayeux.Message

remove() - Method in interface org.cometd.bayeux.server.ServerChannel

Removes this channel, and all the children channels.

removeAttribute(String) - Method in interface org.cometd.bayeux.Session

Removes a named session attribute.

removed(ServerSession, boolean) - Method in interface org.cometd.bayeux.server.ServerSession.RemoveListener

Callback invoked when the session is removed.

removeExtension(ClientSession.Extension) - Method in interface org.cometd.bayeux.client.ClientSession

Removes an extension from this session.

removeExtension(BayeuxServer.Extension) - Method in interface org.cometd.bayeux.server.BayeuxServer

Removes the given extension from this Bayeux object

removeExtension(ServerSession.Extension) - Method in interface org.cometd.bayeux.server.ServerSession

Removes the given extension from this session

removeListener(ClientSessionChannel.ClientSessionChannelListener) - Method in interface org.cometd.bayeux.client.ClientSessionChannel

removeListener(BayeuxServer.BayeuxServerListener) - Method in interface org.cometd.bayeux.server.BayeuxServer

Removes a listener from this Bayeux object.

removeListener(ServerChannel.ServerChannelListener) - Method in interface org.cometd.bayeux.server.ConfigurableServerChannel

removeListener(ServerSession.ServerSessionListener) - Method in interface org.cometd.bayeux.server.ServerSession

Removes the given listener from this session.

S

SecurityPolicy - Interface in org.cometd.bayeux.server

A Bayeux SecurityPolicy defines the authorization constraints that must be enforced by a BayeuxServer.

send(ClientSession, Message.Mutable) - Method in interface org.cometd.bayeux.client.ClientSession.Extension

Callback method invoked every time a normal message is being sent.

send(ServerSession, ServerSession, ServerMessage.Mutable) - Method in interface org.cometd.bayeux.server.BayeuxServer.Extension

Callback method invoked every time a normal message is outgoing.

send(ServerSession, ServerMessage) - Method in interface org.cometd.bayeux.server.ServerSession.Extension

Callback method invoked every time a normal message is outgoing.

sendMeta(ClientSession, Message.Mutable) - Method in interface org.cometd.bayeux.client.ClientSession.Extension

Callback method invoked every time a meta message is being sent.

sendMeta(ServerSession, ServerMessage.Mutable) - Method in interface org.cometd.bayeux.server.BayeuxServer.Extension

Callback method invoked every time a meta message is outgoing.

sendMeta(ServerSession, ServerMessage.Mutable) - Method in interface org.cometd.bayeux.server.ServerSession.Extension

Callback method invoked every time a meta message is outgoing.

ServerChannel - Interface in org.cometd.bayeux.server

Server side representation of a Bayeux channel.

ServerChannel.MessageListener - Interface in org.cometd.bayeux.server

Listeners objects that implement this interface will be notified of message publish.

ServerChannel.ServerChannelListener - Interface in org.cometd.bayeux.server

Common interface for ServerChannel listeners.

ServerChannel.SubscriptionListener - Interface in org.cometd.bayeux.server

Listeners object that implement this interface will be notified of subscription events.

ServerMessage - Interface in org.cometd.bayeux.server

Representation of a server side message.

ServerMessage.Mutable - Interface in org.cometd.bayeux.server

The mutable version of a ServerMessage

ServerSession - Interface in org.cometd.bayeux.server

Objects implementing this interface are the server-side representation of remote Bayeux clients.

ServerSession.DeQueueListener - Interface in org.cometd.bayeux.server

Listeners objects that implement this interface will be notified when the session queue is being drained to actually deliver the messages.

ServerSession.Extension - Interface in org.cometd.bayeux.server

Extension API for ServerSession.

ServerSession.MaxQueueListener - Interface in org.cometd.bayeux.server

Listeners objects that implement this interface will be notified when the session queue is full.

ServerSession.MessageListener - Interface in org.cometd.bayeux.server

Listeners objects that implement this interface will be notified of message arrival.

ServerSession.RemoveListener - Interface in org.cometd.bayeux.server

Listeners objects that implement this interface will be notified of session removal.

ServerSession.ServerSessionListener - Interface in org.cometd.bayeux.server

Common interface for ServerSession listeners.

ServerTransport - Interface in org.cometd.bayeux.server

Server side extension of a Bayeux transport.

Session - Interface in org.cometd.bayeux

A Bayeux session represents a connection between a bayeux client and a bayeux server.

sessionAdded(ServerSession) - Method in interface org.cometd.bayeux.server.BayeuxServer.SessionListener

Callback invoked when a ServerSession has been added to a BayeuxServer object.

sessionRemoved(ServerSession, boolean) - Method in interface org.cometd.bayeux.server.BayeuxServer.SessionListener

Callback invoked when a ServerSession has been removed from a BayeuxServer object.

setAssociated(ServerMessage) - Method in interface org.cometd.bayeux.server.ServerMessage.Mutable

setAttribute(String, Object) - Method in interface org.cometd.bayeux.Session

Sets a named session attribute value.

setChannel(String) - Method in interface org.cometd.bayeux.Message.Mutable

setClientId(String) - Method in interface org.cometd.bayeux.Message.Mutable

setData(Object) - Method in interface org.cometd.bayeux.Message.Mutable

setId(String) - Method in interface org.cometd.bayeux.Message.Mutable

setLazy(boolean) - Method in interface org.cometd.bayeux.server.ConfigurableServerChannel

A lazy channel marks all messages published to it as lazy.

setLazy(boolean) - Method in interface org.cometd.bayeux.server.ServerMessage.Mutable

A lazy message does not provoke immediately delivery to the client but it will be delivered at first occasion or after a timeout expires

setOption(String, Object) - Method in interface org.cometd.bayeux.Bayeux

setPersistent(boolean) - Method in interface org.cometd.bayeux.server.ConfigurableServerChannel

A persistent channel is not removed when the last subscription is removed

setSecurityPolicy(SecurityPolicy) - Method in interface org.cometd.bayeux.server.BayeuxServer

setSuccessful(boolean) - Method in interface org.cometd.bayeux.Message.Mutable

startBatch() - Method in interface org.cometd.bayeux.Session

Deprecated. use Session.batch(Runnable)

subscribe(ClientSessionChannel.MessageListener) - Method in interface org.cometd.bayeux.client.ClientSessionChannel

subscribed(ServerSession, ServerChannel) - Method in interface org.cometd.bayeux.server.BayeuxServer.SubscriptionListener

Callback invoked when a ServerSession subscribes to a ServerChannel.

subscribed(ServerSession, ServerChannel) - Method in interface org.cometd.bayeux.server.ServerChannel.SubscriptionListener

Callback invoked when the given ServerSession subscribes to the given ServerChannel.

SUBSCRIPTION_FIELD - Static variable in interface org.cometd.bayeux.Message

SUCCESSFUL_FIELD - Static variable in interface org.cometd.bayeux.Message

SUPPORTED_CONNECTION_TYPES_FIELD - Static variable in interface org.cometd.bayeux.Message

T

TIMESTAMP_FIELD - Static variable in interface org.cometd.bayeux.Message

Transport - Interface in org.cometd.bayeux

A transport abstract the details of the protocol used to send Bayeux messages over the network, for example using HTTP or using WebSocket.

TRANSPORT_FIELD - Static variable in interface org.cometd.bayeux.Message

U

unsubscribe(ClientSessionChannel.MessageListener) - Method in interface org.cometd.bayeux.client.ClientSessionChannel

unsubscribe() - Method in interface org.cometd.bayeux.client.ClientSessionChannel

unsubscribed(ServerSession, ServerChannel) - Method in interface org.cometd.bayeux.server.BayeuxServer.SubscriptionListener

Callback invoked when a ServerSession unsubscribes from a ServerChannel.

unsubscribed(ServerSession, ServerChannel) - Method in interface org.cometd.bayeux.server.ServerChannel.SubscriptionListener

Callback invoked when the given ServerSession unsubscribes from the given ServerChannel.

V

VERSION_FIELD - Static variable in interface org.cometd.bayeux.Message

A B C D E G H I L M N O P Q R S T U V