org.jenkinsci.plugins.ironmqnotifier

Class IronMQNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

org.jenkinsci.plugins.ironmqnotifier.IronMQNotifier

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class IronMQNotifier
extends hudson.tasks.Notifier
implements jenkins.tasks.SimpleBuildStep

IronMQNotifier class.

Version:

$Id: $

Author:

Mike Caspar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IronMQNotifier.IronMQNotifierDescriptor

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
boolean	send_failure
boolean	send_success
boolean	send_unstable

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
IronMQNotifier(hudson.util.Secret projectId, hudson.util.Secret tokenId, String queueName, String preferredServerName, boolean send_success, boolean send_failure, boolean send_unstable, long expirySeconds) DataBoundConstructor for IronMQNotifier.

Method Summary

Modifier and Type	Method and Description
String	getDefaultPreferredServerName() Getter for the field defaultPreferredServer.
IronMQNotifier.IronMQNotifierDescriptor	getDescriptor()
Long	getExpirySeconds() Getter for the field expirySeconds.
String	getJobName() Getter for the field jobName.
String	getPreferredServerName() Getter for the field preferredServerName.
hudson.util.Secret	getProjectId() Getter for the field projectId.
String	getQueueName() Getter for the field queueName.
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
hudson.util.Secret	getTokenId() Getter for the field tokenId.
boolean	needsToRunAfterFinalized()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
protected int	sendMessageToIronMQ()
void	setDefaultPreferredServerName(String defaultPreferredServerName) Setter for the field defaultPreferredServerName.
void	setExpirySeconds(Long expirySeconds) Setter for the field expirySeconds.
void	setPreferredServerName(String preferredServerName) Setter for the field preferredServerName.
void	setProjectId(hudson.util.Secret projectId) Setter for the field projectId.
void	setQueueName(String queueName) Setter for the field queueName.
void	setTokenId(hudson.util.Secret tokenId) Setter for the field tokenId.

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Field Detail

send_success

public boolean send_success

send_failure

public boolean send_failure

send_unstable

public boolean send_unstable

Constructor Detail

IronMQNotifier

@DataBoundConstructor
public IronMQNotifier(hudson.util.Secret projectId,
                                            hudson.util.Secret tokenId,
                                            String queueName,
                                            String preferredServerName,
                                            boolean send_success,
                                            boolean send_failure,
                                            boolean send_unstable,
                                            long expirySeconds)

DataBoundConstructor for IronMQNotifier.

Parameters:

projectId - a Secret object.

tokenId - a Secret object.

queueName - a String object.

preferredServerName - a String object.

send_success - a Boolean object.

send_failure - a Boolean object.

send_unstable - a Boolean object.

expirySeconds - a Long object.

Method Detail

perform

public void perform(hudson.model.Run<?,?> build,
                    hudson.FilePath workspace,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener)
             throws hudson.AbortException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

hudson.AbortException

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

getDescriptor

public IronMQNotifier.IronMQNotifierDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Notifier

sendMessageToIronMQ

protected int sendMessageToIronMQ()
                           throws IOException

Throws:

IOException

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Overrides:

needsToRunAfterFinalized in class hudson.tasks.Publisher

getJobName

public String getJobName()

Getter for the field jobName.

Returns:

a String object.

Since:

1.0.6

getQueueName

public String getQueueName()

Getter for the field queueName.

Returns:

a String object.

Since:

1.0.6

setQueueName

public void setQueueName(String queueName)

Setter for the field queueName.

Parameters:

queueName - a String object.

Since:

1.0.6

getProjectId

public hudson.util.Secret getProjectId()

Getter for the field projectId.

Returns:

a Secret object.

Since:

1.0.19

setProjectId

public void setProjectId(hudson.util.Secret projectId)

Setter for the field projectId.

Parameters:

projectId - a Secret object.

Since:

1.0.19

getTokenId

public hudson.util.Secret getTokenId()

Getter for the field tokenId.

Returns:

a Secret object.

Since:

1.0.19

setTokenId

public void setTokenId(hudson.util.Secret tokenId)

Setter for the field tokenId.

Parameters:

tokenId - a Secret object.

Since:

1.0.19

getExpirySeconds

public Long getExpirySeconds()

Getter for the field expirySeconds.

Returns:

a Long object.

setExpirySeconds

public void setExpirySeconds(Long expirySeconds)

Setter for the field expirySeconds.

Parameters:

expirySeconds - a Long object.

setPreferredServerName

public void setPreferredServerName(String preferredServerName)

Setter for the field preferredServerName.

Parameters:

preferredServerName - a String object.

Since:

1.0.6

getPreferredServerName

public String getPreferredServerName()

Getter for the field preferredServerName.

Returns:

a String object.

Since:

1.0.6

getDefaultPreferredServerName

public String getDefaultPreferredServerName()

Getter for the field defaultPreferredServer.

Returns:

a String object.

Since:

1.0.6

setDefaultPreferredServerName

public void setDefaultPreferredServerName(String defaultPreferredServerName)

Setter for the field defaultPreferredServerName.

Parameters:

defaultPreferredServerName - a String object.

Since:

1.0.6