com.helger.xservlet.handler

Class XServletAsyncHandler

java.lang.Object

com.helger.xservlet.handler.XServletAsyncHandler

All Implemented Interfaces:

IXServletBasicHandler, IXServletHandler, Serializable

public final class XServletAsyncHandler
extends Object
implements IXServletHandler

A special IXServletHandler that allows to run requests asynchronously.

Since:

9.0.0

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XServletAsyncHandler(com.helger.servlet.async.ServletAsyncSpec aAsyncSpec, IXServletHandler aNestedHandler)

Method Summary

Modifier and Type	Method and Description
static com.helger.servlet.async.IAsyncServletRunner	getAsyncServletRunner()
void	onRequest(javax.servlet.http.HttpServletRequest aHttpRequest, javax.servlet.http.HttpServletResponse aHttpResponse, com.helger.http.EHttpVersion eHttpVersion, com.helger.commons.http.EHttpMethod eHttpMethod, com.helger.web.scope.IRequestWebScope aRequestScope) Handle the servlet action for a certain request and response.
void	onServletDestroy() Called upon Servlet destruction.
void	onServletInit(com.helger.commons.collection.impl.ICommonsMap<String,String> aInitParams) Called upon Servlet initialization
static void	setAsyncServletRunner(com.helger.servlet.async.IAsyncServletRunner aAsyncServletRunner) Set the async runner to be used.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

XServletAsyncHandler

public XServletAsyncHandler(@Nonnull
                            com.helger.servlet.async.ServletAsyncSpec aAsyncSpec,
                            @Nonnull
                            IXServletHandler aNestedHandler)

Method Detail

setAsyncServletRunner

public static void setAsyncServletRunner(@Nonnull
                                         com.helger.servlet.async.IAsyncServletRunner aAsyncServletRunner)

Set the async runner to be used.

Parameters:

aAsyncServletRunner - The runner to be used. May not be null.

getAsyncServletRunner

@Nonnull
public static com.helger.servlet.async.IAsyncServletRunner getAsyncServletRunner()

Returns:

The global async runner. Never null.

onServletInit

public void onServletInit(@Nonnull
                          com.helger.commons.collection.impl.ICommonsMap<String,String> aInitParams)
                   throws javax.servlet.ServletException

Description copied from interface: IXServletBasicHandler

Called upon Servlet initialization

Specified by:

onServletInit in interface IXServletBasicHandler

Parameters:

aInitParams - The init parameters. Never null but maybe empty.

Throws:

javax.servlet.ServletException - if something goes wrong

onServletDestroy

public void onServletDestroy()

Description copied from interface: IXServletBasicHandler

Called upon Servlet destruction. May not throw an exception!

Specified by:

onServletDestroy in interface IXServletBasicHandler

onRequest

public void onRequest(@Nonnull
                      javax.servlet.http.HttpServletRequest aHttpRequest,
                      @Nonnull
                      javax.servlet.http.HttpServletResponse aHttpResponse,
                      @Nonnull
                      com.helger.http.EHttpVersion eHttpVersion,
                      @Nonnull
                      com.helger.commons.http.EHttpMethod eHttpMethod,
                      @Nonnull
                      com.helger.web.scope.IRequestWebScope aRequestScope)
               throws javax.servlet.ServletException,
                      IOException

Description copied from interface: IXServletHandler

Handle the servlet action for a certain request and response.

Specified by:

onRequest in interface IXServletHandler

Parameters:

aHttpRequest - HTTP servlet request. Never null.

aHttpResponse - HTTP servlet response. Never null.

eHttpVersion - HTTP version. Never null.

eHttpMethod - HTTP method. Never null.

aRequestScope - Request scope. Never null.

Throws:

javax.servlet.ServletException - On business error

IOException - On IO error

toString

public String toString()

Overrides:

toString in class Object