org.jenkinsci.plugins.pubsub

Class GuavaPubsubBus

java.lang.Object

org.jenkinsci.plugins.pubsub.PubsubBus

org.jenkinsci.plugins.pubsub.GuavaPubsubBus

All Implemented Interfaces:

hudson.ExtensionPoint

public final class GuavaPubsubBus
extends PubsubBus

Default PubsubBus implementation.

An in-memory implementation based on Google's Guava EventBus.

Use system property org.jenkins.pubsub.GuavaPubsubBus.MAX_THREADS to configure the thread pool size used by the bus. The default value is 5 threads (falling back to 0 when idle).

Author:

tom.fennelly@gmail.com

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
GuavaPubsubBus()

Method Summary

Modifier and Type	Method and Description
protected ChannelPublisher	publisher(String channelName) Get/create a new ChannelPublisher instance for the specified channel name.
void	shutdown() Shutdown the bus.
void	subscribe(String channelName, ChannelSubscriber subscriber, org.acegisecurity.Authentication authentication, EventFilter eventFilter) Subscribe to events on the specified event channel.
void	unsubscribe(String channelName, ChannelSubscriber subscriber) Unsubscribe from events on the specified event channel.

Methods inherited from class org.jenkinsci.plugins.pubsub.PubsubBus

getBus, publish

Methods inherited from class java.lang.Object

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

Constructor Detail

GuavaPubsubBus

public GuavaPubsubBus()

Method Detail

publisher

@Nonnull
protected ChannelPublisher publisher(@Nonnull
                                              String channelName)

Description copied from class: PubsubBus

Get/create a new ChannelPublisher instance for the specified channel name.

Specified by:

publisher in class PubsubBus

Parameters:

channelName - The channel name.

Returns:

The ChannelPublisher instance.

subscribe

public void subscribe(@Nonnull
                      String channelName,
                      @Nonnull
                      ChannelSubscriber subscriber,
                      @Nonnull
                      org.acegisecurity.Authentication authentication,
                      @CheckForNull
                      EventFilter eventFilter)

Description copied from class: PubsubBus

Subscribe to events on the specified event channel.

Specified by:

subscribe in class PubsubBus

Parameters:

channelName - The channel name.

subscriber - The subscriber instance that will receive the events.

authentication - The authentication to which the subscription is associated.

eventFilter - A message filter, or null if no filtering is to be applied. This tells the bus to only forward messages that match the properties (names and values) specified in the filter.

unsubscribe

public void unsubscribe(@Nonnull
                        String channelName,
                        @Nonnull
                        ChannelSubscriber subscriber)

Description copied from class: PubsubBus

Unsubscribe from events on the specified event channel.

Specified by:

unsubscribe in class PubsubBus

Parameters:

channelName - The channel name.

subscriber - The subscriber instance that was used to receive events.

shutdown

public void shutdown()

Description copied from class: PubsubBus

Shutdown the bus.

Specified by:

shutdown in class PubsubBus