org.atmosphere.samples.pubsub

Class PubSub

java.lang.Object

org.atmosphere.samples.pubsub.PubSub

public class PubSub
extends java.lang.Object

Simple PubSub resource that demonstrate many functionality supported by Atmosphere.

Author:

Jeanfrancois Arcand

Constructor Summary

Constructors

Constructor and Description
PubSub()

Method Summary

Modifier and Type	Method and Description
org.atmosphere.jersey.Broadcastable	aggregate(java.lang.String message) Retain Broadcast events until we have enough data.
org.atmosphere.jersey.Broadcastable	buffer(java.lang.String message) Buffer the first broadcast events until the second one happens.
org.atmosphere.jersey.Broadcastable	delayPublish(java.lang.String message) Delay for 5 seconds the executionof Broadcaster.broadcast(java.lang.Object) operation
org.atmosphere.jersey.Broadcastable	delayPublishAndResume(java.lang.String message)
org.atmosphere.jersey.Broadcastable	delaySchedule(java.lang.String message) Wait 5 seconds and then execute periodic Broadcaster.broadcast(java.lang.Object) operations.
void	destroy()
java.lang.String	manualDelayBroadcast(java.lang.String message) Use the Broadcaster.delayBroadcast(java.lang.Object) directly instead of using the annotation.
org.atmosphere.jersey.Broadcastable	publish(java.lang.String message) Broadcast messahge to this server and also to other server using JGroups
org.atmosphere.jersey.Broadcastable	publishWithXML(java.lang.String message) ' Broadcast XML data using JAXB
org.atmosphere.jersey.Broadcastable	schedule(java.lang.String message) Execute periodic Broadcaster.broadcast(java.lang.Object) operation.
org.atmosphere.jersey.Broadcastable	scheduleAndResume(java.lang.String message) Execute periodic Broadcaster.broadcast(java.lang.Object) operation and resume the suspended connection after the first broadcast operation.
org.atmosphere.jersey.Broadcastable	subscribe() Suspend the response, and register a AtmosphereResourceEventListener that get notified when events occurs like client disconnection, broadcast or when the response get resumed.
org.atmosphere.jersey.Broadcastable	subscribeAndResume() Suspend the response, and tell teh framework to resume the response \ when the first @Broadcast operation occurs.
java.lang.String	subscribeAndResumeUsingExternalThread(java.lang.String topic) Suspend the response, and register a AtmosphereResourceEventListener that get notified when events occurs like client disconnection, broadcast or when the response get resumed.
org.atmosphere.jersey.Broadcastable	timeout() Timeout the resource

Methods inherited from class java.lang.Object

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

Constructor Detail

PubSub

public PubSub()

Method Detail

destroy

@PreDestroy
public void destroy()

subscribe

@Suspend(listeners=EventsLogger.class)
public org.atmosphere.jersey.Broadcastable subscribe()

Suspend the response, and register a AtmosphereResourceEventListener that get notified when events occurs like client disconnection, broadcast or when the response get resumed.

Returns:

A Broadcastable used to broadcast events.

subscribeAndResumeUsingExternalThread

@Suspend(resumeOnBroadcast=true,
         listeners=EventsLogger.class)
public java.lang.String subscribeAndResumeUsingExternalThread(java.lang.String topic)

Suspend the response, and register a AtmosphereResourceEventListener that get notified when events occurs like client disconnection, broadcast or when the response get resumed.

Returns:

A Broadcastable used to broadcast events.

subscribeAndResume

@Suspend(resumeOnBroadcast=true,
         listeners=EventsLogger.class)
public org.atmosphere.jersey.Broadcastable subscribeAndResume()

Suspend the response, and tell teh framework to resume the response \ when the first @Broadcast operation occurs.

Returns:

A Broadcastable used to broadcast events.

publishWithXML

public org.atmosphere.jersey.Broadcastable publishWithXML(java.lang.String message)

' Broadcast XML data using JAXB

Parameters:

message - A String from an HTML form

Returns:

A Broadcastable used to broadcast events.

publish

public org.atmosphere.jersey.Broadcastable publish(java.lang.String message)

Broadcast messahge to this server and also to other server using JGroups

Parameters:

message - A String from an HTML form

Returns:

A Broadcastable used to broadcast events.

aggregate

public org.atmosphere.jersey.Broadcastable aggregate(java.lang.String message)

Retain Broadcast events until we have enough data. See the StringFilterAggregator to configure the amount of data buffered before the events gets written back to the set of suspended response.

Parameters:

message - A String from an HTML form

Returns:

A Broadcastable used to broadcast events.

scheduleAndResume

public org.atmosphere.jersey.Broadcastable scheduleAndResume(java.lang.String message)

Execute periodic Broadcaster.broadcast(java.lang.Object) operation and resume the suspended connection after the first broadcast operation.

Parameters:

message - A String from an HTML form

Returns:

A Broadcastable used to broadcast events.

delaySchedule

public org.atmosphere.jersey.Broadcastable delaySchedule(java.lang.String message)

Wait 5 seconds and then execute periodic Broadcaster.broadcast(java.lang.Object) operations.

Parameters:

message - A String from an HTML form

Returns:

A Broadcastable used to broadcast events.

schedule

public org.atmosphere.jersey.Broadcastable schedule(java.lang.String message)

Execute periodic Broadcaster.broadcast(java.lang.Object) operation.

Parameters:

message - A String from an HTML form

Returns:

A Broadcastable used to broadcast events.

delayPublish

public org.atmosphere.jersey.Broadcastable delayPublish(java.lang.String message)

Delay for 5 seconds the executionof Broadcaster.broadcast(java.lang.Object) operation

Parameters:

message - A String from an HTML form

Returns:

A Broadcastable used to broadcast events.

delayPublishAndResume

public org.atmosphere.jersey.Broadcastable delayPublishAndResume(java.lang.String message)

buffer

public org.atmosphere.jersey.Broadcastable buffer(java.lang.String message)

Buffer the first broadcast events until the second one happens.

Parameters:

message - A String from an HTML form

Returns:

A Broadcastable used to broadcast events.

manualDelayBroadcast

public java.lang.String manualDelayBroadcast(java.lang.String message)

Use the Broadcaster.delayBroadcast(java.lang.Object) directly instead of using the annotation.

Parameters:

message - A String from an HTML form

Returns:

A Broadcastable used to broadcast events.

timeout

@Suspend(period=60,
         timeUnit=SECONDS,
         listeners=EventsLogger.class)
public org.atmosphere.jersey.Broadcastable timeout()

Timeout the resource

Returns:

A Broadcastable used to broadcast events.