org.atmosphere.vibe.platform.server.jwa1

Class VibeServerEndpoint

java.lang.Object

Endpoint

org.atmosphere.vibe.platform.server.jwa1.VibeServerEndpoint

public class VibeServerEndpoint
extends Endpoint

Endpoint to process Session into ServerWebSocket. Once Session is opened, JwaServerWebSocket is created and passed to wsAction(). So what you need to do is to configure this endpoint and to provide your action to receive ServerWebSocket by overriding wsAction() like the following usage.

 ServerEndpointConfig config = ServerEndpointConfig.Builder.create(VibeServerEndpoint.class, "/vibe")
 .configurator(new Configurator() {
     @Override
     protected <T> T getEndpointInstance(Class<T> endpointClass) throws InstantiationException {
         return endpointClass.cast(new VibeServerEndpoint() {
             @Override
             public Action<ServerWebSocket> wsAction() {
                 return server.wsAction();
             }
         });
     }
 })
 .build();
 

With CDI, the following usage is also available.

 @ServerEndpoint("/vibe")
 public class MyVibeServerEndpoint extends VibeServerEndpoint {
     @Inject
     private Server server;
     
     @Override
     protected Action<ServerWebSocket> wsAction() {
         return server.wsAction();
     }
 }
 

Author:

Donghwan Kim

Constructor Summary

Constructors

Constructor and Description
VibeServerEndpoint()

Method Summary

Methods

Modifier and Type	Method and Description
void	onClose(Session session, CloseReason closeReason)
void	onError(Session session, Throwable throwable)
void	onOpen(Session session, EndpointConfig config)
protected	wsAction() An Action to consume ServerWebSocket.

Methods inherited from class java.lang.Object

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

Constructor Detail

VibeServerEndpoint

public VibeServerEndpoint()

Method Detail

onOpen

public void onOpen(Session session,
          EndpointConfig config)

wsAction

protected  wsAction()

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

onError

public void onError(Session session,
           Throwable throwable)

onClose

public void onClose(Session session,
           CloseReason closeReason)