Package com.cloudbees.jenkins.plugins.bitbucket.impl.webhook.server

Class ServerWebhookManager

java.lang.Object

com.cloudbees.jenkins.plugins.bitbucket.impl.webhook.AbstractWebhookManager<ServerWebhookConfiguration>

com.cloudbees.jenkins.plugins.bitbucket.impl.webhook.server.ServerWebhookManager

All Implemented Interfaces:

BitbucketWebhookManager, ExtensionPoint

@Extension
public class ServerWebhookManager
extends AbstractWebhookManager<ServerWebhookConfiguration>

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.cloudbees.jenkins.plugins.bitbucket.impl.webhook.AbstractWebhookManager

callbackURL, configuration

Constructor Summary

Constructors

Constructor	Description
ServerWebhookManager()

Method Summary

Modifier and Type	Method	Description
void	apply(BitbucketWebhookConfiguration configuration)	The configuration that returned this implementation class.
static void	clearCaches()
Collection<BitbucketWebHook>	read(BitbucketAuthenticatedClient client)	Returns the list of all registered webhook at this repository related to this Jenkins.
void	register(BitbucketAuthenticatedClient client)	Save a webhook (updating or creating a new one) using the actual configuration.
void	remove(String webhookId, BitbucketAuthenticatedClient client)	Remove the webhook from the Bitbucket repository with the given identifier.
void	setCallbackURL(String callbackURL, BitbucketEndpoint endpoint)	The callback URL where send event payload.
static List<String>	stats()

Methods inherited from class com.cloudbees.jenkins.plugins.bitbucket.impl.webhook.AbstractWebhookManager

buildCacheKey, getEndpointJenkinsRootURL, isCacheEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloudbees.jenkins.plugins.bitbucket.api.webhook.BitbucketWebhookManager

apply, supportedTraits, withTraits

Constructor Details

ServerWebhookManager

public ServerWebhookManager()

Method Details

clearCaches

public static void clearCaches()

stats

public static List<String> stats()

setCallbackURL

public void setCallbackURL(@NonNull
 String callbackURL,
 @NonNull
 BitbucketEndpoint endpoint)

Description copied from interface: BitbucketWebhookManager

The callback URL where send event payload.

The method is called with the URL of the default receiver and processed using an appropriate BitbucketWebhookProcessor. The implementation could decide to ignore given URL and use an own servlet endpoint to process own events.

Specified by:

setCallbackURL in interface BitbucketWebhookManager

Overrides:

setCallbackURL in class AbstractWebhookManager<ServerWebhookConfiguration>

Parameters:

callbackURL - used to send webhook payload.

endpoint - this webhook is registered for, it could be used to retrieve additional information to compose the callbackURL

apply

public void apply(BitbucketWebhookConfiguration configuration)

Description copied from interface: BitbucketWebhookManager

The configuration that returned this implementation class.

Specified by:

apply in interface BitbucketWebhookManager

Overrides:

apply in class AbstractWebhookManager<ServerWebhookConfiguration>

Parameters:

configuration - to apply

read

@NonNull
public Collection<BitbucketWebHook> read(@NonNull
 BitbucketAuthenticatedClient client)
                                  throws IOException

Description copied from interface: BitbucketWebhookManager

Returns the list of all registered webhook at this repository related to this Jenkins.

Parameters:

client - authenticated to communicate with Bitbucket

Returns:

a list of registered BitbucketWebHook.

Throws:

IOException - in case of communication issue with Bitbucket

remove

public void remove(@NonNull
 String webhookId,
 @NonNull
 BitbucketAuthenticatedClient client)
            throws IOException

Description copied from interface: BitbucketWebhookManager

Remove the webhook from the Bitbucket repository with the given identifier.

Parameters:

webhookId - webhook identifier to delete.

client - authenticated to communicate with Bitbucket

Throws:

IOException - in case of communication issue with Bitbucket

register

public void register(@NonNull
 BitbucketAuthenticatedClient client)
              throws IOException

Description copied from interface: BitbucketWebhookManager

Save a webhook (updating or creating a new one) using the actual configuration.

Parameters:

client - authenticated to communicate with Bitbucket

Throws:

IOException - in case of communication issue with Bitbucket