Class JSONWebHook
- java.lang.Object
-
- org.jenkinsci.plugins.registry.notification.webhook.JSONWebHook
-
- All Implemented Interfaces:
ExtensionPoint
,Action
,ModelObject
,RootAction
,UnprotectedRootAction
- Direct Known Subclasses:
ACRWebHook
,DockerHubWebHook
,DockerRegistryWebHook
public abstract class JSONWebHook extends Object implements UnprotectedRootAction
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
JSONWebHook.ValidApiToken
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description JSONWebHook()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract WebHookPayload
createPushNotification(net.sf.json.JSONObject data)
void
doIndex(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)
If someone wanders in to the index page, redirect to Jenkins root.void
doNotify(String payload, org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)
ResultPage
getDetails(String sha)
Stapler entry for the multi build result pageString
getDisplayName()
JSONWebHook.ValidApiToken
getDynamic(String token, org.kohsuke.stapler.StaplerResponse rsp)
String
getIconFileName()
protected void
trigger(org.kohsuke.stapler.StaplerResponse response, PushNotification pushNotification)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface hudson.model.Action
getUrlName
-
-
-
-
Method Detail
-
getIconFileName
public String getIconFileName()
- Specified by:
getIconFileName
in interfaceAction
-
getDisplayName
public String getDisplayName()
- Specified by:
getDisplayName
in interfaceAction
- Specified by:
getDisplayName
in interfaceModelObject
-
doNotify
public void doNotify(@QueryParameter(required=false) String payload, org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) throws IOException
- Throws:
IOException
-
getDynamic
public JSONWebHook.ValidApiToken getDynamic(String token, org.kohsuke.stapler.StaplerResponse rsp) throws IOException
- Throws:
IOException
-
getDetails
@NonNull public ResultPage getDetails(@NonNull String sha) throws IOException, InterruptedException
Stapler entry for the multi build result page- Parameters:
sha
- the id of the trigger data.- Returns:
- the details
- Throws:
IOException
- if soInterruptedException
- if so
-
trigger
protected void trigger(org.kohsuke.stapler.StaplerResponse response, PushNotification pushNotification) throws IOException
- Throws:
IOException
-
doIndex
public void doIndex(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) throws IOException
If someone wanders in to the index page, redirect to Jenkins root.- Parameters:
request
- the request objectresponse
- the response object- Throws:
IOException
- if so
-
createPushNotification
protected abstract WebHookPayload createPushNotification(net.sf.json.JSONObject data)
-
-