org.apache.tomcat.bayeux.request

Class MetaSubscribeRequest

java.lang.Object

org.apache.tomcat.bayeux.RequestBase

org.apache.tomcat.bayeux.request.MetaSubscribeRequest

All Implemented Interfaces:

BayeuxRequest

public class MetaSubscribeRequest
extends RequestBase
implements BayeuxRequest

Handshake request Bayeux message.

Version:

1.0

Author:

Guy A. Molinari, Filip Hanik

Field Summary

Fields

Modifier and Type	Field and Description
protected static HashMap<String,Object>	responseTemplate

Fields inherited from class org.apache.tomcat.bayeux.RequestBase

channel, clientId, conType, data, desiredConnTypeFlag, event, ext, id, minVersion, reconnectInterval, response, subscription, suppConnTypes, suppConnTypesFlag, timestampFmt, tomcatBayeux, version

Fields inherited from interface org.apache.tomcat.bayeux.BayeuxRequest

CURRENT_REQ_ATTR, JSON_MSG_ARRAY, LAST_REQ_ATTR

Constructor Summary

Constructors

Constructor and Description
MetaSubscribeRequest(TomcatBayeux tb, HttpEvent event, JSONObject jsReq)

Method Summary

Modifier and Type	Method and Description
int	process(int prevops) Register interest for one or more channels.
HttpError	validate() Check client request for validity.

Methods inherited from class org.apache.tomcat.bayeux.RequestBase

addToDeliveryQueue, deliver, flushMessages, getChannel, getClientId, getEvent, getExt, getId, getJSONArray, getJSONArray, getReconnectInterval, getTimeStamp, getTomcatBayeux

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

responseTemplate

protected static HashMap<String,Object> responseTemplate

Constructor Detail

MetaSubscribeRequest

public MetaSubscribeRequest(TomcatBayeux tb,
                            HttpEvent event,
                            JSONObject jsReq)
                     throws JSONException

Throws:

JSONException

Method Detail

validate

public HttpError validate()

Check client request for validity. Per section 4.5.1 of the Bayuex spec a connect request must contain: 1) The "/meta/subscribe" channel identifier. 2) The clientId. 3) The subscription. This is the name of the channel of interest, or a pattern.

Specified by:

validate in interface BayeuxRequest

Overrides:

validate in class RequestBase

Returns:

HttpError This method returns null if no errors were found

process

public int process(int prevops)
            throws BayeuxException

Register interest for one or more channels. Per section 2.2.1 of the Bayeux spec, a pattern may be specified. Assign client to matching channels and inverse client to channel reference.

Specified by:

process in interface BayeuxRequest

Overrides:

process in class RequestBase

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.