org.jenkinsci.plugins.newrelicnotifier.api

Class NewRelicClientImpl

java.lang.Object

org.jenkinsci.plugins.newrelicnotifier.api.NewRelicClientImpl

All Implemented Interfaces:

NewRelicClient

public class NewRelicClientImpl
extends Object
implements NewRelicClient

REST client implementation for the New Relic API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_HOST
static String	API_SCHEME
static String	APPLICATIONS_ENDPOINT
static String	DEPLOYMENT_ENDPOINT
static String	EUROPEAN_API_HOST
static String	EUROPEAN_GRAPHQL_URL
static String	GRAPHQL_URL
static String	NERD_GRAPH_ENDPOINT
static String	PAGE_PARAMETER
static int	PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
NewRelicClientImpl()

Method Summary

Modifier and Type	Method and Description
String	getApiEndpoint() Get API Endpoint URL for looking up credentials.
String	getApiEndpoint(boolean european)
List<Application>	getApplications(String apiKey) Get the list of applications available to record deployment notifications for.
protected org.apache.http.impl.client.CloseableHttpClient	getHttpClient(String host)
String	makePayload(String changelog, String commit, String deepLink, String deploymentType, String description, String entityGuid, String groupId, String timestamp, String user, String version)
String	parseResponseBody(String str)
void	sendNotification(String apiKey, String applicationId, String description, String revision, String changelog, String user, boolean european) Submit deployment notification
void	sendNotificationV2(String apiKey, String changelog, String commit, String deepLink, String deploymentType, String description, String entityGuid, String groupId, String timestamp, String user, String version, boolean european, TaskListener listener) Submit deployment notification

Methods inherited from class java.lang.Object

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

Field Detail

API_SCHEME

public static final String API_SCHEME

See Also:

Constant Field Values

API_HOST

public static final String API_HOST

See Also:

Constant Field Values

EUROPEAN_API_HOST

public static final String EUROPEAN_API_HOST

See Also:

Constant Field Values

NERD_GRAPH_ENDPOINT

public static final String NERD_GRAPH_ENDPOINT

See Also:

Constant Field Values

DEPLOYMENT_ENDPOINT

public static final String DEPLOYMENT_ENDPOINT

See Also:

Constant Field Values

APPLICATIONS_ENDPOINT

public static final String APPLICATIONS_ENDPOINT

See Also:

Constant Field Values

PAGE_PARAMETER

public static final String PAGE_PARAMETER

See Also:

Constant Field Values

GRAPHQL_URL

public static final String GRAPHQL_URL

See Also:

Constant Field Values

EUROPEAN_GRAPHQL_URL

public static final String EUROPEAN_GRAPHQL_URL

See Also:

Constant Field Values

PAGE_SIZE

public static final int PAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

NewRelicClientImpl

public NewRelicClientImpl()

Method Detail

getApplications

public List<Application> getApplications(String apiKey)
                                  throws IOException

Get the list of applications available to record deployment notifications for.

Specified by:

getApplications in interface NewRelicClient

Parameters:

apiKey - New Relic API key

Returns:

A list of applications available for supplied API key.

Throws:

IOException - when HttpClient is not able to be closed

See Also:

https://docs.newrelic.com/docs/apm/apis/requirements/api-key

sendNotification

public void sendNotification(String apiKey,
                             String applicationId,
                             String description,
                             String revision,
                             String changelog,
                             String user,
                             boolean european)
                      throws IOException

Submit deployment notification

Specified by:

sendNotification in interface NewRelicClient

Parameters:

apiKey - New Relic API key

applicationId - Application to register deployment for

description - Text annotation for the deployment

revision - The revision number from your source control system

changelog - A list of changes for this deployment

user - The name of the user/process that triggered this deployment

Throws:

IOException - when HttpClient is not able to be closed or unexpected status code received

See Also:

https://docs.newrelic.com/docs/apm/apis/requirements/api-key

sendNotificationV2

public void sendNotificationV2(String apiKey,
                               String changelog,
                               String commit,
                               String deepLink,
                               String deploymentType,
                               String description,
                               String entityGuid,
                               String groupId,
                               String timestamp,
                               String user,
                               String version,
                               boolean european,
                               TaskListener listener)
                        throws IOException

Submit deployment notification

Specified by:

sendNotificationV2 in interface NewRelicClient

Parameters:

apiKey - New Relic API key

changelog - A list of changes for this deployment

commit - A commit hash for the deployment

deepLink - A deep link for the deployment

deploymentType - A deployment type for the deployment

description - Text annotation for the deployment

entityGuid - An entity GUID to identify the application for Nerdgraph deployment markers

groupId - A group id for the deployment

timestamp - A timestamp for the deployment

user - The name of the user/process that triggered this deployment

version - A version for the deployment

Throws:

IOException - when HttpClient is not able to be closed or unexpected status code received

See Also:

https://docs.newrelic.com/docs/apm/apis/requirements/api-key

parseResponseBody

public String parseResponseBody(String str)

getApiEndpoint

public String getApiEndpoint()

Get API Endpoint URL for looking up credentials.

Specified by:

getApiEndpoint in interface NewRelicClient

Returns:

The endpoint URL for the New Relic API

getApiEndpoint

public String getApiEndpoint(boolean european)

Specified by:

getApiEndpoint in interface NewRelicClient

makePayload

public String makePayload(String changelog,
                          String commit,
                          String deepLink,
                          String deploymentType,
                          String description,
                          String entityGuid,
                          String groupId,
                          String timestamp,
                          String user,
                          String version)

getHttpClient

protected org.apache.http.impl.client.CloseableHttpClient getHttpClient(String host)