Package org.gitlab4j.api

Interface HookManager

All Known Implementing Classes:
SystemHookManager, WebHookManager
public interface HookManager
This interface provides a base class handler for processing GitLab Web Hook and System Hook callouts.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getSecretToken()
    Get the secret token that received hook events should be validated against.
    void
    handleEvent(jakarta.servlet.http.HttpServletRequest request)
    Parses and verifies an Event instance from the HTTP request and fires it off to the registered listeners.
    default boolean
    isValidSecretToken(jakarta.servlet.http.HttpServletRequest request)
    Validate the provided secret token found in the HTTP header against the reference secret token.
    default boolean
    isValidSecretToken(String secretToken)
    Validate the provided secret token against the reference secret token.
    void
    setSecretToken(String secretToken)
    Set the secret token that received hook events should be validated against.

  • Method Details

    • getSecretToken

      String getSecretToken()
      Get the secret token that received hook events should be validated against.
      Returns:
      the secret token that received hook events should be validated against

    • setSecretToken

      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

      default 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

      default boolean isValidSecretToken(jakarta.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

      void handleEvent(jakarta.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