Package com.cloudbees.jenkins.plugins.bitbucket.hooks

Class BitbucketSCMSourcePushHookReceiver

java.lang.Object

hudson.security.csrf.CrumbExclusion

com.cloudbees.jenkins.plugins.bitbucket.hooks.BitbucketSCMSourcePushHookReceiver

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction, UnprotectedRootAction

@Extension
public class BitbucketSCMSourcePushHookReceiver
extends CrumbExclusion
implements UnprotectedRootAction

Process Bitbucket push and pull requests creations/updates hooks.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FULL_PATH

Constructor Summary

Constructors

Constructor	Description
BitbucketSCMSourcePushHookReceiver()

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	doNotify(org.kohsuke.stapler.StaplerRequest2 req)	Receives Bitbucket push notifications.
String	getDisplayName()
String	getIconFileName()
String	getUrlName()
boolean	process(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp, jakarta.servlet.FilterChain chain)

Methods inherited from class hudson.security.csrf.CrumbExclusion

all, process

Methods inherited from class java.lang.Object

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

Field Details

FULL_PATH

public static final String FULL_PATH

See Also:

• Constant Field Values

Constructor Details

BitbucketSCMSourcePushHookReceiver

public BitbucketSCMSourcePushHookReceiver()

Method Details

process

public boolean process(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse resp,
 jakarta.servlet.FilterChain chain)
                throws IOException,
jakarta.servlet.ServletException

Overrides:

process in class CrumbExclusion

Throws:

IOException

jakarta.servlet.ServletException

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

doNotify

public org.kohsuke.stapler.HttpResponse doNotify(org.kohsuke.stapler.StaplerRequest2 req)
                                          throws IOException

Receives Bitbucket push notifications.

Parameters:

req - Stapler request. It contains the payload in the body content and a header param "X-Event-Key" pointing to the event type.

Returns:

the HTTP response object

Throws:

IOException - if there is any issue reading the HTTP content payload.

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject