|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Bayeux
Bayeux Interface. This interface represents the server side API for the Bayeux messaging protocol.
The implementation of Bayeux will be registered as a ServletContext
attribute
with the name "dojox.cometd.bayeux". This may be set prior to the context being initialized
(if the instance is shared between contexts) or during context initialization.
Bayeux implementations must be thread safe and multiple threads may simultaneously call Bayeux methods.
Field Summary | |
---|---|
static String |
ADVICE_FIELD
Field names inside Bayeux messages - advice field |
static String |
CHANNEL_FIELD
Field names inside Bayeux messages - channel field |
static String |
CLIENT_FIELD
Field names inside Bayeux messages - clientId field |
static String |
CONNECTION_TYPE_FIELD
Field names inside Bayeux messages - connectionType field |
static String |
DATA_FIELD
Field names inside Bayeux messages - data field |
static String |
DOJOX_COMETD_BAYEUX
ServletContext attribute name used to obtain the Bayeux object |
static String |
ERROR_FIELD
Field names inside Bayeux messages - error field |
static String |
EXT_FIELD
Field names inside Bayeux messages - ext field |
static String |
HANDSHAKE_RESPONSE
Field values inside Bayeux messages - handshake response |
static String |
ID_FIELD
Field names inside Bayeux messages - id field |
static String |
INTERVAL_FIELD
Field names inside Bayeux messages - interval field |
static String |
JSON_COMMENT_FILTERED_FIELD
Field names inside Bayeux messages - json-comment-filtered field |
static String |
JSON_CONTENT_TYPE
http helpers - text/json content type |
static String |
JSONP_DEFAULT_NAME
http helpers - default name of the jsonp callback function |
static String |
JSONP_PARAMETER
http helpers - name of the jsonp parameter |
static String |
MESSAGE_PARAMETER
http helpers - parameter name for json message |
static String |
META
Meta definitions for channels |
static String |
META_CLIENT
Meta definitions for channels - client messsage |
static String |
META_CONNECT
Meta definitions for channels - connect message |
static String |
META_DISCONNECT
Meta definitions for channels - disconnect messsage |
static String |
META_HANDSHAKE
Meta definitions for channels - handshake messsage |
static String |
META_PING
Meta definitions for channels - ping messsage |
static String |
META_SLASH
Meta definitions for channels |
static String |
META_STATUS
Meta definitions for channels - status messsage |
static String |
META_SUBSCRIBE
Meta definitions for channels - subscribe messsage |
static String |
META_UNSUBSCRIBE
Meta definitions for channels - unsubscribe messsage |
static String |
MIN_VERSION_FIELD
Field names inside Bayeux messages - minimumVersion field |
static String |
NONE_RESPONSE
Field values inside Bayeux messages - none response |
static String |
RECONNECT_FIELD
Field names inside Bayeux messages - reconnect field |
static String |
RETRY_RESPONSE
Field values inside Bayeux messages - retry response |
static String |
SERVICE
Service channel names-starts with |
static String |
SERVICE_SLASH
Service channel names-trailing slash |
static String |
SUBSCRIPTION_FIELD
Field names inside Bayeux messages - subscription field |
static String |
SUCCESSFUL_FIELD
Field names inside Bayeux messages - successful field |
static String |
SUPP_CONNECTION_TYPE_FIELD
Field names inside Bayeux messages - supportedConnectionTypes field |
static String |
TIMESTAMP_FIELD
Field names inside Bayeux messages - timestamp field |
static String |
TRANSPORT_CALLBACK_POLL
Transport types - callback polling |
static String |
TRANSPORT_FIELD
Field names inside Bayeux messages - transport field |
static String |
TRANSPORT_FLASH
Transport types - flash |
static String |
TRANSPORT_IFRAME
Transport types - iframe |
static String |
TRANSPORT_LONG_POLL
Transport types - long polling |
static String |
VERSION_FIELD
Field names inside Bayeux messages - version field |
Field Detail |
---|
static final String META
static final String META_SLASH
static final String META_CONNECT
static final String META_CLIENT
static final String META_DISCONNECT
static final String META_HANDSHAKE
static final String META_PING
static final String META_STATUS
static final String META_SUBSCRIBE
static final String META_UNSUBSCRIBE
static final String CLIENT_FIELD
static final String DATA_FIELD
static final String CHANNEL_FIELD
static final String ID_FIELD
static final String ERROR_FIELD
static final String TIMESTAMP_FIELD
static final String TRANSPORT_FIELD
static final String ADVICE_FIELD
static final String SUCCESSFUL_FIELD
static final String SUBSCRIPTION_FIELD
static final String EXT_FIELD
static final String CONNECTION_TYPE_FIELD
static final String VERSION_FIELD
static final String MIN_VERSION_FIELD
static final String SUPP_CONNECTION_TYPE_FIELD
static final String JSON_COMMENT_FILTERED_FIELD
static final String RECONNECT_FIELD
static final String INTERVAL_FIELD
static final String RETRY_RESPONSE
static final String HANDSHAKE_RESPONSE
static final String NONE_RESPONSE
static final String SERVICE
static final String SERVICE_SLASH
static final String TRANSPORT_LONG_POLL
static final String TRANSPORT_CALLBACK_POLL
static final String TRANSPORT_IFRAME
static final String TRANSPORT_FLASH
static final String DOJOX_COMETD_BAYEUX
static final String JSON_CONTENT_TYPE
static final String MESSAGE_PARAMETER
static final String JSONP_PARAMETER
static final String JSONP_DEFAULT_NAME
Method Detail |
---|
void addFilter(String channels, DataFilter filter)
Channel.addDataFilter(DataFilter)
void deliver(Client fromClient, Client toClient, String toChannel, Message message)
Client.deliver(Client, Message)
Channel getChannel(String channelId, boolean create)
channelId
- The Channel IDcreate
- If true, a channel will be created if it does not exist.
Collection<Channel> getChannels()
Client getClient(String clientId)
Collection<Client> getClients()
SecurityPolicy getSecurityPolicy()
boolean hasChannel(String channel)
boolean hasClient(String clientId)
Client newClient(String idprefix, Listener listener)
newClient(String)
Client newClient(String idprefix)
void publish(Client fromClient, String toChannel, Object data, String msgId)
Channel.publish(Client, Object, String)
fromClient
- The client sending the datadata
- The data itself which must be an Object that can be encoded with JSON
.toChannel
- The Channel ID to which the data is targettedmsgId
- optional message ID or null for automatic generation of a message ID.Channel removeChannel(String channel)
Client removeClient(String clientId)
void removeFilter(String channels, DataFilter filter)
Channel.removeDataFilter(DataFilter)
void setSecurityPolicy(SecurityPolicy securityPolicy)
The Security Policy will be called to check access for all handshakes, subscriptions and publishing.
securityPolicy
- The security policy instance.void subscribe(String toChannel, Client subscriber)
Channel.subscribe(Client)
toChannel
- subscriber
- createChannel.
- Create the channel if it does not existvoid unsubscribe(String toChannel, Client subscriber)
Channel.unsubscribe(Client)
toChannel
- subscriber
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |