hudson.plugins.git

Class GitStatus

java.lang.Object

hudson.model.AbstractModelObject

hudson.plugins.git.GitStatus

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction, hudson.model.UnprotectedRootAction, hudson.search.SearchableModelObject, hudson.search.SearchItem

@Extension
public class GitStatus
extends hudson.model.AbstractModelObject
implements hudson.model.UnprotectedRootAction

Information screen for the use of Git in Hudson.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitStatus.CommitHookCause
static class	GitStatus.JenkinsAbstractProjectListener Handle standard SCMTriggerItem instances with a standard SCMTrigger.
static class	GitStatus.Listener Other plugins may be interested in listening for these updates.
static class	GitStatus.MessageResponseContributor A response contributor that just adds a simple message to the body.
static class	GitStatus.ResponseContributor Contributes to a doNotifyCommit(HttpServletRequest, String, String, String) response.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ALLOW_NOTIFY_COMMIT_PARAMETERS Allow arbitrary notify commit parameters.
static String	SAFE_PARAMETERS Allow specifically declared safe parameters.

Constructor Summary

Constructors

Constructor and Description
GitStatus()

Method Summary

Modifier and Type	Method and Description
org.kohsuke.stapler.HttpResponse	doNotifyCommit(javax.servlet.http.HttpServletRequest request, String url, String branches, String sha1)
String	getDisplayName()
String	getIconFileName()
String	getSearchUrl()
String	getUrlName()
static boolean	looselyMatches(org.eclipse.jgit.transport.URIish lhs, org.eclipse.jgit.transport.URIish rhs) Used to test if what we have in the job configuration matches what was submitted to the notification endpoint.
String	toString()

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_NOTIFY_COMMIT_PARAMETERS

public static final boolean ALLOW_NOTIFY_COMMIT_PARAMETERS

Allow arbitrary notify commit parameters. SECURITY-275 detected that allowing arbitrary parameters through the notifyCommit URL allows an unauthenticated user to set environment variables for a job. If this property is set to true, then the bug exposed by SECURITY-275 will be brought back. Only enable this if you trust all unauthenticated users to not pass harmful arguments to your jobs. -Dhudson.plugins.git.GitStatus.allowNotifyCommitParameters=true on command line Also honors the global Jenkins security setting "hudson.model.ParametersAction.keepUndefinedParameters" if it is set to true.

SAFE_PARAMETERS

public static final String SAFE_PARAMETERS

Allow specifically declared safe parameters. SECURITY-275 detected that allowing arbitrary parameters through the notifyCommit URL allows an unauthenticated user to set environment variables for a job. If this property is set to a comma separated list of parameters, then those parameters will be allowed for any job. Only set this value for parameters you trust in all the jobs in your system. -Dhudson.plugins.git.GitStatus.safeParameters=PARM1,PARM1 on command line Also honors the global Jenkins safe parameter list "hudson.model.ParametersAction.safeParameters" if set.

Constructor Detail

GitStatus

public GitStatus()

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getSearchUrl

public String getSearchUrl()

Specified by:

getSearchUrl in interface hudson.search.SearchItem

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

toString

public String toString()

Overrides:

toString in class Object

doNotifyCommit

public org.kohsuke.stapler.HttpResponse doNotifyCommit(javax.servlet.http.HttpServletRequest request,
                                                       @QueryParameter(required=true)
                                                       String url,
                                                       @QueryParameter(required=false)
                                                       String branches,
                                                       @QueryParameter(required=false)
                                                       String sha1)
                                                throws javax.servlet.ServletException,
                                                       IOException

Throws:

javax.servlet.ServletException

IOException

looselyMatches

public static boolean looselyMatches(org.eclipse.jgit.transport.URIish lhs,
                                     org.eclipse.jgit.transport.URIish rhs)

Used to test if what we have in the job configuration matches what was submitted to the notification endpoint. It is better to match loosely and wastes a few polling calls than to be pedantic and miss the push notification, especially given that Git tends to support multiple access protocols.

Parameters:

lhs - left-hand side of comparison

rhs - right-hand side of comparison

Returns:

true if left-hand side loosely matches right-hand side