hudson.plugins.emailext
Class ExtendedEmailPublisher

java.lang.Object
  extended by hudson.tasks.BuildStepCompatibilityLayer
      extended by hudson.tasks.Publisher
          extended by hudson.tasks.Notifier
              extended by hudson.plugins.emailext.ExtendedEmailPublisher
All Implemented Interfaces:
hudson.ExtensionPoint, hudson.matrix.MatrixAggregatable, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class ExtendedEmailPublisher
extends hudson.tasks.Notifier
implements hudson.matrix.MatrixAggregatable

Publisher that sends notification e-mail.


Nested Class Summary
static class ExtendedEmailPublisher.DescriptorImpl
           
 
Nested classes/interfaces inherited from class hudson.tasks.Publisher
hudson.tasks.Publisher.DescriptorExtensionListImpl
 
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson
 
Nested classes/interfaces inherited from interface hudson.tasks.BuildStep
hudson.tasks.BuildStep.PublisherList
 
Field Summary
 String attachmentsPattern
          The project wide set of attachments.
 List<EmailTrigger> configuredTriggers
          This is the list of email triggers that the project has configured
 String contentType
          The contentType of the emails for this project (text/html, text/plain, etc).
static String DEFAULT_BODY_TEXT
           
static String DEFAULT_EMERGENCY_REROUTE_TEXT
           
static String DEFAULT_RECIPIENTS_TEXT
           
static String DEFAULT_SUBJECT_TEXT
           
 String defaultContent
          The default body of the emails for this project.
 String defaultSubject
          The default subject of the emails for this project.
static ExtendedEmailPublisherDescriptor DESCRIPTOR
           
static Map<String,EmailTriggerDescriptor> EMAIL_TRIGGER_TYPE_MAP
           
static String PROJECT_DEFAULT_BODY_TEXT
           
static String PROJECT_DEFAULT_SUBJECT_TEXT
           
 String recipientList
          A comma-separated list of email recipient that will be used for every trigger.
 
Fields inherited from interface hudson.tasks.BuildStep
BUILDERS, PUBLISHERS
 
Constructor Summary
ExtendedEmailPublisher()
           
 
Method Summary
static void addEmailTriggerType(EmailTriggerDescriptor triggerType)
           
 hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild matrixbuild, hudson.Launcher launcher, hudson.model.BuildListener buildlistener)
           
 boolean getConfigured()
          Return true if the project has been configured, otherwise returns false
 List<EmailTrigger> getConfiguredTriggers()
          Get the list of configured email triggers for this project.
 hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher> getDescriptor()
           
static Collection<String> getEmailTriggerNames()
           
static Collection<EmailTriggerDescriptor> getEmailTriggers()
           
static EmailTriggerDescriptor getEmailTriggerType(String mailerId)
           
 MatrixTriggerMode getMatrixTriggerMode()
           
 List<EmailTrigger> getNonConfiguredTriggers()
          Get the list of non-configured email triggers for this project.
 hudson.tasks.BuildStepMonitor getRequiredMonitorService()
           
static List<EmailTrigger> getTriggersForNonConfiguredInstance()
           
 boolean isConfigured()
          Return true if the project has been configured, otherwise returns false
 boolean isExecuteOnMatrixNodes()
           
 boolean needsToRunAfterFinalized()
           
 boolean perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
           
 boolean prebuild(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener)
           
static void removeEmailTriggerType(EmailTriggerDescriptor triggerType)
           
 void setMatrixTriggerMode(MatrixTriggerMode matrixTriggerMode)
           
 
Methods inherited from class hudson.tasks.Publisher
all, getProjectAction, prebuild
 
Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer
getProjectAction, getProjectActions, perform
 
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
 

Field Detail

EMAIL_TRIGGER_TYPE_MAP

public static final Map<String,EmailTriggerDescriptor> EMAIL_TRIGGER_TYPE_MAP

DEFAULT_RECIPIENTS_TEXT

public static final String DEFAULT_RECIPIENTS_TEXT
See Also:
Constant Field Values

DEFAULT_SUBJECT_TEXT

public static final String DEFAULT_SUBJECT_TEXT
See Also:
Constant Field Values

DEFAULT_BODY_TEXT

public static final String DEFAULT_BODY_TEXT
See Also:
Constant Field Values

DEFAULT_EMERGENCY_REROUTE_TEXT

public static final String DEFAULT_EMERGENCY_REROUTE_TEXT
See Also:
Constant Field Values

PROJECT_DEFAULT_SUBJECT_TEXT

public static final String PROJECT_DEFAULT_SUBJECT_TEXT
See Also:
Constant Field Values

PROJECT_DEFAULT_BODY_TEXT

public static final String PROJECT_DEFAULT_BODY_TEXT
See Also:
Constant Field Values

recipientList

public String recipientList
A comma-separated list of email recipient that will be used for every trigger.


configuredTriggers

public List<EmailTrigger> configuredTriggers
This is the list of email triggers that the project has configured


contentType

public String contentType
The contentType of the emails for this project (text/html, text/plain, etc).


defaultSubject

public String defaultSubject
The default subject of the emails for this project. ($PROJECT_DEFAULT_SUBJECT)


defaultContent

public String defaultContent
The default body of the emails for this project. ($PROJECT_DEFAULT_BODY)


attachmentsPattern

public String attachmentsPattern
The project wide set of attachments.


DESCRIPTOR

@Extension
public static final ExtendedEmailPublisherDescriptor DESCRIPTOR
Constructor Detail

ExtendedEmailPublisher

public ExtendedEmailPublisher()
Method Detail

addEmailTriggerType

public static void addEmailTriggerType(EmailTriggerDescriptor triggerType)
                                throws EmailExtException
Throws:
EmailExtException

removeEmailTriggerType

public static void removeEmailTriggerType(EmailTriggerDescriptor triggerType)

getEmailTriggerType

public static EmailTriggerDescriptor getEmailTriggerType(String mailerId)

getEmailTriggers

public static Collection<EmailTriggerDescriptor> getEmailTriggers()

getEmailTriggerNames

public static Collection<String> getEmailTriggerNames()

getTriggersForNonConfiguredInstance

public static List<EmailTrigger> getTriggersForNonConfiguredInstance()

getConfiguredTriggers

public List<EmailTrigger> getConfiguredTriggers()
Get the list of configured email triggers for this project.


getNonConfiguredTriggers

public List<EmailTrigger> getNonConfiguredTriggers()
Get the list of non-configured email triggers for this project.


isConfigured

public boolean isConfigured()
Return true if the project has been configured, otherwise returns false


getConfigured

public boolean getConfigured()
Return true if the project has been configured, otherwise returns false


getMatrixTriggerMode

public MatrixTriggerMode getMatrixTriggerMode()

setMatrixTriggerMode

public void setMatrixTriggerMode(MatrixTriggerMode matrixTriggerMode)

prebuild

public boolean prebuild(hudson.model.AbstractBuild<?,?> build,
                        hudson.model.BuildListener listener)
Specified by:
prebuild in interface hudson.tasks.BuildStep
Overrides:
prebuild in class hudson.tasks.BuildStepCompatibilityLayer

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException
Specified by:
perform in interface hudson.tasks.BuildStep
Overrides:
perform in class hudson.tasks.BuildStepCompatibilityLayer
Throws:
InterruptedException
IOException

isExecuteOnMatrixNodes

public boolean isExecuteOnMatrixNodes()

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()
Overrides:
needsToRunAfterFinalized in class hudson.tasks.Publisher

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()
Specified by:
getRequiredMonitorService in interface hudson.tasks.BuildStep

getDescriptor

public hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher> getDescriptor()
Specified by:
getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>
Overrides:
getDescriptor in class hudson.tasks.Notifier

createAggregator

public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild matrixbuild,
                                                       hudson.Launcher launcher,
                                                       hudson.model.BuildListener buildlistener)
Specified by:
createAggregator in interface hudson.matrix.MatrixAggregatable


Copyright © 2004-2012. All Rights Reserved.