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 asynchronousChannelSubscriber
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
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Authentication
getAuthentication()
Deprecated.UsegetAuthentication2()
instead.org.springframework.security.core.Authentication
getAuthentication2()
Get theAuthentication
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
-
-
-
-
Method Detail
-
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.UsegetAuthentication2()
instead.Get theAuthentication
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 theAuthentication
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 isnull
i.e. no filtering.- Returns:
- The
EventFilter
instance.
-
-