Package org.jenkinsci.plugins.ssegateway.sse

Class EventDispatcherFactory

java.lang.Object

org.jenkinsci.plugins.ssegateway.sse.EventDispatcherFactory

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class EventDispatcherFactory
extends Object

Author:

tom.fennelly@gmail.com

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISPATCHER_SESSION_KEY

Constructor Summary

Constructors

Constructor	Description
EventDispatcherFactory()

Method Summary

Modifier and Type	Method	Description
static EventDispatcher	getDispatcher(String dispatcherId, jakarta.servlet.http.HttpSession session)	Get the specified EventDispatcher instance from the HttpSession.
static Map<String,EventDispatcher>	getDispatchers(jakarta.servlet.http.HttpSession session)	Get the session EventDispatchers from the HttpSession.
static EventDispatcher	newDispatcher(String clientId, jakarta.servlet.http.HttpSession session)	Create a new EventDispatcher instance and attach it to the user session.
static EventDispatcher	start(String clientId, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Methods inherited from class java.lang.Object

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

Field Details

DISPATCHER_SESSION_KEY

public static final String DISPATCHER_SESSION_KEY

Constructor Details

EventDispatcherFactory

public EventDispatcherFactory()

Method Details

start

public static EventDispatcher start(@NonNull
 String clientId,
 @NonNull
 jakarta.servlet.http.HttpServletRequest request,
 @NonNull
 jakarta.servlet.http.HttpServletResponse response)

getDispatchers

public static Map<String,EventDispatcher> getDispatchers(@NonNull
 jakarta.servlet.http.HttpSession session)

Get the session EventDispatchers from the HttpSession.

Parameters:

session - The HttpSession.

Returns:

The session EventDispatchers.

newDispatcher

public static EventDispatcher newDispatcher(@NonNull
 String clientId,
 @NonNull
 jakarta.servlet.http.HttpSession session)

Create a new EventDispatcher instance and attach it to the user session.

Parameters:

clientId - The dispatcher client Id.

session - The HttpSession.

Returns:

The new EventDispatcher instance.

getDispatcher

@CheckForNull
public static EventDispatcher getDispatcher(@NonNull
 String dispatcherId,
 @NonNull
 jakarta.servlet.http.HttpSession session)

Get the specified EventDispatcher instance from the HttpSession.

Parameters:

dispatcherId - The dispatcher ID.

session - The HttpSession.

Returns:

The EventDispatcher, or null if no such dispatcher is known.