Package org.atmosphere.handler

Class AbstractReflectorAtmosphereHandler

java.lang.Object

org.atmosphere.handler.AbstractReflectorAtmosphereHandler

All Implemented Interfaces:

AtmosphereHandler, AtmosphereServletProcessor

Direct Known Subclasses:

AbstractReflectorAtmosphereHandler.Default, ManagedAtmosphereHandler, OnMessage, ReflectorServletProcessor

public abstract class AbstractReflectorAtmosphereHandler
extends java.lang.Object
implements AtmosphereServletProcessor

Simple AtmosphereHandler that reflect every call to Broadcaster.broadcast(java.lang.Object), eg sent the broadcasted event back to the remote client. All broadcasts will be by default returned as it is to the suspended AtmosphereResponseImpl.getOutputStream() or AtmosphereResponseImpl.getWriter().

Author:

Jean-francois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractReflectorAtmosphereHandler.Default	This default implementation does nothing when AbstractReflectorAtmosphereHandler.Default.onRequest(org.atmosphere.cpr.AtmosphereResource) is called.

Constructor Summary

Constructors

Constructor	Description
AbstractReflectorAtmosphereHandler()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroy this handler
void	init(AtmosphereConfig config)	Initialize the AtmosphereServletProcessor using the ServletConfig.
void	onStateChange(AtmosphereResourceEvent event)	Write the AtmosphereResourceEvent.getMessage() back to the client using the AtmosphereResponseImpl.getOutputStream() or AtmosphereResponseImpl.getWriter().
protected void	postStateChange(AtmosphereResourceEvent event)	Inspect the event and decide if the underlying connection must be resumed.
protected boolean	useTwoStepWrite(AtmosphereResourceEvent event)
protected void	write(AtmosphereResourceEvent event, jakarta.servlet.ServletOutputStream o, byte[] data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.atmosphere.cpr.AtmosphereHandler

onRequest

Constructor Detail

AbstractReflectorAtmosphereHandler

public AbstractReflectorAtmosphereHandler()

Method Detail

onStateChange

public void onStateChange(AtmosphereResourceEvent event)
                   throws java.io.IOException

Write the AtmosphereResourceEvent.getMessage() back to the client using the AtmosphereResponseImpl.getOutputStream() or AtmosphereResponseImpl.getWriter(). If a Serializer is defined, it will be invoked and the write operation will be delegated to it.

By default, this method will try to use AtmosphereResponseImpl.getWriter().

Specified by:

onStateChange in interface AtmosphereHandler

Parameters:

event - the AtmosphereResourceEvent.getMessage()

Throws:

java.io.IOException

write

protected void write(AtmosphereResourceEvent event,
                     jakarta.servlet.ServletOutputStream o,
                     byte[] data)
              throws java.io.IOException

Throws:

java.io.IOException

useTwoStepWrite

protected boolean useTwoStepWrite(AtmosphereResourceEvent event)

postStateChange

protected final void postStateChange(AtmosphereResourceEvent event)

Inspect the event and decide if the underlying connection must be resumed.

Parameters:

event - AtmosphereResourceEvent

destroy

public void destroy()

Description copied from interface: AtmosphereHandler

Destroy this handler

Specified by:

destroy in interface AtmosphereHandler

init

public void init(AtmosphereConfig config)
          throws jakarta.servlet.ServletException

Description copied from interface: AtmosphereServletProcessor

Initialize the AtmosphereServletProcessor using the ServletConfig.

Specified by:

init in interface AtmosphereServletProcessor

Parameters:

config - the ServletConfig

Throws:

jakarta.servlet.ServletException