org.gitlab4j.api.systemhooks

Class SystemHookManager

java.lang.Object

org.gitlab4j.api.HookManager

org.gitlab4j.api.systemhooks.SystemHookManager

public class SystemHookManager
extends HookManager

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_HOOK_EVENT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addListener(SystemHookListener listener) Adds a System Hook event listener.
void	fireEvent(SystemHookEvent event) Fire the event to the registered listeners.
protected void	fireProjectEvent(ProjectSystemHookEvent event)
protected void	fireTeamMemberEvent(TeamMemberSystemHookEvent event)
void	handleEvent(javax.servlet.http.HttpServletRequest request) Parses and verifies an SystemHookEvent instance from the HTTP request and fires it off to the registered listeners.
void	handleEvent(SystemHookEvent event) Verifies the provided Event and fires it off to the registered listeners.
void	removeListener(SystemHookListener listener) Removes a System Hook 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

Field Detail

SYSTEM_HOOK_EVENT

public static final String SYSTEM_HOOK_EVENT

See Also:

Constant Field Values

Constructor Detail

SystemHookManager

public SystemHookManager()

Create a HookManager to handle GitLab system hook events.

SystemHookManager

public SystemHookManager(String secretToken)

Create a HookManager to handle GitLab system hook 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 SystemHookEvent 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(SystemHookEvent 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(SystemHookListener listener)

Adds a System Hook event listener.

Parameters:

listener - the SystemHookListener to add

removeListener

public void removeListener(SystemHookListener listener)

Removes a System Hook event listener.

Parameters:

listener - the SystemHookListener to remove

fireEvent

public void fireEvent(SystemHookEvent event)
               throws GitLabApiException

Fire the event to the registered listeners.

Parameters:

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

Throws:

GitLabApiException - if the event is not supported

fireProjectEvent

protected void fireProjectEvent(ProjectSystemHookEvent event)

fireTeamMemberEvent

protected void fireTeamMemberEvent(TeamMemberSystemHookEvent event)