org.jenkins.pubsub

Class JobChannelMessage<T extends JobChannelMessage>

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.jenkins.pubsub.Message

org.jenkins.pubsub.JobChannelMessage<T>

All Implemented Interfaces:

hudson.security.AccessControlled, Serializable, Cloneable, Map<Object,Object>

Direct Known Subclasses:

JobMessage, RunMessage

public abstract class JobChannelMessage<T extends JobChannelMessage>
extends Message

Jenkins Job domain model PubsubBus message instance.

Author:

tom.fennelly@gmail.com

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
JobChannelMessage(hudson.model.Job job) Deprecated. Use JobChannelMessage(ParameterizedJobMixIn.ParameterizedJob)
JobChannelMessage(jenkins.model.ParameterizedJobMixIn.ParameterizedJob job) Create a message instance associated with a Jenkins Job.

Method Summary

Modifier and Type	Method and Description
void	checkPermission(hudson.security.Permission permission)
protected abstract hudson.security.AccessControlled	getAccessControlled() Get the Jenkins AccessControlled object associated with this message.
hudson.security.ACL	getACL()
String	getChannelName() Get the channel name for the message.
jenkins.model.ParameterizedJobMixIn.ParameterizedJob	getJob() Get the Jenkins Job associated with this message.
String	getJobName()
protected hudson.security.Permission	getRequiredPermission() Get the permission required to see the message.
boolean	hasPermission(hudson.security.Permission permission)
Message	setChannelName(String name) Set the channel name for the message.

Methods inherited from class org.jenkins.pubsub.Message

clone, containsAll, get, get, getEventName, getObjectId, getObjectName, set, set, setEventName, setEventName, setItemProps, toJSON, toJSON, toString

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobChannelMessage

@Deprecated
public JobChannelMessage(@Nonnull
                                     hudson.model.Job job)

Deprecated. Use JobChannelMessage(ParameterizedJobMixIn.ParameterizedJob)

JobChannelMessage

public JobChannelMessage(@Nonnull
                         jenkins.model.ParameterizedJobMixIn.ParameterizedJob job)

Create a message instance associated with a Jenkins Job.

Parameters:

job - The Jenkins Job that this message instance is to be associated.

Method Detail

getChannelName

public final String getChannelName()

Description copied from class: Message

Get the channel name for the message.

Overrides:

getChannelName in class Message

Returns:

The channel name for the message, or null if none set.

setChannelName

public final Message setChannelName(String name)

Description copied from class: Message

Set the channel name for the message.

Overrides:

setChannelName in class Message

Parameters:

name - The channel name for the message.

getJobName

public String getJobName()

getJob

@CheckForNull
public jenkins.model.ParameterizedJobMixIn.ParameterizedJob getJob()

Get the Jenkins Job associated with this message.

Returns:

The Jenkins Job associated with this message, or {code null} if the message is not associated with a Jenkins Job.

getRequiredPermission

@Nonnull
protected hudson.security.Permission getRequiredPermission()

Get the permission required to see the message.

Returns:

The permission required to see the message.

getAccessControlled

@CheckForNull
protected abstract hudson.security.AccessControlled getAccessControlled()

Get the Jenkins AccessControlled object associated with this message.

Returns:

The Jenkins AccessControlled object associated with this message, or {code null} if the message is not associated with a Jenkins AccessControlled.

getACL

@Nonnull
public hudson.security.ACL getACL()

Specified by:

getACL in interface hudson.security.AccessControlled

checkPermission

public void checkPermission(@Nonnull
                            hudson.security.Permission permission)
                     throws org.acegisecurity.AccessDeniedException

Specified by:

checkPermission in interface hudson.security.AccessControlled

Throws:

org.acegisecurity.AccessDeniedException

hasPermission

public boolean hasPermission(@Nonnull
                             hudson.security.Permission permission)

Specified by:

hasPermission in interface hudson.security.AccessControlled