org.apache.tomcat.bayeux
Interface BayeuxRequest

All Known Implementing Classes:

MetaConnectRequest, MetaDisconnectRequest, MetaHandshakeRequest, MetaSubscribeRequest, MetaUnsubscribeRequest, PublishRequest, RequestBase

public interface BayeuxRequest

An interface that defines methods for managing Bayeux request meta messages.

Version:

0.9

Author:

Guy A. Molinari, Filip Hanik

Field Summary

static java.lang.String	CURRENT_REQ_ATTR
static java.lang.String	JSON_MSG_ARRAY
static java.lang.String	LAST_REQ_ATTR

Method Summary

int	process(int prevops) processes a remote client Bayeux message
HttpError	validate() Validates a specific request.

Field Detail

LAST_REQ_ATTR

static final java.lang.String LAST_REQ_ATTR

See Also:

Constant Field Values

CURRENT_REQ_ATTR

static final java.lang.String CURRENT_REQ_ATTR

See Also:

Constant Field Values

JSON_MSG_ARRAY

static final java.lang.String JSON_MSG_ARRAY

See Also:

Constant Field Values

Method Detail

validate

HttpError validate()

Validates a specific request. This method must be called prior to process() as a request can do pre processing in the validate method.
Should the validation fail, an error object is returned containing an error message, and potentially a stack trace if an exception was generated

Returns:

HttpError - null if no error was detected, an HttpError object containing information about the error.

process

int process(int prevops)
            throws BayeuxException

processes a remote client Bayeux message

Parameters:

prevops - - the operation requested by the previous request, in case of chained requests.

Returns:

int - returns the interest operation for a CometEvent. Currently not used

Throws:

BayeuxException - - if an error was detected, and the appropriate error response couldn't be delivered to the client.