org.atmosphere.handler

Class ReflectorServletProcessor

java.lang.Object

org.atmosphere.handler.AbstractReflectorAtmosphereHandler

org.atmosphere.handler.ReflectorServletProcessor

All Implemented Interfaces:

AtmosphereHandler, AtmosphereServletProcessor

public class ReflectorServletProcessor
extends AbstractReflectorAtmosphereHandler
implements AtmosphereServletProcessor

An implementation of AtmosphereHandler using the AtmosphereServletProcessor that delegate the AtmosphereHandler.onRequest(org.atmosphere.cpr.AtmosphereResource) to a set of FilterChain and Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse) and store the AtmosphereResource as a AtmosphereRequest.getAttribute(String) attribute named FrameworkConfig.ATMOSPHERE_RESOURCE. The AtmosphereResource can later be retrieved and used to supend/resume and broadcast

Author:

Jeanfrancois Arcand

Constructor Summary

Constructors

Constructor and Description
ReflectorServletProcessor()
ReflectorServletProcessor(javax.servlet.Servlet servlet)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy this handler
javax.servlet.Servlet	getServlet()
java.lang.String	getServletClass() Deprecated. - use getServletClassName
java.lang.String	getServletClassName() Set the Servlet class.
void	init(javax.servlet.ServletConfig sc) Initialize the AtmosphereServletProcessor using the ServletConfig
void	onRequest(AtmosphereResource r) Delegate the request to the Servlet.service method, and add the AtmosphereResource to the HttpServletRequest#setAttribute(java.lang.String, java.lang.Object)).
void	setFilterClassName(java.lang.String filterClass) Add a FilterClass.
void	setFilterName(java.lang.String filterName)
void	setServlet(javax.servlet.Servlet servlet)
void	setServletClass(java.lang.String servletClass) Deprecated. - use setServletClassName
void	setServletClassName(java.lang.String servletClass) Return the Servlet class name.
java.lang.String	toString()

Methods inherited from class org.atmosphere.handler.AbstractReflectorAtmosphereHandler

onStateChange, postStateChange

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

onStateChange

Constructor Detail

ReflectorServletProcessor

public ReflectorServletProcessor()

ReflectorServletProcessor

public ReflectorServletProcessor(javax.servlet.Servlet servlet)

Method Detail

onRequest

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

Delegate the request to the Servlet.service method, and add the AtmosphereResource to the HttpServletRequest#setAttribute(java.lang.String, java.lang.Object)). The AtmosphereResource can ve retrieved using FrameworkConfig.ATMOSPHERE_RESOURCE value.

Specified by:

onRequest in interface AtmosphereHandler

Parameters:

r - The AtmosphereResource

Throws:

java.io.IOException

init

public void init(javax.servlet.ServletConfig sc)
          throws javax.servlet.ServletException

Description copied from interface: AtmosphereServletProcessor

Initialize the AtmosphereServletProcessor using the ServletConfig

Specified by:

init in interface AtmosphereServletProcessor

Parameters:

sc - the ServletConfig

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Description copied from interface: AtmosphereHandler

Destroy this handler

Specified by:

destroy in interface AtmosphereHandler

getServletClass

public java.lang.String getServletClass()

Deprecated. - use getServletClassName

Set the Servlet class.

Returns:

the servletClass

setServletClass

public void setServletClass(java.lang.String servletClass)

Deprecated. - use setServletClassName

Return the Servlet class name.

Parameters:

servletClass - the servletClass to set

getServletClassName

public java.lang.String getServletClassName()

Set the Servlet class.

Returns:

the servletClass

setServletClassName

public void setServletClassName(java.lang.String servletClass)

Return the Servlet class name.

Parameters:

servletClass - the servletClass to set

setFilterClassName

public void setFilterClassName(java.lang.String filterClass)

Add a FilterClass. Since we are using Reflection to call this method, what we are really doing is addFilterClass.

TODO: MUST ALLOW MORE THAN ONE FILTER

Parameters:

filterClass -

getServlet

public javax.servlet.Servlet getServlet()

setServlet

public void setServlet(javax.servlet.Servlet servlet)

setFilterName

public void setFilterName(java.lang.String filterName)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object