com.sun.grizzly.cometd.bayeux
Class UnsubscribeRequest

java.lang.Object
  extended by com.sun.grizzly.cometd.bayeux.VerbBase
      extended by com.sun.grizzly.cometd.bayeux.UnsubscribeRequest
All Implemented Interfaces:
Verb

public class UnsubscribeRequest
extends VerbBase

Bayeux Unsubscribe implementation. See http://svn.xantus.org/shortbus/trunk/bayeux/protocol.txt for the technical details. // unsubscription for same: //----------------- // CLIENT -> SERVER //----------------- [ { "channel": "/meta/unsubscribe", "subscription": "/some/other/channel", // optional "authToken": "SOME_NONCE_PREVIOUSLY_PROVIDED_BY_SERVER" } // , ... ] // and the server response: //----------------- // SERVER -> CLIENT //----------------- [ { "channel": "/meta/unsubscribe", "subscription": "/some/other/channel", "successful": true, "clientId": "SOME_UNIQUE_CLIENT_ID", "error": "", // optional "authToken": "SOME_NONCE" } // , ... ]

Author:
Jeanfrancois Arcand

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.sun.grizzly.cometd.bayeux.Verb
Verb.Type
 
Field Summary
protected  String clientId
           
static String META_SUBSCRIBE
           
static String META_UNSUBSCRIBE
           
protected  String subscription
           
 
Fields inherited from class com.sun.grizzly.cometd.bayeux.VerbBase
advice, authToken, channel, data, dataId, error, ext, first, follow, id, last, successful, type
 
Constructor Summary
UnsubscribeRequest()
           
 
Method Summary
protected  String getBody(boolean isResponse, String timestamp)
           
 String getClientId()
           
protected  String getMetaChannel()
           
 String getSubscription()
           
 boolean isValid()
          Check whether the Verb is valid.
 void setClientId(String clientId)
           
 void setSubscription(String subscription)
           
 String toJSON()
          Return the JSON representation of the Verb.
 
Methods inherited from class com.sun.grizzly.cometd.bayeux.VerbBase
getAdvice, getAuthToken, getChannel, getData, getDataId, getExt, getId, getJSONPostfix, getJSONPrefix, getType, hasValidAdvice, isFirst, isFollow, isLast, setAdvice, setAuthToken, setChannel, setData, setDataId, setExt, setFirst, setFollow, setId, setLast, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

META_UNSUBSCRIBE

public static final String META_UNSUBSCRIBE
See Also:
Constant Field Values

META_SUBSCRIBE

public static final String META_SUBSCRIBE
See Also:
Constant Field Values

subscription

protected String subscription

clientId

protected String clientId
Constructor Detail

UnsubscribeRequest

public UnsubscribeRequest()
Method Detail

toJSON

public String toJSON()
Description copied from interface: Verb
Return the JSON representation of the Verb.


getMetaChannel

protected String getMetaChannel()

getSubscription

public String getSubscription()

setSubscription

public void setSubscription(String subscription)

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

isValid

public boolean isValid()
Description copied from interface: Verb
Check whether the Verb is valid.

Specified by:
isValid in interface Verb
Overrides:
isValid in class VerbBase

getBody

protected String getBody(boolean isResponse,
                         String timestamp)
Parameters:
isResponse -
printTimestamp - for UnsubscribeResponse


Copyright © 2010 SUN Microsystems. All Rights Reserved.