org.jfrog.build.extractor.clientConfiguration.client

Class JFrogService<TResult>

java.lang.Object

org.jfrog.build.extractor.clientConfiguration.client.JFrogService<TResult>

Type Parameters:

TResult - - The expected result class from the JFrog REST endpoint.

Direct Known Subclasses:

CheckRepositoryType, DeleteReleaseBundle, DistributeReleaseBundle, DownloadBase, GetAllBuildNumbers, GetBuildInfo, GetDistributionStatus, GetItemLastModified, GetNpmAuth, GetProject, GetReleaseBundleVersion, GetRepositoriesKeys, GetStagingStrategy, GetUserPluginInfo, IsRepositoryExist, RetrievePatternArtifacts, ScanBuild, SearchArtifactsByAql, SearchArtifactsByPattern, SearchArtifactsByProperties, Upload, Version, Version, VoidJFrogService

public abstract class JFrogService<TResult>
extends java.lang.Object

JFrogService represents a generic way of processing a REST endpoint process that structures how REST sends, handles errors, and parses the response.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jfrog.build.api.util.Log	log
protected JFrogServiceResponseType	responseType
protected TResult	result
protected int	statusCode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JFrogService(org.jfrog.build.api.util.Log log)
protected	JFrogService(org.jfrog.build.api.util.Log log, JFrogServiceResponseType responseType)

Method Summary

Modifier and Type	Method and Description
abstract org.apache.http.client.methods.HttpRequestBase	createRequest()
protected void	ensureRequirements(org.jfrog.build.client.JFrogHttpClient client)
TResult	execute(org.jfrog.build.client.JFrogHttpClient client) Default execution of a service: 1.
org.apache.http.Header[]	getHeaders()
protected com.fasterxml.jackson.databind.ObjectMapper	getMapper() Default ObjectMapper to parse or deserialize JSON content into a Java object.
TResult	getResult()
int	getStatusCode()
protected void	handleEmptyEntity() For services with responseType.OBJECT (expected a return value) may override this function which helps to handle scenarios whereby a response body needs to be read but do entity is found.
protected void	handleUnsuccessfulResponse(org.apache.http.HttpEntity entity) Default error handling (E.G.
void	setHeaders(org.apache.http.Header[] headers)
protected abstract void	setResponse(java.io.InputStream stream) Override this in order to parse the service response body (only for services that expect to have body in the response).
void	setResult(TResult result)
void	setStatusCode(int statusCode)
protected static void	throwException(org.apache.http.HttpEntity entity, int statusCode)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.jfrog.build.api.util.Log log

result

protected TResult result

statusCode

protected int statusCode

responseType

protected JFrogServiceResponseType responseType

Constructor Detail

JFrogService

protected JFrogService(org.jfrog.build.api.util.Log log)

JFrogService

protected JFrogService(org.jfrog.build.api.util.Log log,
                       JFrogServiceResponseType responseType)

Method Detail

throwException

protected static void throwException(org.apache.http.HttpEntity entity,
                                     int statusCode)
                              throws java.io.IOException

Throws:

java.io.IOException

getMapper

protected com.fasterxml.jackson.databind.ObjectMapper getMapper()

Default ObjectMapper to parse or deserialize JSON content into a Java object.

getResult

public TResult getResult()

setResult

public void setResult(TResult result)

getStatusCode

public int getStatusCode()

setStatusCode

public void setStatusCode(int statusCode)

createRequest

public abstract org.apache.http.client.methods.HttpRequestBase createRequest()
                                                                      throws java.io.IOException

Throws:

java.io.IOException

setResponse

protected abstract void setResponse(java.io.InputStream stream)
                             throws java.io.IOException

Override this in order to parse the service response body (only for services that expect to have body in the response).

Parameters:

stream - - Inout stream of the response body.

Throws:

java.io.IOException

handleUnsuccessfulResponse

protected void handleUnsuccessfulResponse(org.apache.http.HttpEntity entity)
                                   throws java.io.IOException

Default error handling (E.G. 404 bad request).

Parameters:

entity - - The returned failure response.

Throws:

java.io.IOException

execute

public TResult execute(org.jfrog.build.client.JFrogHttpClient client)
                throws java.io.IOException

Default execution of a service: 1. Send the http request 2. check HTTP status code. if there are any errors, throw. 3. Return the response result (if any is expected).

Parameters:

client - - http client for sending the request.

Returns:

- The response body object.

Throws:

java.io.IOException

handleEmptyEntity

protected void handleEmptyEntity()
                          throws java.io.IOException

For services with responseType.OBJECT (expected a return value) may override this function which helps to handle scenarios whereby a response body needs to be read but do entity is found.

Throws:

java.io.IOException

ensureRequirements

protected void ensureRequirements(org.jfrog.build.client.JFrogHttpClient client)
                           throws java.io.IOException

Throws:

java.io.IOException

getHeaders

public org.apache.http.Header[] getHeaders()

setHeaders

public void setHeaders(org.apache.http.Header[] headers)