org.jenkins.pubsub

Class PubsubBus

java.lang.Object

org.jenkins.pubsub.PubsubBus

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

GuavaPubsubBus

public abstract class PubsubBus
extends Object
implements hudson.ExtensionPoint

Abstract Pub-sub bus.

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
PubsubBus()

Method Summary

Modifier and Type	Method and Description
static PubsubBus	getBus() Get the installed PubsubBus implementation.
void	publish(Message message) Publish a message on a channel.
protected abstract ChannelPublisher	publisher(String channelName) Get/create a new ChannelPublisher instance for the specified channel name.
abstract void	shutdown() Shutdown the bus.
abstract void	subscribe(String channelName, ChannelSubscriber subscriber, hudson.model.User user, EventFilter eventFilter) Subscribe to events on the specified event channel.
abstract void	unsubscribe(String channelName, ChannelSubscriber subscriber) Unsubscribe from events on the specified event channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

PubsubBus

public PubsubBus()

Method Detail

getBus

@Nonnull
public static PubsubBus getBus()

Get the installed PubsubBus implementation.

Returns:

The installed PubsubBus implementation, or default implementation if none are found.

publish

public void publish(@Nonnull
                    Message message)
             throws MessageException

Publish a message on a channel.

The message instance must have the channel and event name properties set on it.

Parameters:

message - The message properties.

Throws:

MessageException

publisher

@Nonnull
protected abstract ChannelPublisher publisher(@Nonnull
                                                       String channelName)

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

Parameters:

channelName - The channel name.

Returns:

The ChannelPublisher instance.

subscribe

public abstract void subscribe(@Nonnull
                               String channelName,
                               @Nonnull
                               ChannelSubscriber subscriber,
                               @Nonnull
                               hudson.model.User user,
                               @CheckForNull
                               EventFilter eventFilter)

Subscribe to events on the specified event channel.

Parameters:

channelName - The channel name.

subscriber - The subscriber instance that will receive the events.

user - The Jenkins user associated with the subscriber.

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 abstract void unsubscribe(@Nonnull
                                 String channelName,
                                 @Nonnull
                                 ChannelSubscriber subscriber)

Unsubscribe from events on the specified event channel.

Parameters:

channelName - The channel name.

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

shutdown

public abstract void shutdown()

Shutdown the bus.