io.jenkins.plugins.insightappsec.api

Class AbstractApi

java.lang.Object

io.jenkins.plugins.insightappsec.api.AbstractApi

Direct Known Subclasses:

AppApi, ScanApi, SearchApi

public abstract class AbstractApi
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractApi(org.apache.http.client.HttpClient client, String host, String apiKey)

Method Summary

Modifier and Type	Method and Description
protected <T> T	getById(String path, String id, Class<T> clazz) GET a single resource by it's ID.
protected <T> List<T>	getForAll(String path, Class<T> clazz) Collect all pages of a particular resources using a GET.
protected String	post(String path, Object body) POST a resource.
protected <T> List<T>	postForAll(String path, Class<T> clazz, Object body) Collect all pages of a particular resources using a POST with body.
protected void	put(String path, Object body) PUT a resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractApi

protected AbstractApi(org.apache.http.client.HttpClient client,
                      String host,
                      String apiKey)

Method Detail

post

protected String post(String path,
                      Object body)

POST a resource.

Parameters:

path - The path to post to.

body - The body to send in the post.

Returns:

The last segment from the 'location' header in response. Indicative of the created ID.

put

protected void put(String path,
                   Object body)

PUT a resource.

Parameters:

path - The path to put to.

body - The body to send in the put.

getById

protected <T> T getById(String path,
                        String id,
                        Class<T> clazz)

GET a single resource by it's ID.

Parameters:

path - The path to the resource, including it's ID.

id - The ID of the resource.

clazz - The class to map response content to.

Returns:

the mapped resource.

getForAll

protected <T> List<T> getForAll(String path,
                                Class<T> clazz)

Collect all pages of a particular resources using a GET.

Parameters:

path - The path to the resources.

clazz - The class to map the pages data to.

Returns:

The list of all resources.

postForAll

protected <T> List<T> postForAll(String path,
                                 Class<T> clazz,
                                 Object body)

Collect all pages of a particular resources using a POST with body.

Parameters:

path - The path to the resources.

clazz - The class to map the pages data to.

body - The body to send in each request

Returns:

The list of all resources.