Package org.gitlab4j.api.webhook

Class WebHookManager

java.lang.Object

org.gitlab4j.api.HookManager

org.gitlab4j.api.webhook.WebHookManager

public class WebHookManager
extends HookManager

This class provides a handler for processing GitLab WebHook callouts.

Constructor Summary

Constructors

Constructor	Description
WebHookManager()	Create a HookManager to handle GitLab webhook events.
WebHookManager(String secretToken)	Create a HookManager to handle GitLab webhook events which will be verified against the specified secretToken.

Method Summary

Modifier and Type	Method	Description
void	addListener(WebHookListener listener)	Adds a WebHook event listener.
protected void	fireBuildEvent(BuildEvent buildEvent)
void	fireEvent(Event event)	Fire the event to the registered listeners.
protected void	fireIssueEvent(IssueEvent issueEvent)
protected void	fireMergeRequestEvent(MergeRequestEvent mergeRequestEvent)
protected void	fireNoteEvent(NoteEvent noteEvent)
protected void	firePipelineEvent(PipelineEvent pipelineEvent)
protected void	firePushEvent(PushEvent pushEvent)
protected void	fireTagPushEvent(TagPushEvent tagPushEvent)
protected void	fireWikiPageEvent(WikiPageEvent wikiPageEvent)
void	handleEvent(javax.servlet.http.HttpServletRequest request)	Parses and verifies an Event instance from the HTTP request and fires it off to the registered listeners.
void	handleEvent(Event event)	Verifies the provided Event and fires it off to the registered listeners.
void	removeListener(WebHookListener listener)	Removes a WebHook event listener.

Methods inherited from class org.gitlab4j.api.HookManager

isValidSecretToken, isValidSecretToken, setSecretToken

Methods inherited from class java.lang.Object

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

Constructor Detail

WebHookManager

public WebHookManager()

Create a HookManager to handle GitLab webhook events.

WebHookManager

public WebHookManager(String secretToken)

Create a HookManager to handle GitLab webhook events which will be verified against the specified secretToken.

Parameters:

secretToken - the secret token to verify against

Method Detail

handleEvent

public void handleEvent(javax.servlet.http.HttpServletRequest request)
                 throws GitLabApiException

Parses and verifies an Event instance from the HTTP request and fires it off to the registered listeners.

Specified by:

handleEvent in class HookManager

Parameters:

request - the HttpServletRequest to read the Event instance from

Throws:

GitLabApiException - if the parsed event is not supported

handleEvent

public void handleEvent(Event event)
                 throws GitLabApiException

Verifies the provided Event and fires it off to the registered listeners.

Parameters:

event - the Event instance to handle

Throws:

GitLabApiException - if the event is not supported

addListener

public void addListener(WebHookListener listener)

Adds a WebHook event listener.

Parameters:

listener - the SystemHookListener to add

removeListener

public void removeListener(WebHookListener listener)

Removes a WebHook event listener.

Parameters:

listener - the SystemHookListener to remove

fireEvent

public void fireEvent(Event event)
               throws GitLabApiException

Fire the event to the registered listeners.

Parameters:

event - the Event instance to fire to the registered event listeners

Throws:

GitLabApiException - if the event is not supported

fireBuildEvent

protected void fireBuildEvent(BuildEvent buildEvent)

fireIssueEvent

protected void fireIssueEvent(IssueEvent issueEvent)

fireMergeRequestEvent

protected void fireMergeRequestEvent(MergeRequestEvent mergeRequestEvent)

fireNoteEvent

protected void fireNoteEvent(NoteEvent noteEvent)

firePipelineEvent

protected void firePipelineEvent(PipelineEvent pipelineEvent)

firePushEvent

protected void firePushEvent(PushEvent pushEvent)

fireTagPushEvent

protected void fireTagPushEvent(TagPushEvent tagPushEvent)

fireWikiPageEvent

protected void fireWikiPageEvent(WikiPageEvent wikiPageEvent)