com.mathworks.polyspace.jenkins

Class PolyspacePostBuildActions

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

com.mathworks.polyspace.jenkins.PolyspacePostBuildActions

All Implemented Interfaces:

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

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

Publisher that sends Polyspace Notification in e-mail.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PolyspacePostBuildActions.DescriptorImpl

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
String	fileToAttach Whitespace-separated list of e-mail addresses that represent recipients
String	mailBody File containing the mail subject.
String	mailBodyBaseName base name of the file containing the mail subject.
String	mailSubject File to attach
String	mailSubjectBaseName query base name
String	queryBaseName True if we want to send an email to all owners
String	recipients True if we want to send an email to a list of recipients
Boolean	sendToOwners File containing the mail body.
Boolean	sendToRecipients
String	uniqueRecipients base name of the file containing the mail body.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
PolyspacePostBuildActions() Unique recipient that receives all emails

Method Summary

Modifier and Type	Method and Description
hudson.tasks.BuildStepMonitor	getRequiredMonitorService() This class does explicit check pointing.
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	sendMail(String sendMailTo, String subject, String text, String attachSource, String attachName)
void	setFileToAttach(String fileToAttach)
void	setMailBody(String mailBody)
void	setMailBodyBaseName(String mailBodyBaseName)
void	setMailSubject(String mailSubject)
void	setMailSubjectBaseName(String mailSubjectBaseName)
void	setQueryBaseName(String queryBaseName)
void	setRecipients(String recipients)
void	setSendToOwners(Boolean sendToOwners)
void	setSendToRecipients(Boolean sendToRecipients)
void	setUniqueRecipients(String uniqueRecipients)
static javax.mail.internet.InternetAddress	stringToAddress(String strAddress, String charset) Converts a String to InternetAddress.

Methods inherited from class hudson.tasks.Notifier

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, 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

sendToRecipients

public Boolean sendToRecipients

recipients

public String recipients

True if we want to send an email to a list of recipients

fileToAttach

public String fileToAttach

Whitespace-separated list of e-mail addresses that represent recipients

mailSubject

public String mailSubject

File to attach

mailBody

public String mailBody

File containing the mail subject. "" if generic subject is to be applied

sendToOwners

public Boolean sendToOwners

File containing the mail body. "" if generic body is to be applied

queryBaseName

public String queryBaseName

True if we want to send an email to all owners

mailSubjectBaseName

public String mailSubjectBaseName

query base name

mailBodyBaseName

public String mailBodyBaseName

base name of the file containing the mail subject. "" if generic subject is to be applied. file for a user is mailSubjectBaseName _ user . ext

uniqueRecipients

public String uniqueRecipients

base name of the file containing the mail body. "" if generic body is to be applied. file for a user is mailBodyBaseName _ user . ext

Constructor Detail

PolyspacePostBuildActions

@DataBoundConstructor
public PolyspacePostBuildActions()

Unique recipient that receives all emails

Method Detail

setSendToRecipients

@DataBoundSetter
public void setSendToRecipients(Boolean sendToRecipients)

setRecipients

@DataBoundSetter
public void setRecipients(String recipients)

setFileToAttach

@DataBoundSetter
public void setFileToAttach(String fileToAttach)

setMailSubject

@DataBoundSetter
public void setMailSubject(String mailSubject)

setMailBody

@DataBoundSetter
public void setMailBody(String mailBody)

setSendToOwners

@DataBoundSetter
public void setSendToOwners(Boolean sendToOwners)

setQueryBaseName

@DataBoundSetter
public void setQueryBaseName(String queryBaseName)

setMailSubjectBaseName

@DataBoundSetter
public void setMailSubjectBaseName(String mailSubjectBaseName)

setMailBodyBaseName

@DataBoundSetter
public void setMailBodyBaseName(String mailBodyBaseName)

setUniqueRecipients

@DataBoundSetter
public void setUniqueRecipients(String uniqueRecipients)

sendMail

public void sendMail(@QueryParameter
                     String sendMailTo,
                     @QueryParameter
                     String subject,
                     @QueryParameter
                     String text,
                     @QueryParameter
                     String attachSource,
                     @QueryParameter
                     String attachName)
              throws IOException

Throws:

IOException

perform

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

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

IOException

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

This class does explicit check pointing.

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

stringToAddress

@Nonnull
public static javax.mail.internet.InternetAddress stringToAddress(@Nonnull
                                                                           String strAddress,
                                                                           @Nonnull
                                                                           String charset)
                                                                    throws javax.mail.internet.AddressException,
                                                                           UnsupportedEncodingException

Converts a String to InternetAddress.

Parameters:

strAddress - Address String

charset - Charset (encoding) to be used

Returns:

InternetAddress for the specified String

Throws:

javax.mail.internet.AddressException - Malformed address

UnsupportedEncodingException - Unsupported encoding

Since: