org.jenkinsci.plugins.stashNotifier

Class StashNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

org.jenkinsci.plugins.stashNotifier.StashNotifier

All Implemented Interfaces:

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

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

Notifies a configured Atlassian Stash server instance of build results through the Stash build API.

Only basic authentication is supported at the moment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StashNotifier.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
static int	MAX_FIELD_LENGTH
static int	MAX_URL_FIELD_LENGTH

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
StashNotifier(String stashServerBaseUrl, String credentialsId, boolean ignoreUnverifiedSSLPeer, String commitSha1, boolean includeBuildNumberInKey, String projectKey, boolean prependParentProjectKey, boolean disableInprogressNotification)

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpPost	createRequest(org.apache.http.HttpEntity stashBuildNotificationEntity, hudson.model.Item project, String commitSha1) Returns the HTTP POST request ready to be sent to the Stash build API for the given run and change set.
protected String	getBuildDescription(hudson.model.Run<?,?> run, StashBuildState state) Returns the description of the run used for the Stash notification.
protected String	getBuildKey(hudson.model.Run<?,?> run, hudson.model.TaskListener listener) Returns the run key used in the Stash notification.
String	getCommitSha1()
String	getCredentialsId()
StashNotifier.DescriptorImpl	getDescriptor()
protected org.apache.http.client.HttpClient	getHttpClient(PrintStream logger, hudson.model.Run<?,?> run) Returns the HttpClient through which the REST call is made.
boolean	getIgnoreUnverifiedSSLPeer()
boolean	getIncludeBuildNumberInKey()
boolean	getPrependParentProjectKey()
String	getProjectKey()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getStashServerBaseUrl()
boolean	isDisableInprogressNotification()
protected Collection<String>	lookupCommitSha1s(hudson.model.Run run, hudson.model.TaskListener listener)
protected <C extends com.cloudbees.plugins.credentials.Credentials> List<C>	lookupCredentials(Class<C> type, hudson.model.Item item, org.acegisecurity.Authentication authentication, ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) Returns all credentials which are available to the specified Authentication for use by the specified Item.
protected <C extends com.cloudbees.plugins.credentials.Credentials> List<C>	lookupCredentials(Class<C> type, hudson.model.ItemGroup<?> itemGroup, org.acegisecurity.Authentication authentication, ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) Returns all credentials which are available to the specified Authentication for use by the specified Item.
protected NotificationResult	notifyStash(PrintStream logger, hudson.model.Run<?,?> run, String commitSha1, hudson.model.TaskListener listener, StashBuildState state) Notifies the configured Stash server by POSTing the run results to the Stash run API.
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
boolean	prebuild(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Publisher

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

MAX_FIELD_LENGTH

public static final int MAX_FIELD_LENGTH

See Also:

Constant Field Values

MAX_URL_FIELD_LENGTH

public static final int MAX_URL_FIELD_LENGTH

See Also:

Constant Field Values

Constructor Detail

StashNotifier

@DataBoundConstructor
public StashNotifier(String stashServerBaseUrl,
                                            String credentialsId,
                                            boolean ignoreUnverifiedSSLPeer,
                                            String commitSha1,
                                            boolean includeBuildNumberInKey,
                                            String projectKey,
                                            boolean prependParentProjectKey,
                                            boolean disableInprogressNotification)

Method Detail

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

isDisableInprogressNotification

public boolean isDisableInprogressNotification()

getCredentialsId

public String getCredentialsId()

getStashServerBaseUrl

public String getStashServerBaseUrl()

getIgnoreUnverifiedSSLPeer

public boolean getIgnoreUnverifiedSSLPeer()

getCommitSha1

public String getCommitSha1()

getIncludeBuildNumberInKey

public boolean getIncludeBuildNumberInKey()

getProjectKey

public String getProjectKey()

getPrependParentProjectKey

public boolean getPrependParentProjectKey()

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)

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

perform

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

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

lookupCommitSha1s

protected Collection<String> lookupCommitSha1s(hudson.model.Run run,
                                               hudson.model.TaskListener listener)

getHttpClient

protected org.apache.http.client.HttpClient getHttpClient(PrintStream logger,
                                                          hudson.model.Run<?,?> run)
                                                   throws Exception

Returns the HttpClient through which the REST call is made. Uses an unsafe TrustStrategy in case the user specified a HTTPS URL and set the ignoreUnverifiedSSLPeer flag.

Parameters:

logger - the logger to log messages to

run -

Returns:

the HttpClient

Throws:

Exception

getDescriptor

public StashNotifier.DescriptorImpl getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Notifier

notifyStash

protected NotificationResult notifyStash(PrintStream logger,
                                         hudson.model.Run<?,?> run,
                                         String commitSha1,
                                         hudson.model.TaskListener listener,
                                         StashBuildState state)
                                  throws Exception

Notifies the configured Stash server by POSTing the run results to the Stash run API.

Parameters:

logger - the logger to use

run - the run to notify Stash of

commitSha1 - the SHA1 of the run commit

listener - the run listener for logging

state - the state of the build as defined by the Stash API.

Throws:

Exception

lookupCredentials

protected <C extends com.cloudbees.plugins.credentials.Credentials> List<C> lookupCredentials(Class<C> type,
                                                                                              hudson.model.Item item,
                                                                                              org.acegisecurity.Authentication authentication,
                                                                                              ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)

Returns all credentials which are available to the specified Authentication for use by the specified Item.

Type Parameters:

C - the credentials type.

Parameters:

type - the type of credentials to get.

authentication - the authentication.

item - the item.

domainRequirements - the credential domains to match.

Returns:

the list of credentials.

lookupCredentials

protected <C extends com.cloudbees.plugins.credentials.Credentials> List<C> lookupCredentials(Class<C> type,
                                                                                              hudson.model.ItemGroup<?> itemGroup,
                                                                                              org.acegisecurity.Authentication authentication,
                                                                                              ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)

Returns all credentials which are available to the specified Authentication for use by the specified Item.

Type Parameters:

C - the credentials type.

Parameters:

type - the type of credentials to get.

authentication - the authentication.

itemGroup - the item group.

domainRequirements - the credential domains to match.

Returns:

the list of credentials.

createRequest

protected org.apache.http.client.methods.HttpPost createRequest(org.apache.http.HttpEntity stashBuildNotificationEntity,
                                                                hudson.model.Item project,
                                                                String commitSha1)
                                                         throws org.apache.http.auth.AuthenticationException

Returns the HTTP POST request ready to be sent to the Stash build API for the given run and change set.

Parameters:

stashBuildNotificationEntity - a entity containing the parameters for Stash

commitSha1 - the SHA1 of the commit that was built

Returns:

the HTTP POST request to the Stash build API

Throws:

org.apache.http.auth.AuthenticationException

getBuildKey

protected String getBuildKey(hudson.model.Run<?,?> run,
                             hudson.model.TaskListener listener)

Returns the run key used in the Stash notification. Includes the run number depending on the user setting.

Parameters:

run - the run to notify Stash of

Returns:

the run key for the Stash notification

getBuildDescription

protected String getBuildDescription(hudson.model.Run<?,?> run,
                                     StashBuildState state)

Returns the description of the run used for the Stash notification. Uses the run description provided by the Jenkins job, if available.

Parameters:

run - the run to be described

state - the state of the run

Returns:

the description of the run