Package org.atmosphere.cpr

Class AsynchronousProcessor

java.lang.Object

org.atmosphere.cpr.AsynchronousProcessor

All Implemented Interfaces:

AsyncSupport<AtmosphereResourceImpl>

Direct Known Subclasses:

BlockingIOCometSupport, NettyCometSupport, Servlet30CometSupport

public abstract class AsynchronousProcessor
extends java.lang.Object
implements AsyncSupport<AtmosphereResourceImpl>

Base class which implement the semantics of suspending and resuming of a Comet/WebSocket Request.

Author:

Jeanfrancois Arcand

Field Summary

Fields

Modifier and Type	Field	Description
protected static Action	cancelledAction
protected AtmosphereConfig	config
protected static Action	timedoutAction

Constructor Summary

Constructors

Constructor	Description
AsynchronousProcessor(AtmosphereConfig config)

Method Summary

Modifier and Type	Method	Description
void	action(AtmosphereResourceImpl r)	Process an Action from an ActionEvent operation like suspend, resume or timed out.
protected boolean	allowSessionTimeoutRemoval()	Is HttpSession timeout removal supported
Action	cancelled(AtmosphereRequest req, AtmosphereResponse res)	All proprietary Comet based Servlet must invoke the cancelled method when the underlying WebServer detect that the client closed the connection.
AsyncSupport<AtmosphereResourceImpl>	complete(AtmosphereResourceImpl r)	Complete and close the connection associated with an implementation of AtmosphereResource
boolean	completeLifecycle(AtmosphereResource r, boolean cancelled)	Cancel or times out an AtmosphereResource by invoking it's associated AtmosphereHandler.onStateChange(AtmosphereResourceEvent)
void	endRequest(AtmosphereResourceImpl r, boolean cancel)
java.lang.String	getContainerName()	Return the container's name.
void	init(jakarta.servlet.ServletConfig sc)	Initialize the WebServer using the ServletConfig
protected void	invokeAtmosphereHandler(AtmosphereResourceImpl r)	Invoke the associated AtmosphereHandler.
Action	invokeInterceptors(java.util.List<AtmosphereInterceptor> c, AtmosphereResource r, int tracing)
protected AtmosphereFramework.AtmosphereHandlerWrapper	map(AtmosphereRequest req)	Return the AtmosphereHandler mapped to the passed servlet-path.
void	postInterceptors(java.util.List<AtmosphereInterceptor> c, AtmosphereResource r)
Action	resumed(AtmosphereRequest request, AtmosphereResponse response)	All proprietary Comet based Servlet must invoke the resume method when the Atmosphere's application decide to resume the AtmosphereResponse.
protected void	shutdown()
protected boolean	supportSession()	Is HttpSession supported
boolean	supportWebSocket()	Return true if this implementation supports the websocket protocol.
Action	suspended(AtmosphereRequest request, AtmosphereResponse response)	All proprietary Comet based Servlet must invoke the suspended method when the first request comes in.
Action	timedout(AtmosphereRequest req, AtmosphereResponse res)	All proprietary Comet based Servlet must invoke the timedout method when the underlying WebServer time out the AtmosphereResponse.

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.AsyncSupport

service

Field Detail

timedoutAction

protected static final Action timedoutAction

cancelledAction

protected static final Action cancelledAction

config

protected final AtmosphereConfig config

Constructor Detail

AsynchronousProcessor

public AsynchronousProcessor(AtmosphereConfig config)

Method Detail

init

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

Description copied from interface: AsyncSupport

Initialize the WebServer using the ServletConfig

Specified by:

init in interface AsyncSupport<AtmosphereResourceImpl>

Parameters:

sc - the ServletConfig

Throws:

jakarta.servlet.ServletException

supportSession

protected boolean supportSession()

Is HttpSession supported

Returns:

true if supported

allowSessionTimeoutRemoval

protected boolean allowSessionTimeoutRemoval()

Is HttpSession timeout removal supported

Returns:

true if supported

getContainerName

public java.lang.String getContainerName()

Return the container's name.

Specified by:

getContainerName in interface AsyncSupport<AtmosphereResourceImpl>

Returns:

the name of the Java Web Server.

suspended

public Action suspended(AtmosphereRequest request,
                        AtmosphereResponse response)
                 throws java.io.IOException,
                        jakarta.servlet.ServletException

All proprietary Comet based Servlet must invoke the suspended method when the first request comes in. The returned value, of type Action, tells the proprietary Comet Servlet to suspended or not the current AtmosphereResponse.

Parameters:

request - the AtmosphereRequest

response - the AtmosphereResponse

Returns:

action the Action operation.

Throws:

java.io.IOException

jakarta.servlet.ServletException

shutdown

protected void shutdown()

action

public void action(AtmosphereResourceImpl r)

Description copied from interface: AsyncSupport

Process an Action from an ActionEvent operation like suspend, resume or timed out.

Specified by:

action in interface AsyncSupport<AtmosphereResourceImpl>

Parameters:

r - An instance of Action

complete

public AsyncSupport<AtmosphereResourceImpl> complete(AtmosphereResourceImpl r)

Description copied from interface: AsyncSupport

Complete and close the connection associated with an implementation of AtmosphereResource

Specified by:

complete in interface AsyncSupport<AtmosphereResourceImpl>

Parameters:

r - AtmosphereResource

Returns:

this

invokeInterceptors

public Action invokeInterceptors(java.util.List<AtmosphereInterceptor> c,
                                 AtmosphereResource r,
                                 int tracing)

postInterceptors

public void postInterceptors(java.util.List<AtmosphereInterceptor> c,
                             AtmosphereResource r)

map

protected AtmosphereFramework.AtmosphereHandlerWrapper map(AtmosphereRequest req)

Return the AtmosphereHandler mapped to the passed servlet-path.

Parameters:

req - the AtmosphereResponse

Returns:

the AtmosphereHandler mapped to the passed servlet-path.

resumed

public Action resumed(AtmosphereRequest request,
                      AtmosphereResponse response)
               throws java.io.IOException,
                      jakarta.servlet.ServletException

All proprietary Comet based Servlet must invoke the resume method when the Atmosphere's application decide to resume the AtmosphereResponse. The returned value, of type Action, tells the proprietary Comet Servlet to resume (again), suspended or do nothing with the current AtmosphereResponse.

Parameters:

request - the AtmosphereRequest

response - the AtmosphereResponse

Returns:

action the Action operation.

Throws:

java.io.IOException

jakarta.servlet.ServletException

timedout

public Action timedout(AtmosphereRequest req,
                       AtmosphereResponse res)
                throws java.io.IOException,
                       jakarta.servlet.ServletException

All proprietary Comet based Servlet must invoke the timedout method when the underlying WebServer time out the AtmosphereResponse. The returned value, of type Action, tells the proprietary Comet Servlet to resume (again), suspended or do nothing with the current AtmosphereResponse.

Parameters:

req - the AtmosphereRequest

res - the AtmosphereResponse

Returns:

action the Action operation.

Throws:

java.io.IOException

jakarta.servlet.ServletException

completeLifecycle

public boolean completeLifecycle(AtmosphereResource r,
                                 boolean cancelled)

Cancel or times out an AtmosphereResource by invoking it's associated AtmosphereHandler.onStateChange(AtmosphereResourceEvent)

Parameters:

r - an AtmosphereResource

cancelled - true if cancelled, false if timedout

Returns:

true if the operation was executed.

invokeAtmosphereHandler

protected void invokeAtmosphereHandler(AtmosphereResourceImpl r)

Invoke the associated AtmosphereHandler. This method must be synchronized on an AtmosphereResource.

Parameters:

r - a AtmosphereResourceImpl

cancelled

public Action cancelled(AtmosphereRequest req,
                        AtmosphereResponse res)
                 throws java.io.IOException,
                        jakarta.servlet.ServletException

All proprietary Comet based Servlet must invoke the cancelled method when the underlying WebServer detect that the client closed the connection.

Parameters:

req - the AtmosphereRequest

res - the AtmosphereResponse

Returns:

action the Action operation.

Throws:

java.io.IOException

jakarta.servlet.ServletException

endRequest

public void endRequest(AtmosphereResourceImpl r,
                       boolean cancel)

supportWebSocket

public boolean supportWebSocket()

Description copied from interface: AsyncSupport

Return true if this implementation supports the websocket protocol.

Specified by:

supportWebSocket in interface AsyncSupport<AtmosphereResourceImpl>

Returns:

true if supported