Package com.atlassian.jira.cloud.jenkins.ping

Class PingApi

java.lang.Object

com.atlassian.jira.cloud.jenkins.common.client.JenkinsAppApi<PingResponse>

com.atlassian.jira.cloud.jenkins.ping.PingApi

public class PingApi
extends JenkinsAppApi<PingResponse>

Constructor Summary

Constructors

Constructor	Description
PingApi(okhttp3.OkHttpClient httpClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
boolean	sendPing(String webhookUrl, String secret, PipelineLogger pipelineLogger)	Sends a "ping" to the Jenkins app.

Methods inherited from class com.atlassian.jira.cloud.jenkins.common.client.JenkinsAppApi

sendRequest, sendRequestAsJwt, wrapInJwt

Methods inherited from class java.lang.Object

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

Constructor Details

PingApi

@Inject
public PingApi(okhttp3.OkHttpClient httpClient,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Details

sendPing

public boolean sendPing(String webhookUrl,
 String secret,
 PipelineLogger pipelineLogger)

Sends a "ping" to the Jenkins app. The Jenkins app will return true only if it could successfully validate the JWT that contains the payload (i.e. only if the shared secret is the same on both sides). This effectively tests if the connection between Jenkins plugin and app is valid.