net.officefloor.plugin.bayeux.transport

Interface TransportMessage

All Superinterfaces:

Map<String,Object>, org.cometd.bayeux.Message, org.cometd.bayeux.server.ServerMessage

All Known Subinterfaces:

TransportMessage.TransportMutable

All Known Implementing Classes:

MessageImpl

public interface TransportMessage
extends org.cometd.bayeux.server.ServerMessage

Transport Message.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TransportMessage.TransportMutable Mutable TransportMessage.

Nested classes/interfaces inherited from interface org.cometd.bayeux.server.ServerMessage

org.cometd.bayeux.server.ServerMessage.Mutable

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_SUCCESSFUL_FIELD Name of "authSuccessful" field.

Fields inherited from interface org.cometd.bayeux.Message

ADVICE_FIELD, CHANNEL_FIELD, CLIENT_ID_FIELD, CONNECTION_TYPE_FIELD, DATA_FIELD, ERROR_FIELD, EXT_FIELD, ID_FIELD, INTERVAL_FIELD, MIN_VERSION_FIELD, RECONNECT_FIELD, RECONNECT_HANDSHAKE_VALUE, RECONNECT_NONE_VALUE, RECONNECT_RETRY_VALUE, SUBSCRIPTION_FIELD, SUCCESSFUL_FIELD, SUPPORTED_CONNECTION_TYPES_FIELD, TIMEOUT_FIELD, TIMESTAMP_FIELD, TRANSPORT_FIELD, VERSION_FIELD

Method Summary

Modifier and Type	Method and Description
String[]	getConnectionType() Obtains the Message.CONNECTION_TYPE_FIELD.
String	getError() Obtains the Message.ERROR_FIELD.
String	getSubscription() Obtains the Message.SUBSCRIPTION_FIELD.
String[]	getSupportedConnectionTypes() Obtains the Message.SUPPORTED_CONNECTION_TYPES_FIELD.
String	getVersion() Obtains the Message.VERSION_FIELD.
Boolean	isAuthSuccessful() Obtains the AUTH_SUCCESSFUL_FIELD.

Methods inherited from interface org.cometd.bayeux.server.ServerMessage

getAssociated, isLazy

Methods inherited from interface org.cometd.bayeux.Message

getAdvice, getChannel, getChannelId, getClientId, getData, getDataAsMap, getExt, getId, getJSON, isMeta, isPublishReply, isSuccessful

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail

AUTH_SUCCESSFUL_FIELD

static final String AUTH_SUCCESSFUL_FIELD

Name of "authSuccessful" field.

See Also:

Constant Field Values

Method Detail

getVersion

String getVersion()

Obtains the Message.VERSION_FIELD.

Returns:

Version.

getSupportedConnectionTypes

String[] getSupportedConnectionTypes()

Obtains the Message.SUPPORTED_CONNECTION_TYPES_FIELD.

Returns:

Supported connection types.

getConnectionType

String[] getConnectionType()

Obtains the Message.CONNECTION_TYPE_FIELD.

Returns:

Connection type.

isAuthSuccessful

Boolean isAuthSuccessful()

Obtains the AUTH_SUCCESSFUL_FIELD.

Returns:

Indicates if authentication successful.

getSubscription

String getSubscription()

Obtains the Message.SUBSCRIPTION_FIELD.

Returns:

Subscription.

getError

String getError()

Obtains the Message.ERROR_FIELD.

Returns:

Error.