Package org.jenkinsci.plugins.ssegateway.sse

Class EventDispatcher

java.lang.Object

org.jenkinsci.plugins.ssegateway.sse.EventDispatcher

All Implemented Interfaces:

Serializable

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public abstract class EventDispatcher
extends Object
implements Serializable

Author:

tom.fennelly@gmail.com

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EventDispatcher.SSEHttpSessionListener	Http session listener.

Field Summary

Fields

Modifier and Type	Field	Description
static long	RETRY_QUEUE_EVENT_LIFETIME
static long	RETRY_QUEUE_PROCESSING_DELAY
static final String	SESSION_SYNC_OBJ
static long	TIMEOUT_DISPATCHERFAIL

Constructor Summary

Constructors

Constructor	Description
EventDispatcher()

Method Summary

Modifier and Type	Method	Description
boolean	dispatchEvent(String name, String data)	Writes a message to HttpServletResponse
final String	getId()
abstract jakarta.servlet.http.HttpServletResponse	getResponse()
Map<org.jenkinsci.plugins.pubsub.EventFilter,org.jenkinsci.plugins.pubsub.ChannelSubscriber>	getSubscribers()
protected User	getUser()
void	setId(String id)
abstract void	start(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	stop()
boolean	subscribe(org.jenkinsci.plugins.pubsub.EventFilter filter)
String	toString()
boolean	unsubscribe(org.jenkinsci.plugins.pubsub.EventFilter filter)
void	unsubscribeAll()

Methods inherited from class java.lang.Object

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

Field Details

SESSION_SYNC_OBJ

public static final String SESSION_SYNC_OBJ

See Also:

• Constant Field Values

RETRY_QUEUE_EVENT_LIFETIME

public static long RETRY_QUEUE_EVENT_LIFETIME

RETRY_QUEUE_PROCESSING_DELAY

public static long RETRY_QUEUE_PROCESSING_DELAY

TIMEOUT_DISPATCHERFAIL

public static long TIMEOUT_DISPATCHERFAIL

Constructor Details

EventDispatcher

public EventDispatcher()

Method Details

start

public abstract void start(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                    throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

getResponse

public abstract jakarta.servlet.http.HttpServletResponse getResponse()

getSubscribers

public Map<org.jenkinsci.plugins.pubsub.EventFilter,org.jenkinsci.plugins.pubsub.ChannelSubscriber> getSubscribers()

getId

public final String getId()

setId

public void setId(String id)

toString

public String toString()

Overrides:

toString in class Object

dispatchEvent

public boolean dispatchEvent(String name,
 String data)
                      throws IOException,
jakarta.servlet.ServletException

Writes a message to HttpServletResponse

Parameters:

name - event-name

data - event-data

Returns:

false if the response is not writable

Throws:

IOException - io-exception

jakarta.servlet.ServletException - servlet-exception

stop

public void stop()

subscribe

public boolean subscribe(@NonNull
 org.jenkinsci.plugins.pubsub.EventFilter filter)

getUser

protected User getUser()

unsubscribe

public boolean unsubscribe(@NonNull
 org.jenkinsci.plugins.pubsub.EventFilter filter)

unsubscribeAll

public void unsubscribeAll()