org.cometd.bayeux
Interface Message

All Superinterfaces:
java.util.Map<java.lang.String,java.lang.Object>
All Known Subinterfaces:
Message.Mutable, ServerMessage, ServerMessage.Mutable

public interface Message
extends java.util.Map<java.lang.String,java.lang.Object>

Bayeux Message interface.

The API of a bayeux message, which consists mainly of convenience methods to access the known fields of the message map.

This interface comes in both an Immutable and Mutable variation. Mutability may be deeply enforced by an implementation, so that it is not correct to cast a passed Message, to a Message.Mutable, even if the implementation allows this.


Nested Class Summary
static interface Message.Mutable
           
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
static java.lang.String ADVICE_FIELD
           
static java.lang.String CHANNEL_FIELD
           
static java.lang.String CLIENT_FIELD
           
static java.lang.String CONNECTION_TYPE_FIELD
           
static java.lang.String DATA_FIELD
           
static java.lang.String ERROR_FIELD
           
static java.lang.String EXT_FIELD
           
static java.lang.String ID_FIELD
           
static java.lang.String INTERVAL_FIELD
           
static java.lang.String MIN_VERSION_FIELD
           
static java.lang.String RECONNECT_FIELD
           
static java.lang.String RECONNECT_HANDSHAKE_VALUE
           
static java.lang.String RECONNECT_NONE_VALUE
           
static java.lang.String RECONNECT_RETRY_VALUE
           
static java.lang.String SERVICE
           
static java.lang.String SUBSCRIPTION_FIELD
           
static java.lang.String SUCCESSFUL_FIELD
           
static java.lang.String SUPPORTED_CONNECTION_TYPES_FIELD
           
static java.lang.String TIMESTAMP_FIELD
           
static java.lang.String TRANSPORT_FIELD
           
static java.lang.String VERSION_FIELD
           
 
Method Summary
 java.util.Map<java.lang.String,java.lang.Object> getAdvice()
           
 java.lang.String getChannel()
           
 java.lang.String getClientId()
           
 java.lang.Object getData()
           
 java.util.Map<java.lang.String,java.lang.Object> getDataAsMap()
           
 java.util.Map<java.lang.String,java.lang.Object> getExt()
           
 java.lang.Object getId()
           
 java.lang.String getJSON()
           
 boolean isMeta()
           
 boolean isSuccessful()
           
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Field Detail

CLIENT_FIELD

static final java.lang.String CLIENT_FIELD
See Also:
Constant Field Values

DATA_FIELD

static final java.lang.String DATA_FIELD
See Also:
Constant Field Values

CHANNEL_FIELD

static final java.lang.String CHANNEL_FIELD
See Also:
Constant Field Values

ID_FIELD

static final java.lang.String ID_FIELD
See Also:
Constant Field Values

ERROR_FIELD

static final java.lang.String ERROR_FIELD
See Also:
Constant Field Values

TIMESTAMP_FIELD

static final java.lang.String TIMESTAMP_FIELD
See Also:
Constant Field Values

TRANSPORT_FIELD

static final java.lang.String TRANSPORT_FIELD
See Also:
Constant Field Values

ADVICE_FIELD

static final java.lang.String ADVICE_FIELD
See Also:
Constant Field Values

SUCCESSFUL_FIELD

static final java.lang.String SUCCESSFUL_FIELD
See Also:
Constant Field Values

SUBSCRIPTION_FIELD

static final java.lang.String SUBSCRIPTION_FIELD
See Also:
Constant Field Values

EXT_FIELD

static final java.lang.String EXT_FIELD
See Also:
Constant Field Values

CONNECTION_TYPE_FIELD

static final java.lang.String CONNECTION_TYPE_FIELD
See Also:
Constant Field Values

VERSION_FIELD

static final java.lang.String VERSION_FIELD
See Also:
Constant Field Values

MIN_VERSION_FIELD

static final java.lang.String MIN_VERSION_FIELD
See Also:
Constant Field Values

SUPPORTED_CONNECTION_TYPES_FIELD

static final java.lang.String SUPPORTED_CONNECTION_TYPES_FIELD
See Also:
Constant Field Values

RECONNECT_FIELD

static final java.lang.String RECONNECT_FIELD
See Also:
Constant Field Values

INTERVAL_FIELD

static final java.lang.String INTERVAL_FIELD
See Also:
Constant Field Values

RECONNECT_RETRY_VALUE

static final java.lang.String RECONNECT_RETRY_VALUE
See Also:
Constant Field Values

RECONNECT_HANDSHAKE_VALUE

static final java.lang.String RECONNECT_HANDSHAKE_VALUE
See Also:
Constant Field Values

RECONNECT_NONE_VALUE

static final java.lang.String RECONNECT_NONE_VALUE
See Also:
Constant Field Values

SERVICE

static final java.lang.String SERVICE
See Also:
Constant Field Values
Method Detail

getAdvice

java.util.Map<java.lang.String,java.lang.Object> getAdvice()

getChannel

java.lang.String getChannel()

getClientId

java.lang.String getClientId()

getData

java.lang.Object getData()

isMeta

boolean isMeta()

isSuccessful

boolean isSuccessful()

getDataAsMap

java.util.Map<java.lang.String,java.lang.Object> getDataAsMap()

getExt

java.util.Map<java.lang.String,java.lang.Object> getExt()

getId

java.lang.Object getId()

getJSON

java.lang.String getJSON()


Copyright © 2010 Dojo Foundation. All Rights Reserved.