Package org.atmosphere.cpr

Interface HeaderConfig

public interface HeaderConfig

This interface contains all Atmosphere headers shared between the client and the server.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_CONTROL_ALLOW_CREDENTIALS
static final String	ACCESS_CONTROL_ALLOW_ORIGIN
static final String	ATMOSPHERE_POST_BODY
static final String	CACHE_CONTROL
static final String	DISCONNECT_TRANSPORT_MESSAGE
static final String	EXPIRES
static final String	FORCE_BINARY
static final String	GRPC_TRANSPORT
static final String	LONG_POLLING_TRANSPORT
static final String	POLLING_TRANSPORT
static final String	PRAGMA
static final String	SSE_TRANSPORT
static final String	STREAMING_TRANSPORT
static final String	WEBSOCKET_TRANSPORT
static final String	WEBSOCKET_UPGRADE
static final String	WEBSOCKET_X_ATMOSPHERE_TRANSPORT
static final String	X_ATMO_BINARY
static final String	X_ATMO_PROTOCOL
static final String	X_ATMO_WEBSOCKET_PROXY
static final String	X_ATMOSPHERE
static final String	X_ATMOSPHERE_ACK	Server acknowledgment of a received message.
static final String	X_ATMOSPHERE_AUTH	Header carrying the authentication token.
static final String	X_ATMOSPHERE_AUTH_EXPIRED	Header sent by the server to indicate the token has expired and no refresh was possible.
static final String	X_ATMOSPHERE_AUTH_REFRESH	Header sent by the server when a refreshed token is available.
static final String	X_ATMOSPHERE_ERROR	When a unexpected error occurs.
static final String	X_ATMOSPHERE_FIRSTLONGPOLLING_DONE	If long-polling is used during a POST, this header is added after the first successful response.
static final String	X_ATMOSPHERE_FRAMEWORK	The current version of Atmosphere Framework.
static final String	X_ATMOSPHERE_MESSAGE_ID	Client-assigned message ID for acknowledgment tracking.
static final String	X_ATMOSPHERE_TRACKING_ID	The unique tracking ID generated by the server.
static final String	X_ATMOSPHERE_TRACKMESSAGESIZE	The message size sent by Atmosphere.
static final String	X_ATMOSPHERE_TRANSPORT	The current transport used.
static final String	X_FIRST_REQUEST
static final String	X_HEARTBEAT_SERVER	The desired heartbeat interval in seconds sent by the server and asked by the client.

Field Details

X_ATMOSPHERE_FIRSTLONGPOLLING_DONE

static final String X_ATMOSPHERE_FIRSTLONGPOLLING_DONE

If long-polling is used during a POST, this header is added after the first successful response.

See Also:

• Constant Field Values

X_ATMOSPHERE_TRANSPORT

static final String X_ATMOSPHERE_TRANSPORT

The current transport used.

See Also:

• Constant Field Values

LONG_POLLING_TRANSPORT

static final String LONG_POLLING_TRANSPORT

See Also:

• Constant Field Values

STREAMING_TRANSPORT

static final String STREAMING_TRANSPORT

See Also:

• Constant Field Values

POLLING_TRANSPORT

static final String POLLING_TRANSPORT

See Also:

• Constant Field Values

WEBSOCKET_TRANSPORT

static final String WEBSOCKET_TRANSPORT

See Also:

• Constant Field Values

SSE_TRANSPORT

static final String SSE_TRANSPORT

See Also:

• Constant Field Values

GRPC_TRANSPORT

static final String GRPC_TRANSPORT

See Also:

• Constant Field Values

DISCONNECT_TRANSPORT_MESSAGE

static final String DISCONNECT_TRANSPORT_MESSAGE

See Also:

• Constant Field Values

WEBSOCKET_X_ATMOSPHERE_TRANSPORT

static final String WEBSOCKET_X_ATMOSPHERE_TRANSPORT

See Also:

• Constant Field Values

X_FIRST_REQUEST

static final String X_FIRST_REQUEST

See Also:

• Constant Field Values

X_ATMOSPHERE_ERROR

static final String X_ATMOSPHERE_ERROR

When a unexpected error occurs.

See Also:

• Constant Field Values

X_ATMOSPHERE_TRACKING_ID

static final String X_ATMOSPHERE_TRACKING_ID

The unique tracking ID generated by the server.

See Also:

• Constant Field Values

X_ATMOSPHERE_FRAMEWORK

static final String X_ATMOSPHERE_FRAMEWORK

The current version of Atmosphere Framework.

See Also:

• Constant Field Values

X_HEARTBEAT_SERVER

static final String X_HEARTBEAT_SERVER

The desired heartbeat interval in seconds sent by the server and asked by the client.

See Also:

• Constant Field Values

X_ATMOSPHERE

static final String X_ATMOSPHERE

See Also:

• Constant Field Values

X_ATMOSPHERE_TRACKMESSAGESIZE

static final String X_ATMOSPHERE_TRACKMESSAGESIZE

The message size sent by Atmosphere.

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_ORIGIN

static final String ACCESS_CONTROL_ALLOW_ORIGIN

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_CREDENTIALS

static final String ACCESS_CONTROL_ALLOW_CREDENTIALS

See Also:

• Constant Field Values

PRAGMA

static final String PRAGMA

See Also:

• Constant Field Values

CACHE_CONTROL

static final String CACHE_CONTROL

See Also:

• Constant Field Values

EXPIRES

static final String EXPIRES

See Also:

• Constant Field Values

WEBSOCKET_UPGRADE

static final String WEBSOCKET_UPGRADE

See Also:

• Constant Field Values

ATMOSPHERE_POST_BODY

static final String ATMOSPHERE_POST_BODY

See Also:

• Constant Field Values

X_ATMO_PROTOCOL

static final String X_ATMO_PROTOCOL

See Also:

• Constant Field Values

X_ATMO_BINARY

static final String X_ATMO_BINARY

See Also:

• Constant Field Values

X_ATMO_WEBSOCKET_PROXY

static final String X_ATMO_WEBSOCKET_PROXY

See Also:

• Constant Field Values

FORCE_BINARY

static final String FORCE_BINARY

See Also:

• Constant Field Values

X_ATMOSPHERE_AUTH

static final String X_ATMOSPHERE_AUTH

Header carrying the authentication token. Used by long-polling (fetch) requests which can set custom headers. WebSocket and SSE use the query parameter instead.

See Also:

• Constant Field Values

X_ATMOSPHERE_AUTH_REFRESH

static final String X_ATMOSPHERE_AUTH_REFRESH

Header sent by the server when a refreshed token is available. The client should store this and use it for subsequent requests.

See Also:

• Constant Field Values

X_ATMOSPHERE_AUTH_EXPIRED

static final String X_ATMOSPHERE_AUTH_EXPIRED

Header sent by the server to indicate the token has expired and no refresh was possible. The client should re-authenticate.

See Also:

• Constant Field Values

X_ATMOSPHERE_MESSAGE_ID

static final String X_ATMOSPHERE_MESSAGE_ID

Client-assigned message ID for acknowledgment tracking. Sent by the client; echoed back in X_ATMOSPHERE_ACK.

See Also:

• Constant Field Values

X_ATMOSPHERE_ACK

static final String X_ATMOSPHERE_ACK

Server acknowledgment of a received message. Contains the message ID.

See Also:

• Constant Field Values