Package org.jenkinsci.plugins.pubsub

Class AbstractChannelSubscriber

java.lang.Object

org.jenkinsci.plugins.pubsub.AbstractChannelSubscriber

All Implemented Interfaces:

ExtensionPoint, ChannelSubscriber

public abstract class AbstractChannelSubscriber
extends Object
implements ChannelSubscriber, ExtensionPoint

Simple asynchronous ChannelSubscriber ExtensionPoint for Jenkins.

Author:

tom.fennelly@gmail.com

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AbstractChannelSubscriber()

Method Summary

Modifier and Type	Method	Description
Authentication	getAuthentication()	Deprecated. Use getAuthentication2() instead.
org.springframework.security.core.Authentication	getAuthentication2()	Get the Authentication used for listening for events on the channel.
abstract String	getChannelName()	Get the name of the channel on which the subscriber will listen.
EventFilter	getEventFilter()	Get the event filter to be used for messages on the channel.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jenkinsci.plugins.pubsub.ChannelSubscriber

onMessage

Constructor Details

AbstractChannelSubscriber

public AbstractChannelSubscriber()

Method Details

getChannelName

public abstract String getChannelName()

Get the name of the channel on which the subscriber will listen.

Returns:

The channel name.

getAuthentication

@Deprecated
public Authentication getAuthentication()

Deprecated.

Use getAuthentication2() instead.

Get the Authentication used for listening for events on the channel.

Override to restrict. Default is ACL.SYSTEM.

Returns:

The Authentication used for listening for events on the channel.

getAuthentication2

public org.springframework.security.core.Authentication getAuthentication2()

Get the Authentication used for listening for events on the channel.

Override to restrict. Default is ACL.SYSTEM2.

Returns:

The Authentication used for listening for events on the channel.

getEventFilter

public EventFilter getEventFilter()

Get the event filter to be used for messages on the channel.

Override this method to define an EventFilter instance. Default is null i.e. no filtering.

Returns:

The EventFilter instance.