co.paralleluniverse.comsat.webactors.servlet

Class ServletWebActors

java.lang.Object

co.paralleluniverse.comsat.webactors.servlet.ServletWebActors

public final class ServletWebActors
extends Object

Static methods to attach web actors with HTTP and WebSocket sessions

Method Summary

Modifier and Type	Method and Description
static <T> ActorRef<T>	attachWebActor(HttpSession session, ActorRef<T> actor) Attaches the given web actor to the given HttpSession.
static <T> ActorRef<T>	attachWebActor(ServletContext sc, Collection<String> webSocketURIs, ActorRef<T> actor) Attaches the given web actor to web socket sessions that will be opened at the given URIs (or URI patterns).
static <T> ActorRef<T>	attachWebActor(ServletContext sc, String webSocketURI, ActorRef<T> actor) Attaches the given web actor to web socket sessions that will be opened at the given URI (or URI pattern).
static <T> ActorRef<T>	attachWebActor(Session session, EndpointConfig config, ActorRef<T> actor) Attaches the given web actor to the given WebSocket session
static <T> ActorRef<T>	attachWebActor(Session session, HttpSession httpSession, ActorRef<T> actor) Attaches the given web actor to the given WebSocket session
static ActorRef<? super co.paralleluniverse.comsat.webactors.HttpRequest>	getWebActor(HttpSession session) Returns the web actor attached to the given HttpSession.
static boolean	isWebActorAttached(HttpSession session) Checks whether a web actor is attached to an HttpSession.

Methods inherited from class java.lang.Object

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

Method Detail

attachWebActor

public static <T> ActorRef<T> attachWebActor(HttpSession session,
                                             ActorRef<T> actor)

Attaches the given web actor to the given HttpSession.

Parameters:

session - the session

actor - the web actor

Returns:

actor

isWebActorAttached

public static boolean isWebActorAttached(HttpSession session)

Checks whether a web actor is attached to an HttpSession.

getWebActor

public static ActorRef<? super co.paralleluniverse.comsat.webactors.HttpRequest> getWebActor(HttpSession session)

Returns the web actor attached to the given HttpSession.

Parameters:

session - the session

Returns:

the web actor attached to the session, or null if none.

attachWebActor

public static <T> ActorRef<T> attachWebActor(Session session,
                                             HttpSession httpSession,
                                             ActorRef<T> actor)

Attaches the given web actor to the given WebSocket session

Parameters:

session - the WebSocket Session

httpSession - the WebSocket’s associated HTTP session

actor - the web actor

Returns:

actor

attachWebActor

public static <T> ActorRef<T> attachWebActor(Session session,
                                             EndpointConfig config,
                                             ActorRef<T> actor)

Attaches the given web actor to the given WebSocket session

Parameters:

session - the WebSocket Session

config - the WebSocket endpoint’s configuration

actor - the web actor

Returns:

actor

attachWebActor

public static <T> ActorRef<T> attachWebActor(ServletContext sc,
                                             String webSocketURI,
                                             ActorRef<T> actor)

Attaches the given web actor to web socket sessions that will be opened at the given URI (or URI pattern). This method installs a new WebSocket Endpoint.

Parameters:

sc - the ServletContext

webSocketURI - the WebSocket’s URI (or URI pattern)

actor - the web actor

Returns:

actor

attachWebActor

public static <T> ActorRef<T> attachWebActor(ServletContext sc,
                                             Collection<String> webSocketURIs,
                                             ActorRef<T> actor)

Attaches the given web actor to web socket sessions that will be opened at the given URIs (or URI patterns). This method installs new WebSocket Endpoints.

Parameters:

sc - the ServletContext

webSocketURIs - the WebSockets’ URI (or URI pattern)

actor - the web actor

Returns:

actor