Package 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

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

Author:

Jeanfrancois Arcand

Nested Class Summary

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

AbstractReflectorAtmosphereHandler.Default

Constructor Summary

Constructors

Constructor	Description
ReflectorServletProcessor()
ReflectorServletProcessor(jakarta.servlet.Servlet servlet)

Method Summary

Modifier and Type	Method	Description
void	addFilter(jakarta.servlet.Filter filter)
void	addFilterClassName(java.lang.String filterClass, java.lang.String filterName)	Add a FilterClass.
void	destroy()	Destroy this handler
jakarta.servlet.Servlet	getServlet()
java.lang.String	getServletClass()	Deprecated. - use getServletClassName
java.lang.String	getServletClassName()	Set the Servlet class.
void	init(AtmosphereConfig config)	Initialize the AtmosphereServletProcessor using the ServletConfig.
void	onRequest(AtmosphereResource r)	Delegate the request to the Servlet.service method, and add the AtmosphereResource to the {@link HttpServletRequest#setAttribute(java.lang.String, java.lang.Object))}.
void	setFilterClassName(java.lang.String filterClass)	Add a FilterClass.
void	setServlet(jakarta.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, useTwoStepWrite, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ReflectorServletProcessor

public ReflectorServletProcessor()

ReflectorServletProcessor

public ReflectorServletProcessor(jakarta.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 {@link HttpServletRequest#setAttribute(java.lang.String, java.lang.Object))}. The AtmosphereResource can ve retrieved using FrameworkConfig.ATMOSPHERE_RESOURCE value.

Parameters:

r - The AtmosphereResource

Throws:

java.io.IOException

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

Overrides:

init in class AbstractReflectorAtmosphereHandler

Parameters:

config - the ServletConfig

Throws:

jakarta.servlet.ServletException

addFilter

public void addFilter(jakarta.servlet.Filter filter)

destroy

public void destroy()

Description copied from interface: AtmosphereHandler

Destroy this handler

Specified by:

destroy in interface AtmosphereHandler

Overrides:

destroy in class AbstractReflectorAtmosphereHandler

getServletClass

@Deprecated
public java.lang.String getServletClass()

Deprecated.

- use getServletClassName

Set the Servlet class.

Returns:

the servletClass

setServletClass

@Deprecated
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.

Parameters:

filterClass -

addFilterClassName

public void addFilterClassName(java.lang.String filterClass,
                               java.lang.String filterName)

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

Parameters:

filterClass - class name of the filter to instantiate.

filterName - mapping name of the filter to instantiate

getServlet

public jakarta.servlet.Servlet getServlet()

setServlet

public void setServlet(jakarta.servlet.Servlet servlet)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object