org.atmosphere.vibe.platform.server.atmosphere2

Class VibeAtmosphereServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.atmosphere.cpr.AtmosphereServlet

org.atmosphere.vibe.platform.server.atmosphere2.VibeAtmosphereServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class VibeAtmosphereServlet
extends AtmosphereServlet

Servlet to process AtmosphereResource into ServerHttpExchange and ServerWebSocket. You need to configure this servlet and provide your action to receive ServerHttpExchange and ServerWebSocket by overriding httpAction() and wsAction() like the following usage. When you configure servlet, you must set asyncSupported to true and set a init param, org.atmosphere.cpr.AtmosphereInterceptor.disableDefaults , to true.

 ServletRegistration.Dynamic reg = context.addServlet(VibeAtmosphereServlet.class.getName(), new VibeAtmosphereServlet() {
     @Override
     protected Action<ServerHttpExchange> httpAction() {
         return server.httpAction();
     }
     
     @Override
     protected Action<ServerWebSocket> wsAction() {
         return server.wsAction();
     }
 });
 reg.setAsyncSupported(true);
 reg.setInitParameter(ApplicationConfig.DISABLE_ATMOSPHEREINTERCEPTOR, Boolean.TRUE.toString())
 reg.addMapping("/vibe");
 

With CDI, the following usage is also available.

 @WebServlet(value = "/vibe", asyncSupported = true, initParams = { @WebInitParam(name = "org.atmosphere.cpr.AtmosphereInterceptor.disableDefaults", value = "true") })
 public class MyVibeAtmosphereServlet extends VibeAtmosphereServlet {
     @Inject
     private Server server;
     
     @Override
     protected Action<ServerHttpExchange> httpAction() {
         return server.httpAction();
     }
     
     @Override
     protected Action<ServerWebSocket> wsAction() {
         return server.wsAction();
     }
 }
 

Author:

Donghwan Kim

See Also:

Serialized Form

Field Summary

Fields inherited from class org.atmosphere.cpr.AtmosphereServlet

autoDetectHandlers, framework, isFilter, logger

Constructor Summary

Constructors

Constructor and Description
VibeAtmosphereServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected Action<ServerHttpExchange>	httpAction() An Action to consume ServerHttpExchange.
void	init(javax.servlet.ServletConfig sc)
protected boolean	isWebSocketResource(AtmosphereResource resource) Does the given AtmosphereResource represent WebSocket resource?
protected Action<ServerWebSocket>	wsAction() An Action to consume ServerWebSocket.

Methods inherited from class org.atmosphere.cpr.AtmosphereServlet

configureFramework, destroy, doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, framework, newAtmosphereFramework

Methods inherited from class javax.servlet.http.HttpServlet

getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

VibeAtmosphereServlet

public VibeAtmosphereServlet()

Method Detail

init

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

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class AtmosphereServlet

Throws:

javax.servlet.ServletException

isWebSocketResource

protected boolean isWebSocketResource(AtmosphereResource resource)

Does the given AtmosphereResource represent WebSocket resource?

httpAction

protected Action<ServerHttpExchange> httpAction()

An Action to consume ServerHttpExchange. By default, it throws IllegalStateException so you should provide your action by overriding it.

wsAction

protected Action<ServerWebSocket> wsAction()

An Action to consume ServerWebSocket. By default, it throws IllegalStateException so you should provide your action by overriding it.