-
Notifications
You must be signed in to change notification settings - Fork 29
/
AbstractChannelSubscriber.java
84 lines (78 loc) · 3.06 KB
/
AbstractChannelSubscriber.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*
* The MIT License
*
* Copyright (c) 2017, CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.jenkinsci.plugins.pubsub;
import hudson.ExtensionPoint;
import hudson.Util;
import hudson.security.ACL;
import org.springframework.security.core.Authentication;
/**
* Simple asynchronous {@link ChannelSubscriber} {@link ExtensionPoint} for Jenkins.
*
* @author <a href="mailto:tom.fennelly@gmail.com">tom.fennelly@gmail.com</a>
*/
public abstract class AbstractChannelSubscriber implements ChannelSubscriber, ExtensionPoint {
/**
* Get the name of the channel on which the subscriber will listen.
*
* @return The channel name.
*/
public abstract String getChannelName();
/**
* Get the {@link Authentication} used for listening for events on the channel.
* <p>
* Override to restrict. Default is {@link ACL#SYSTEM}.
*
* @return The {@link Authentication} used for listening for events on the channel.
* @deprecated Use {@link #getAuthentication2()} instead.
*/
@Deprecated
public org.acegisecurity.Authentication getAuthentication() {
return org.acegisecurity.Authentication.fromSpring(getAuthentication2());
}
/**
* Get the {@link Authentication} used for listening for events on the channel.
* <p>
* Override to restrict. Default is {@link ACL#SYSTEM2}.
*
* @return The {@link Authentication} used for listening for events on the channel.
*/
public Authentication getAuthentication2() {
if (Util.isOverridden(AbstractChannelSubscriber.class, getClass(), "getAuthentication")) {
return getAuthentication().toSpring();
} else {
return ACL.SYSTEM2;
}
}
/**
* Get the event filter to be used for messages on the channel.
* <p>
* Override this method to define an {@link EventFilter} instance.
* Default is {@code null} i.e. no filtering.
*
* @return The {@link EventFilter} instance.
*/
public EventFilter getEventFilter() {
return null;
}
}