Package org.jenkinsci.plugins.pubsub

Class RunMessage

java.lang.Object

java.util.Dictionary

java.util.Hashtable

java.util.Properties

org.jenkinsci.plugins.pubsub.Message

org.jenkinsci.plugins.pubsub.JobChannelMessage<RunMessage>

org.jenkinsci.plugins.pubsub.RunMessage

All Implemented Interfaces:

AccessControlled, Serializable, Cloneable, Map

public final class RunMessage
extends JobChannelMessage<RunMessage>

Jenkins Run domain model PubsubBus message instance.

Author:

tom.fennelly@gmail.com

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
RunMessage()	Create a plain message instance.
RunMessage(Run run)	Create a message instance associated with a Jenkins Run.

Method Summary

Modifier and Type	Method	Description
void	checkPermission(Permission permission)
Message	clone()	Clone this Message instance.
protected AccessControlled	getAccessControlled()	Get the Jenkins AccessControlled object associated with this message.
ACL	getACL()
Run	getRun()	Get the Jenkins Run associated with this message.
boolean	hasPermission(Permission permission)

Methods inherited from class org.jenkinsci.plugins.pubsub.JobChannelMessage

getChannelName, getJob, getJobChannelItem, getJobName, getRequiredPermission, setChannelName

Methods inherited from class org.jenkinsci.plugins.pubsub.Message

containsAll, get, get, getEventName, getEventUUID, getJenkinsInstanceId, getJenkinsInstanceUrl, getObjectId, getObjectName, getObjectType, getTimestamp, getTimestampMillis, set, set, setEventName, setEventName, setItemProps, setJenkinsInstanceId, toJSON, toJSON, toString

Methods inherited from class java.util.Properties

clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, list, list, load, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, save, setProperty, size, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, hasAnyPermission, hasPermission, hasPermission2

Constructor Details

RunMessage

public RunMessage()

Create a plain message instance.

RunMessage

public RunMessage(@NonNull
 Run run)

Create a message instance associated with a Jenkins Run.

Parameters:

run - The Jenkins Run with this message instance is to be associated.

Method Details

clone

public Message clone()

Clone this Message instance.

Base implementation creates a SimpleMessage instance.

Overrides:

clone in class Message

Returns:

The clone.

getAccessControlled

protected AccessControlled getAccessControlled()

Get the Jenkins AccessControlled object associated with this message.

Overrides:

getAccessControlled in class JobChannelMessage<RunMessage>

Returns:

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

getRun

@CheckForNull
public Run getRun()

Get the Jenkins Run associated with this message.

Returns:

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

getACL

@NonNull
public ACL getACL()

Specified by:

getACL in interface AccessControlled

checkPermission

public void checkPermission(@NonNull
 Permission permission)
                     throws org.springframework.security.access.AccessDeniedException

Specified by:

checkPermission in interface AccessControlled

Throws:

org.springframework.security.access.AccessDeniedException

hasPermission

public boolean hasPermission(@NonNull
 Permission permission)

Specified by:

hasPermission in interface AccessControlled