Package org.gitlab4j.api

Class HookManager

java.lang.Object

org.gitlab4j.api.HookManager

Direct Known Subclasses:

SystemHookManager, WebHookManager

public abstract class HookManager
extends Object

This class provides a base class handler for processing GitLab Web Hook and System Hook callouts.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
abstract 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.
boolean	isValidSecretToken(String secretToken)	Validate the provided secret token against the reference secret token.
boolean	isValidSecretToken(javax.servlet.http.HttpServletRequest request)	Validate the provided secret token found in the HTTP header against the reference secret token.
void	setSecretToken(String secretToken)	Set the secret token that received hook events should be validated against.

Methods inherited from class java.lang.Object

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

Constructor Detail

HookManager

public HookManager()

Create a HookManager to handle GitLab hook events.

HookManager

public HookManager(String secretToken)

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

Parameters:

secretToken - the secret token to verify against

Method Detail

setSecretToken

public void setSecretToken(String secretToken)

Set the secret token that received hook events should be validated against.

Parameters:

secretToken - the secret token to verify against

isValidSecretToken

public boolean isValidSecretToken(String secretToken)

Validate the provided secret token against the reference secret token. Returns true if the secret token is valid or there is no reference secret token to validate against, otherwise returns false.

Parameters:

secretToken - the token to validate

Returns:

true if the secret token is valid or there is no reference secret token to validate against

isValidSecretToken

public boolean isValidSecretToken(javax.servlet.http.HttpServletRequest request)

Validate the provided secret token found in the HTTP header against the reference secret token. Returns true if the secret token is valid or there is no reference secret token to validate against, otherwise returns false.

Parameters:

request - the HTTP request to verify the secret token

Returns:

true if the secret token is valid or there is no reference secret token to validate against

handleEvent

public abstract 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.

Parameters:

request - the HttpServletRequest to read the Event instance from

Throws:

GitLabApiException - if the parsed event is not supported