Package org.atmosphere.config.managed

Class ManagedAtmosphereHandler

java.lang.Object

org.atmosphere.handler.AbstractReflectorAtmosphereHandler

org.atmosphere.config.managed.ManagedAtmosphereHandler

All Implemented Interfaces:

AtmosphereHandler, AtmosphereResourceHeartbeatEventListener, AtmosphereServletProcessor, AnnotatedProxy

public class ManagedAtmosphereHandler
extends AbstractReflectorAtmosphereHandler
implements AnnotatedProxy, AtmosphereResourceHeartbeatEventListener

An internal implementation of AtmosphereHandler that implement support for Atmosphere 2.0 annotations.

Author:

Jeanfrancois

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagedAtmosphereHandler.Managed
static class	ManagedAtmosphereHandler.MethodInfo

Nested classes/interfaces inherited from class org.atmosphere.handler.AbstractReflectorAtmosphereHandler

AbstractReflectorAtmosphereHandler.Default

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<ManagedAtmosphereHandler.MethodInfo>	onRuntimeMethod
protected boolean	pathParams
protected AtmosphereResourceFactory	resourcesFactory

Constructor Summary

Constructors

Constructor	Description
ManagedAtmosphereHandler()

Method Summary

Modifier and Type	Method	Description
AnnotatedProxy	configure(AtmosphereConfig config, java.lang.Object c)	Configure the proxy.
void	onHeartbeat(AtmosphereResourceEvent event)	Notifies the heartbeat for the given resource to the annotated method if exists.
void	onRequest(AtmosphereResource resource)	When a client sends a request to its associated AtmosphereHandler, it can decide if the underlying connection can be suspended (creating a Continuation) or handle the connection synchronously.
void	onStateChange(AtmosphereResourceEvent event)	Write the AtmosphereResourceEvent.getMessage() back to the client using the AtmosphereResponseImpl.getOutputStream() or AtmosphereResponseImpl.getWriter().
boolean	pathParams()	Return true if PathParam are supported.
protected boolean	pathParams(java.lang.Object o)
protected java.lang.reflect.Method	populate(java.lang.Object c, java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
protected java.util.List<ManagedAtmosphereHandler.MethodInfo>	populateMessage(java.lang.Object c, java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
protected void	processReady(AtmosphereResource r)
java.lang.Object	target()	The Object the AtmosphereHandler is proxying.
java.lang.String	toString()

Methods inherited from class org.atmosphere.handler.AbstractReflectorAtmosphereHandler

destroy, init, postStateChange, useTwoStepWrite, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.atmosphere.cpr.AtmosphereHandler

destroy

Field Detail

onRuntimeMethod

protected java.util.List<ManagedAtmosphereHandler.MethodInfo> onRuntimeMethod

pathParams

protected boolean pathParams

resourcesFactory

protected AtmosphereResourceFactory resourcesFactory

Constructor Detail

ManagedAtmosphereHandler

public ManagedAtmosphereHandler()

Method Detail

configure

public AnnotatedProxy configure(AtmosphereConfig config,
                                java.lang.Object c)

Description copied from interface: AnnotatedProxy

Configure the proxy.

Specified by:

configure in interface AnnotatedProxy

Returns:

onRequest

public void onRequest(AtmosphereResource resource)
               throws java.io.IOException

Description copied from interface: AtmosphereHandler

When a client sends a request to its associated AtmosphereHandler, it can decide if the underlying connection can be suspended (creating a Continuation) or handle the connection synchronously.

It is recommended to only suspend requests for which HTTP method is a GET and use the POST method to send data to the server, without marking the connection as asynchronous.

Specified by:

onRequest in interface AtmosphereHandler

Parameters:

resource - an AtmosphereResource

Throws:

java.io.IOException

onStateChange

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

Description copied from class: AbstractReflectorAtmosphereHandler

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

Overrides:

onStateChange in class AbstractReflectorAtmosphereHandler

Parameters:

event - the AtmosphereResourceEvent.getMessage()

Throws:

java.io.IOException

pathParams

public boolean pathParams()

Description copied from interface: AnnotatedProxy

Return true if PathParam are supported.

Specified by:

pathParams in interface AnnotatedProxy

Returns:

true if PathParam are supported.

pathParams

protected boolean pathParams(java.lang.Object o)

populate

protected java.lang.reflect.Method populate(java.lang.Object c,
                                            java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

populateMessage

protected java.util.List<ManagedAtmosphereHandler.MethodInfo> populateMessage(java.lang.Object c,
                                                                              java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

target

public java.lang.Object target()

Description copied from interface: AnnotatedProxy

The Object the AtmosphereHandler is proxying.

Specified by:

target in interface AnnotatedProxy

Returns:

processReady

protected void processReady(AtmosphereResource r)

onHeartbeat

public void onHeartbeat(AtmosphereResourceEvent event)

Notifies the heartbeat for the given resource to the annotated method if exists.

Specified by:

onHeartbeat in interface AtmosphereResourceHeartbeatEventListener

Parameters:

event - the event

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object