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

public class StashNotifier
extends hudson.tasks.Notifier

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 hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

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
String	getCommitSha1()
String	getCredentialsId()
StashNotifier.DescriptorImpl	getDescriptor()
protected org.apache.http.client.HttpClient	getHttpClient(PrintStream logger, hudson.model.AbstractBuild<?,?> build) 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 <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.
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener 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()

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

getHttpClient

protected org.apache.http.client.HttpClient getHttpClient(PrintStream logger,
                                                          hudson.model.AbstractBuild<?,?> build)
                                                   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

build -

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

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.