com.sun.grizzly.cometd.bayeux
Class Advice

java.lang.Object
  com.sun.grizzly.cometd.bayeux.VerbBase
      com.sun.grizzly.cometd.bayeux.Advice

All Implemented Interfaces:

Verb

public class Advice
extends VerbBase

Bayeux Advise implementation. See http://svn.xantus.org/shortbus/trunk/bayeux/protocol.txt for the technical details. The advice system provides a way for servers to inform clients of their preferred mode of client operation. In conjunction with server-enforced limits, Bayeux implementations can prevent resource exhaustion and inelegant failure in several important edge cases. Since transport evenlopes are "pluggable" in order to support differing "on the wire" behaviors, advice values may also vary by transport type, even for the same conditions. What follows is a breif description of the enumerations that are used in advices and their canonical meanings.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.grizzly.cometd.bayeux.Verb

Verb.Type

Field Summary

Fields inherited from class com.sun.grizzly.cometd.bayeux.VerbBase

advice, authToken, channel, clientId, data, dataId, error, ext, first, follow, id, last, metaChannel, successful, type

Constructor Summary

Advice()

Method Summary

java.lang.String[]	getHosts()
java.lang.Integer	getInterval()
java.lang.Boolean	getMultipleClients()
java.lang.String	getReconnect()
java.lang.String	getTransport()
boolean	isValid() Check whether the Verb is valid.
void	setHosts(java.lang.String[] hosts)
void	setInterval(java.lang.Integer interval)
void	setMultipleClients(java.lang.Boolean multipleClients)
void	setReconnect(java.lang.String reconnect)
void	setTransport(java.lang.String transport)
java.lang.String	toJSON() Return the JSON representation of the Verb.
java.lang.String	toString()

Methods inherited from class com.sun.grizzly.cometd.bayeux.VerbBase

getAdvice, getAuthToken, getChannel, getClientId, getData, getDataId, getExt, getId, getJSONPostfix, getJSONPrefix, getMetaChannel, getType, hasValidAdvice, isFirst, isFollow, isLast, setAdvice, setAuthToken, setChannel, setClientId, setData, setDataId, setExt, setFirst, setFollow, setId, setLast

Methods inherited from class java.lang.Object

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

Constructor Detail

Advice

public Advice()

Method Detail

getReconnect

public java.lang.String getReconnect()

setReconnect

public void setReconnect(java.lang.String reconnect)

getInterval

public java.lang.Integer getInterval()

setInterval

public void setInterval(java.lang.Integer interval)

getMultipleClients

public java.lang.Boolean getMultipleClients()

setMultipleClients

public void setMultipleClients(java.lang.Boolean multipleClients)

getHosts

public java.lang.String[] getHosts()

setHosts

public void setHosts(java.lang.String[] hosts)

toString

public java.lang.String toString()

Overrides:

toString in class VerbBase

toJSON

public java.lang.String toJSON()

Description copied from interface: Verb

Return the JSON representation of the Verb.

getTransport

public java.lang.String getTransport()

setTransport

public void setTransport(java.lang.String transport)

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