Package org.jenkinsci.plugins.github.webhook

Class RequirePostWithGHHookPayload.Processor

java.lang.Object

org.kohsuke.stapler.interceptor.Interceptor

org.jenkinsci.plugins.github.webhook.RequirePostWithGHHookPayload.Processor

Enclosing class:

RequirePostWithGHHookPayload

public static class RequirePostWithGHHookPayload.Processor
extends org.kohsuke.stapler.interceptor.Interceptor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SIGNATURE_HEADER	Header key being used for the payload signatures.

Fields inherited from class org.kohsuke.stapler.interceptor.Interceptor

target

Constructor Summary

Constructors

Constructor	Description
Processor()

Method Summary

Modifier and Type	Method	Description
Object	invoke(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, Object instance, Object[] arguments)
protected String	payloadFrom(org.kohsuke.stapler.StaplerRequest2 req, Object[] args)	Extracts parsed payload from args and prepare it to calculating hash (if json - pass as is, if form - url-encode it with prefix)
protected void	returnsInstanceIdentityIfLocalUrlTest(org.kohsuke.stapler.StaplerRequest2 req)	Used for GitHubPluginConfig.doCheckHookUrl(String)}
protected void	shouldBePostMethod(org.kohsuke.stapler.StaplerRequest2 request)	Duplicates RequirePOST precheck.
protected void	shouldContainParseablePayload(Object[] arguments)	Precheck arguments contains not null GHEvent and not blank payload.
protected void	shouldProvideValidSignature(org.kohsuke.stapler.StaplerRequest2 req, Object[] args)	Checks that an incoming request has a valid signature, if a hook secret is specified in the GitHub plugin config.

Methods inherited from class org.kohsuke.stapler.interceptor.Interceptor

invoke, setTarget

Methods inherited from class java.lang.Object

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

Field Details

SIGNATURE_HEADER

public static final String SIGNATURE_HEADER

Header key being used for the payload signatures.

See Also:

• Developer manual
• Constant Field Values

Constructor Details

Processor

public Processor()

Method Details

invoke

public Object invoke(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 Object instance,
 Object[] arguments)
              throws IllegalAccessException,
InvocationTargetException,
jakarta.servlet.ServletException

Overrides:

invoke in class org.kohsuke.stapler.interceptor.Interceptor

Throws:

IllegalAccessException

InvocationTargetException

jakarta.servlet.ServletException

shouldBePostMethod

protected void shouldBePostMethod(org.kohsuke.stapler.StaplerRequest2 request)
                           throws InvocationTargetException

Duplicates RequirePOST precheck. As of it can't guarantee order of multiply interceptor calls, it should implement all features of required interceptors in one class

Throws:

InvocationTargetException - if method os not POST

returnsInstanceIdentityIfLocalUrlTest

protected void returnsInstanceIdentityIfLocalUrlTest(org.kohsuke.stapler.StaplerRequest2 req)
                                              throws InvocationTargetException

Used for GitHubPluginConfig.doCheckHookUrl(String)}

Throws:

InvocationTargetException

shouldContainParseablePayload

protected void shouldContainParseablePayload(Object[] arguments)
                                      throws InvocationTargetException

Precheck arguments contains not null GHEvent and not blank payload. If any other argument will be added to root action index method, then arg count check should be changed

Parameters:

arguments - event and payload. Both not null and not blank

Throws:

InvocationTargetException - if any of preconditions is not satisfied

shouldProvideValidSignature

protected void shouldProvideValidSignature(org.kohsuke.stapler.StaplerRequest2 req,
 Object[] args)
                                    throws InvocationTargetException

Checks that an incoming request has a valid signature, if a hook secret is specified in the GitHub plugin config. If no hook secret is configured, then the signature is ignored.

Parameters:

req - Incoming request.

Throws:

InvocationTargetException - if any of preconditions is not satisfied

payloadFrom

protected String payloadFrom(org.kohsuke.stapler.StaplerRequest2 req,
 Object[] args)

Extracts parsed payload from args and prepare it to calculating hash (if json - pass as is, if form - url-encode it with prefix)

Returns:

ready-to-hash payload